1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
|
<refentry id="GnomeDateEdit">
<refmeta>
<refentrytitle role="top_of_page">GnomeDateEdit</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGNOMEUI Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GnomeDateEdit</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#include <libgnomeui/libgnomeui.h>
enum <link linkend="GnomeDateEditFlags">GnomeDateEditFlags</link>;
<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,
<link linkend="gboolean">gboolean</link> show_time,
<link linkend="gboolean">gboolean</link> use_24_format);
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gnome-date-edit-new-flags">gnome_date_edit_new_flags</link> (<link linkend="time-t">time_t</link> the_time,
<link linkend="GnomeDateEditFlags">GnomeDateEditFlags</link> flags);
<link linkend="void">void</link> <link linkend="gnome-date-edit-construct">gnome_date_edit_construct</link> (<link linkend="GnomeDateEdit">GnomeDateEdit</link> *gde,
<link linkend="time-t">time_t</link> the_time,
<link linkend="GnomeDateEditFlags">GnomeDateEditFlags</link> flags);
<link linkend="void">void</link> <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);
<link linkend="time-t">time_t</link> <link linkend="gnome-date-edit-get-time">gnome_date_edit_get_time</link> (<link linkend="GnomeDateEdit">GnomeDateEdit</link> *gde);
<link linkend="void">void</link> <link linkend="gnome-date-edit-set-popup-range">gnome_date_edit_set_popup_range</link> (<link linkend="GnomeDateEdit">GnomeDateEdit</link> *gde,
<link linkend="int">int</link> low_hour,
<link linkend="int">int</link> up_hour);
<link linkend="void">void</link> <link linkend="gnome-date-edit-set-flags">gnome_date_edit_set_flags</link> (<link linkend="GnomeDateEdit">GnomeDateEdit</link> *gde,
<link linkend="GnomeDateEditFlags">GnomeDateEditFlags</link> flags);
<link linkend="int">int</link> <link linkend="gnome-date-edit-get-flags">gnome_date_edit_get_flags</link> (<link linkend="GnomeDateEdit">GnomeDateEdit</link> *gde);
<link linkend="time-t">time_t</link> <link linkend="gnome-date-edit-get-initial-time">gnome_date_edit_get_initial_time</link> (<link linkend="GnomeDateEdit">GnomeDateEdit</link> *gde);
<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 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
+----<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 role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GnomeDateEdit implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link> and <link linkend="GtkBuildable">GtkBuildable</link>.</para>
</refsect1>
<refsect1 role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="GnomeDateEdit--dateedit-flags">dateedit-flags</link>" <link linkend="GnomeDateEditFlags">GnomeDateEditFlags</link> : Read / Write
"<link linkend="GnomeDateEdit--initial-time">initial-time</link>" <link linkend="gulong">gulong</link> : Read / Write
"<link linkend="GnomeDateEdit--lower-hour">lower-hour</link>" <link linkend="gint">gint</link> : Read / Write
"<link linkend="GnomeDateEdit--time">time</link>" <link linkend="gulong">gulong</link> : Read / Write
"<link linkend="GnomeDateEdit--upper-hour">upper-hour</link>" <link linkend="gint">gint</link> : Read / Write
</synopsis>
</refsect1>
<refsect1 role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="GnomeDateEdit-date-changed">date-changed</link>" : Run First
"<link linkend="GnomeDateEdit-time-changed">time-changed</link>" : Run First
</synopsis>
</refsect1>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="GnomeDateEditFlags" role="enum"/>enum GnomeDateEditFlags</title>
<indexterm><primary>GnomeDateEditFlags</primary></indexterm><programlisting>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
} GnomeDateEditFlags;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GnomeDateEdit-struct" role="struct"/>GnomeDateEdit</title>
<indexterm><primary>GnomeDateEdit</primary></indexterm><programlisting>typedef struct _GnomeDateEdit GnomeDateEdit;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gnome-date-edit-new" role="function"/>gnome_date_edit_new ()</title>
<indexterm><primary>gnome_date_edit_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gnome_date_edit_new (<link linkend="time-t">time_t</link> the_time,
<link linkend="gboolean">gboolean</link> show_time,
<link linkend="gboolean">gboolean</link> use_24_format);</programlisting>
<para>
Creates a new <link linkend="GnomeDateEdit"><type>GnomeDateEdit</type></link> widget which can be used
to provide an easy to use way for entering dates and times.
If <parameter>the_time</parameter> is 0 then current time is used.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>the_time</parameter> :</term>
<listitem><simpara> date and time to be displayed on the widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>show_time</parameter> :</term>
<listitem><simpara> whether time should be displayed
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>use_24_format</parameter> :</term>
<listitem><simpara> whether 24-hour format is desired for the time display.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GnomeDateEdit"><type>GnomeDateEdit</type></link> widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-date-edit-new-flags" role="function"/>gnome_date_edit_new_flags ()</title>
<indexterm><primary>gnome_date_edit_new_flags</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gnome_date_edit_new_flags (<link linkend="time-t">time_t</link> the_time,
<link linkend="GnomeDateEditFlags">GnomeDateEditFlags</link> flags);</programlisting>
<para>
Creates a new <link linkend="GnomeDateEdit"><type>GnomeDateEdit</type></link> widget with the
specified flags. If <parameter>the_time</parameter> is 0 then current time is used.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>the_time</parameter> :</term>
<listitem><simpara> The initial time for the date editor.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter> :</term>
<listitem><simpara> A bitmask of GnomeDateEditFlags values.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly-created date editor widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-date-edit-construct" role="function"/>gnome_date_edit_construct ()</title>
<indexterm><primary>gnome_date_edit_construct</primary></indexterm><programlisting><link linkend="void">void</link> gnome_date_edit_construct (<link linkend="GnomeDateEdit">GnomeDateEdit</link> *gde,
<link linkend="time-t">time_t</link> the_time,
<link linkend="GnomeDateEditFlags">GnomeDateEditFlags</link> flags);</programlisting>
<para>
For language bindings and subclassing only</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gde</parameter> :</term>
<listitem><simpara> The <link linkend="GnomeDateEdit"><type>GnomeDateEdit</type></link> object to construct
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>the_time</parameter> :</term>
<listitem><simpara> The initial time for the date editor.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter> :</term>
<listitem><simpara> A bitmask of GnomeDateEditFlags values.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-date-edit-set-time" role="function"/>gnome_date_edit_set_time ()</title>
<indexterm><primary>gnome_date_edit_set_time</primary></indexterm><programlisting><link linkend="void">void</link> 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>. If <parameter>the_time</parameter> is 0
then current time is used.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gde</parameter> :</term>
<listitem><simpara> the GnomeDateEdit widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>the_time</parameter> :</term>
<listitem><simpara> The time and date that should be set on the widget
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-date-edit-get-time" role="function"/>gnome_date_edit_get_time ()</title>
<indexterm><primary>gnome_date_edit_get_time</primary></indexterm><programlisting><link linkend="time-t">time_t</link> gnome_date_edit_get_time (<link linkend="GnomeDateEdit">GnomeDateEdit</link> *gde);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gde</parameter> :</term>
<listitem><simpara> The GnomeDateEdit widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the time entered in the GnomeDateEdit widget
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-date-edit-set-popup-range" role="function"/>gnome_date_edit_set_popup_range ()</title>
<indexterm><primary>gnome_date_edit_set_popup_range</primary></indexterm><programlisting><link linkend="void">void</link> gnome_date_edit_set_popup_range (<link linkend="GnomeDateEdit">GnomeDateEdit</link> *gde,
<link linkend="int">int</link> low_hour,
<link linkend="int">int</link> up_hour);</programlisting>
<para>
Sets the range of times that will be provide by the time popup
selectors.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gde</parameter> :</term>
<listitem><simpara> The GnomeDateEdit widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>low_hour</parameter> :</term>
<listitem><simpara> low boundary for the time-range display popup.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>up_hour</parameter> :</term>
<listitem><simpara> upper boundary for the time-range display popup.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-date-edit-set-flags" role="function"/>gnome_date_edit_set_flags ()</title>
<indexterm><primary>gnome_date_edit_set_flags</primary></indexterm><programlisting><link linkend="void">void</link> gnome_date_edit_set_flags (<link linkend="GnomeDateEdit">GnomeDateEdit</link> *gde,
<link linkend="GnomeDateEditFlags">GnomeDateEditFlags</link> flags);</programlisting>
<para>
Changes the display flags on an existing date editor widget.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gde</parameter> :</term>
<listitem><simpara> The date editor widget whose flags should be changed.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter> :</term>
<listitem><simpara> The new bitmask of GnomeDateEditFlags values.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-date-edit-get-flags" role="function"/>gnome_date_edit_get_flags ()</title>
<indexterm><primary>gnome_date_edit_get_flags</primary></indexterm><programlisting><link linkend="int">int</link> gnome_date_edit_get_flags (<link linkend="GnomeDateEdit">GnomeDateEdit</link> *gde);</programlisting>
<para>
Queries the display flags on a date editor widget.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gde</parameter> :</term>
<listitem><simpara> The date editor whose flags should be queried.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The current display flags for the specified date editor widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-date-edit-get-initial-time" role="function"/>gnome_date_edit_get_initial_time ()</title>
<indexterm><primary>gnome_date_edit_get_initial_time</primary></indexterm><programlisting><link linkend="time-t">time_t</link> gnome_date_edit_get_initial_time (<link linkend="GnomeDateEdit">GnomeDateEdit</link> *gde);</programlisting>
<para>
Queries the initial time that was set using the
<link linkend="gnome-date-edit-set-time"><type>gnome_date_edit_set_time</type></link> or during creation</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gde</parameter> :</term>
<listitem><simpara> The date editor whose initial time should be queried
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The initial time in seconds (standard time_t format)
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-date-edit-get-date" role="function" condition="deprecated:"/>gnome_date_edit_get_date ()</title>
<indexterm role="deprecated"><primary>gnome_date_edit_get_date</primary></indexterm><programlisting><link linkend="time-t">time_t</link> gnome_date_edit_get_date (<link linkend="GnomeDateEdit">GnomeDateEdit</link> *gde);</programlisting>
<warning><para><literal>gnome_date_edit_get_date</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Deprecated, use <link linkend="gnome-date-edit-get-time"><type>gnome_date_edit_get_time</type></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gde</parameter> :</term>
<listitem><simpara> The GnomeDateEdit widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="GnomeDateEdit--dateedit-flags"/>The <literal>"dateedit-flags"</literal> property</title>
<indexterm><primary>GnomeDateEdit:dateedit-flags</primary></indexterm><programlisting> "dateedit-flags" <link linkend="GnomeDateEditFlags">GnomeDateEditFlags</link> : Read / Write</programlisting>
<para>Flags for how DateEdit looks.</para><para>Default value: GNOME_DATE_EDIT_SHOW_TIME</para>
</refsect2>
<refsect2><title><anchor id="GnomeDateEdit--initial-time"/>The <literal>"initial-time"</literal> property</title>
<indexterm><primary>GnomeDateEdit:initial-time</primary></indexterm><programlisting> "initial-time" <link linkend="gulong">gulong</link> : Read / Write</programlisting>
<para>The initial time.</para></refsect2>
<refsect2><title><anchor id="GnomeDateEdit--lower-hour"/>The <literal>"lower-hour"</literal> property</title>
<indexterm><primary>GnomeDateEdit:lower-hour</primary></indexterm><programlisting> "lower-hour" <link linkend="gint">gint</link> : Read / Write</programlisting>
<para>Lower hour in the time popup selector.</para><para>Allowed values: [0,24]</para>
<para>Default value: 7</para>
</refsect2>
<refsect2><title><anchor id="GnomeDateEdit--time"/>The <literal>"time"</literal> property</title>
<indexterm><primary>GnomeDateEdit:time</primary></indexterm><programlisting> "time" <link linkend="gulong">gulong</link> : Read / Write</programlisting>
<para>The time currently selected.</para></refsect2>
<refsect2><title><anchor id="GnomeDateEdit--upper-hour"/>The <literal>"upper-hour"</literal> property</title>
<indexterm><primary>GnomeDateEdit:upper-hour</primary></indexterm><programlisting> "upper-hour" <link linkend="gint">gint</link> : Read / Write</programlisting>
<para>Upper hour in the time popup selector.</para><para>Allowed values: [0,24]</para>
<para>Default value: 19</para>
</refsect2>
</refsect1>
<refsect1 role="signals">
<title role="signals.title">Signal Details</title>
<refsect2><title><anchor id="GnomeDateEdit-date-changed"/>The <literal>"date-changed"</literal> signal</title>
<indexterm><primary>GnomeDateEdit::date-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GnomeDateEdit">GnomeDateEdit</link> *dateedit,
<link linkend="gpointer">gpointer</link> user_data) : Run First</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>dateedit</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="GnomeDateEdit-time-changed"/>The <literal>"time-changed"</literal> signal</title>
<indexterm><primary>GnomeDateEdit::time-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GnomeDateEdit">GnomeDateEdit</link> *dateedit,
<link linkend="gpointer">gpointer</link> user_data) : Run First</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>dateedit</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
