## GnomeDateEdit

GnomeDateEdit

## Synopsis

    #include <libgnomeui/libgnomeui.h>

    enum                GnomeDateEditFlags;
                        GnomeDateEdit;
    GtkWidget *         gnome_date_edit_new                 (time_t the_time,
                                                             gboolean show_time,
                                                             gboolean use_24_format);
    GtkWidget *         gnome_date_edit_new_flags           (time_t the_time,
                                                             GnomeDateEditFlags flags);
    void                gnome_date_edit_construct           (GnomeDateEdit *gde,
                                                             time_t the_time,
                                                             GnomeDateEditFlags flags);
    void                gnome_date_edit_set_time            (GnomeDateEdit *gde,
                                                             time_t the_time);
    time_t              gnome_date_edit_get_time            (GnomeDateEdit *gde);
    void                gnome_date_edit_set_popup_range     (GnomeDateEdit *gde,
                                                             int low_hour,
                                                             int up_hour);
    void                gnome_date_edit_set_flags           (GnomeDateEdit *gde,
                                                             GnomeDateEditFlags flags);
    int                 gnome_date_edit_get_flags           (GnomeDateEdit *gde);
    time_t              gnome_date_edit_get_initial_time    (GnomeDateEdit *gde);
    time_t              gnome_date_edit_get_date            (GnomeDateEdit *gde);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----GtkObject
                   +----GtkWidget
                         +----GtkContainer
                               +----GtkBox
                                     +----GtkHBox
                                           +----GnomeDateEdit

## Implemented Interfaces

GnomeDateEdit implements GtkBuildable, AtkImplementorIface and GtkOrientable.

## Properties

      "dateedit-flags"           GnomeDateEditFlags    : Read / Write
      "initial-time"             gulong                : Read / Write
      "lower-hour"               gint                  : Read / Write
      "time"                     gulong                : Read / Write
      "upper-hour"               gint                  : Read / Write

## Signals

      "date-changed"                                   : Run First
      "time-changed"                                   : Run First

## Description

## Details

### enum GnomeDateEditFlags

    typedef enum {
    	GNOME_DATE_EDIT_SHOW_TIME             = 1 << 0,
    	GNOME_DATE_EDIT_24_HR                 = 1 << 1,
    	GNOME_DATE_EDIT_WEEK_STARTS_ON_MONDAY = 1 << 2,
    	GNOME_DATE_EDIT_DISPLAY_SECONDS       = 1 << 3
    } GnomeDateEditFlags;

### GnomeDateEdit

    typedef struct _GnomeDateEdit GnomeDateEdit;

### gnome_date_edit_new ()

    GtkWidget *         gnome_date_edit_new                 (time_t the_time,
                                                             gboolean show_time,
                                                             gboolean use_24_format);

Creates a new GnomeDateEdit widget which can be used to provide an easy to use way for entering dates and times. If `the_time` is 0 then current time is used.

`the_time` : | date and time to be displayed on the widget
`show_time` : | whether time should be displayed
`use_24_format` : | whether 24-hour format is desired for the time display.
Returns : | a new GnomeDateEdit widget.

### gnome_date_edit_new_flags ()

    GtkWidget *         gnome_date_edit_new_flags           (time_t the_time,
                                                             GnomeDateEditFlags flags);

Creates a new GnomeDateEdit widget with the specified flags. If `the_time` is 0 then current time is used.

`the_time` : | The initial time for the date editor.
`flags` : | A bitmask of GnomeDateEditFlags values.
Returns : | the newly-created date editor widget.

### gnome_date_edit_construct ()

    void                gnome_date_edit_construct           (GnomeDateEdit *gde,
                                                             time_t the_time,
                                                             GnomeDateEditFlags flags);

For language bindings and subclassing only

`gde` : | The GnomeDateEdit object to construct
`the_time` : | The initial time for the date editor.
`flags` : | A bitmask of GnomeDateEditFlags values.

### gnome_date_edit_set_time ()

    void                gnome_date_edit_set_time            (GnomeDateEdit *gde,
                                                             time_t the_time);

Changes the displayed date and time in the GnomeDateEdit widget to be the one represented by `the_time`. If `the_time` is 0 then current time is used.

`gde` : | the GnomeDateEdit widget
`the_time` : | The time and date that should be set on the widget

### gnome_date_edit_get_time ()

    time_t              gnome_date_edit_get_time            (GnomeDateEdit *gde);

`gde` : | The GnomeDateEdit widget
Returns : | the time entered in the GnomeDateEdit widget

### gnome_date_edit_set_popup_range ()

    void                gnome_date_edit_set_popup_range     (GnomeDateEdit *gde,
                                                             int low_hour,
                                                             int up_hour);

Sets the range of times that will be provide by the time popup selectors.

`gde` : | The GnomeDateEdit widget
`low_hour` : | low boundary for the time-range display popup.
`up_hour` : | upper boundary for the time-range display popup.

### gnome_date_edit_set_flags ()

    void                gnome_date_edit_set_flags           (GnomeDateEdit *gde,
                                                             GnomeDateEditFlags flags);

Changes the display flags on an existing date editor widget.

`gde` : | The date editor widget whose flags should be changed.
`flags` : | The new bitmask of GnomeDateEditFlags values.

### gnome_date_edit_get_flags ()

    int                 gnome_date_edit_get_flags           (GnomeDateEdit *gde);

Queries the display flags on a date editor widget.

`gde` : | The date editor whose flags should be queried.
Returns : | The current display flags for the specified date editor widget.

### gnome_date_edit_get_initial_time ()

    time_t              gnome_date_edit_get_initial_time    (GnomeDateEdit *gde);

Queries the initial time that was set using the gnome_date_edit_set_time or during creation

`gde` : | The date editor whose initial time should be queried
Returns : | The initial time in seconds (standard time_t format)

### gnome_date_edit_get_date ()

    time_t              gnome_date_edit_get_date            (GnomeDateEdit *gde);

### Warning

`gnome_date_edit_get_date` is deprecated and should not be used in newly-written code.

Deprecated, use gnome_date_edit_get_time

`gde` : | The GnomeDateEdit widget
Returns : |

## Property Details

### The `"dateedit-flags"` property

      "dateedit-flags"           GnomeDateEditFlags    : Read / Write

Flags for how DateEdit looks.

Default value: GNOME_DATE_EDIT_SHOW_TIME

### The `"initial-time"` property

      "initial-time"             gulong                : Read / Write

The initial time.

### The `"lower-hour"` property

      "lower-hour"               gint                  : Read / Write

Lower hour in the time popup selector.

Allowed values: [0,24]

Default value: 7

### The `"time"` property

      "time"                     gulong                : Read / Write

The time currently selected.

### The `"upper-hour"` property

      "upper-hour"               gint                  : Read / Write

Upper hour in the time popup selector.

Allowed values: [0,24]

Default value: 19

## Signal Details

### The `"date-changed"` signal

    void                user_function                      (GnomeDateEdit *dateedit,
                                                            gpointer       user_data)      : Run First

`dateedit` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.

### The `"time-changed"` signal

    void                user_function                      (GnomeDateEdit *dateedit,
                                                            gpointer       user_data)      : Run First

`dateedit` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.