GnomeDateEdit

GnomeDateEdit

Functions

Properties

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

Signals

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkObject
            ╰── GtkWidget
                ╰── GtkContainer
                    ╰── GtkBox
                        ╰── GtkHBox
                            ╰── GnomeDateEdit

Implemented Interfaces

GnomeDateEdit implements AtkImplementorIface, GtkBuildable and GtkOrientable.

Includes

#include <libgnomeui/libgnomeui.h>

Description

Functions

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.

Parameters

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.

Parameters

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

Parameters

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.

Parameters

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);

Returns the time entered in the GnomeDateEdit widget

Parameters

gde

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.

Parameters

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.

Parameters

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.

Parameters

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

Parameters

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);

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

Deprecated, use gnome_date_edit_get_time

Parameters

gde

The GnomeDateEdit widget

 

Types and Values

enum GnomeDateEditFlags

Members

GNOME_DATE_EDIT_SHOW_TIME

   

GNOME_DATE_EDIT_24_HR

   

GNOME_DATE_EDIT_WEEK_STARTS_ON_MONDAY

   

GNOME_DATE_EDIT_DISPLAY_SECONDS

   

struct GnomeDateEdit

struct GnomeDateEdit;

Property Details

The “dateedit-flags” property

  “dateedit-flags”           GnomeDateEditFlags

Flags for how DateEdit looks.

Flags: Read / Write

Default value: GNOME_DATE_EDIT_SHOW_TIME


The “initial-time” property

  “initial-time”             gulong

The initial time.

Flags: Read / Write


The “lower-hour” property

  “lower-hour”               gint

Lower hour in the time popup selector.

Flags: Read / Write

Allowed values: [0,24]

Default value: 7


The “time” property

  “time”                     gulong

The time currently selected.

Flags: Read / Write


The “upper-hour” property

  “upper-hour”               gint

Upper hour in the time popup selector.

Flags: Read / Write

Allowed values: [0,24]

Default value: 19

Signal Details

The “date-changed” signal

void
user_function (GnomeDateEdit *dateedit,
               gpointer       user_data)

Flags: Run First


The “time-changed” signal

void
user_function (GnomeDateEdit *dateedit,
               gpointer       user_data)

Flags: Run First