<refentry id="GnomeDateEdit" revision="6 May 2000">
<refmeta>
<refentrytitle>GnomeDateEdit</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GNOMEUI Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GnomeDateEdit</refname><refpurpose>Date and time entry widget.</refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>
<synopsis>

#include &lt;gnome.h&gt;


struct      <link linkend="GnomeDateEdit-struct">GnomeDateEdit</link>;
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gnome-date-edit-new">gnome_date_edit_new</link>             (<link linkend="time-t">time_t</link> the_time,
                                             int show_time,
                                             int use_24_format);
void        <link linkend="gnome-date-edit-set-time">gnome_date_edit_set_time</link>        (<link linkend="GnomeDateEdit">GnomeDateEdit</link> *gde,
                                             <link linkend="time-t">time_t</link> the_time);
void        <link linkend="gnome-date-edit-set-popup-range">gnome_date_edit_set_popup_range</link> (<link linkend="GnomeDateEdit">GnomeDateEdit</link> *gde,
                                             int low_hour,
                                             int up_hour);
<link linkend="time-t">time_t</link>      <link linkend="gnome-date-edit-get-date">gnome_date_edit_get_date</link>        (<link linkend="GnomeDateEdit">GnomeDateEdit</link> *gde);

</synopsis>
</refsynopsisdiv>

<refsect1>
<title>Object Hierarchy</title>
<synopsis>

  <link linkend="GtkObject">GtkObject</link>
   +----<link linkend="GtkWidget">GtkWidget</link>
         +----<link linkend="GtkContainer">GtkContainer</link>
               +----<link linkend="GtkBox">GtkBox</link>
                     +----<link linkend="GtkHBox">GtkHBox</link>
                           +----GnomeDateEdit
</synopsis>

</refsect1>




<refsect1>
<title>Description</title>
<para>
The <type>GnomeDateEdit</type> widget provides a way to enter dates and
times with a helper calendar to let the user select the date.
</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GnomeDateEdit-struct">struct GnomeDateEdit</title>
<programlisting>struct GnomeDateEdit;</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="gnome-date-edit-new">gnome_date_edit_new ()</title>
<programlisting><link linkend="GtkWidget">GtkWidget</link>*  gnome_date_edit_new             (<link linkend="time-t">time_t</link> the_time,
                                             int show_time,
                                             int use_24_format);</programlisting>
<para>
Creates a new GnomeDateEdit widget which can be used to provide
an easy to use way for entering dates and times.</para>
<para>

</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>the_time</parameter>&nbsp;:</entry>
<entry> date and time to be displayed on the widget
</entry></row>
<row><entry align="right"><parameter>show_time</parameter>&nbsp;:</entry>
<entry> whether time should be displayed
</entry></row>
<row><entry align="right"><parameter>use_24_format</parameter>&nbsp;:</entry>
<entry> whether 24-hour format is desired for the time display.
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>a GnomeDateEdit widget.
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gnome-date-edit-set-time">gnome_date_edit_set_time ()</title>
<programlisting>void        gnome_date_edit_set_time        (<link linkend="GnomeDateEdit">GnomeDateEdit</link> *gde,
                                             <link linkend="time-t">time_t</link> the_time);</programlisting>
<para>
Changes the displayed date and time in the GnomeDateEdit widget
to be the one represented by <parameter>the_time</parameter>.</para>
<para>

</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>gde</parameter>&nbsp;:</entry>
<entry> the GnomeDateEdit widget
</entry></row>
<row><entry align="right"><parameter>the_time</parameter>&nbsp;:</entry>
<entry> The time and date that should be set on the widget
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gnome-date-edit-set-popup-range">gnome_date_edit_set_popup_range ()</title>
<programlisting>void        gnome_date_edit_set_popup_range (<link linkend="GnomeDateEdit">GnomeDateEdit</link> *gde,
                                             int low_hour,
                                             int up_hour);</programlisting>
<para>
Sets the range of times that will be provide by the time popup
selectors.</para>
<para>

</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>gde</parameter>&nbsp;:</entry>
<entry> The GnomeDateEdit widget
</entry></row>
<row><entry align="right"><parameter>low_hour</parameter>&nbsp;:</entry>
<entry> low boundary for the time-range display popup.
</entry></row>
<row><entry align="right"><parameter>up_hour</parameter>&nbsp;:</entry>
<entry>  upper boundary for the time-range display popup.
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gnome-date-edit-get-date">gnome_date_edit_get_date ()</title>
<programlisting><link linkend="time-t">time_t</link>      gnome_date_edit_get_date        (<link linkend="GnomeDateEdit">GnomeDateEdit</link> *gde);</programlisting>
<para>
</para>
<para>

</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>gde</parameter>&nbsp;:</entry>
<entry> The GnomeDateEdit widget
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>the time entered in the GnomeDateEdit widget
</entry></row>
</tbody></tgroup></informaltable></refsect2>

</refsect1>




</refentry>
