Missing/Buggy documentation from, N#11566 make password dialog customizable (messages...
[hildon] / doc / tmpl / hildon-time-picker.sgml
1 <!-- ##### SECTION Title ##### -->
2 HildonTimePicker
3
4 <!-- ##### SECTION Short_Description ##### -->
5 #HildonTimePicker is a dialog popup widget which lets the user set a time.
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9 #HildonTimePicker is a dialog popup widget which lets the user set a time.
10 using up/down arrows on hours and minutes. There are two arrows for minutes,
11 so that minutes can be added also in 10min steps.
12
13 The following code shows how the widget is used.
14
15 <informalexample>
16 <programlisting>
17 ...
18 parent = gtk_widget_get_ancestor (GTK_WIDGET (editor), GTK_TYPE_WINDOW);
19 picker = hildon_time_picker_new (GTK_WINDOW (parent));
20
21 hildon_time_editor_get_time (editor, &amp;h, &amp;m, &amp;s);
22 hildon_time_picker_set_time( HILDON_TIME_PICKER( picker ), h, m );
23
24 result = gtk_dialog_run( GTK_DIALOG ( picker ) );
25 switch (result)
26 {
27 case GTK_RESPONSE_OK:
28 case GTK_RESPONSE_ACCEPT:
29     hildon_time_picker_get_time(HILDON_TIME_PICKER( picker ), &amp;h, &amp;m );
30     foo_set_time(h,m);
31 break;
32 default:
33 break;
34 }
35
36 gtk_widget_destroy( picker );
37 ...
38 </programlisting>
39 </informalexample>
40
41 </para>
42
43 <!-- ##### SECTION See_Also ##### -->
44 <para>
45 #HildonTimeEditor
46 </para>
47
48 <!-- ##### STRUCT HildonTimePickerPrivate ##### -->
49 <para>
50
51 </para>
52
53
54 <!-- ##### FUNCTION hildon_time_picker_new ##### -->
55 <para>
56
57 </para>
58
59 @parent: 
60 @Returns: 
61
62
63 <!-- ##### FUNCTION hildon_time_picker_set_time ##### -->
64 <para>
65
66 </para>
67
68 @picker: 
69 @hours: 
70 @minutes: 
71
72
73 <!-- ##### FUNCTION hildon_time_picker_get_time ##### -->
74 <para>
75
76 </para>
77
78 @picker: 
79 @hours: 
80 @minutes: 
81
82
83 <!-- ##### ARG HildonTimePicker:minutes ##### -->
84 <para>
85
86 </para>
87
88 <!-- ##### ARG HildonTimePicker:arrow-height ##### -->
89 <para>
90
91 </para>
92
93 <!-- ##### ARG HildonTimePicker:arrow-width ##### -->
94 <para>
95
96 </para>
97