update
[hildon] / doc / tmpl / hildon-sort-dialog.sgml
1 <!-- ##### SECTION Title ##### -->
2 HildonSortDialog
3
4 <!-- ##### SECTION Short_Description ##### -->
5
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9
10 </para>
11
12 <para>
13 <informalexample>
14 Here is an example for using HildonSortDialog.
15 <programlisting>
16         HildonSortDialog *sort_dialog = HILDON_SORT_DIALOG(
17                         hildon_sort_dialog_new( parent ));
18
19         gint response_id, add_sort_index;
20
21         sort_by[0] = STR_SORT_BY_DATE;
22         sort_by[1] = STR_SORT_BY_NAME;
23         sort_by[2] = STR_SORT_BY_SIZE;
24         sort_by[3] = NULL;
25
26         sorting_order[0] = STR_SORTING_ORDER_ASCENDING;
27         sorting_order[1] = STR_SORTING_ORDER_DESCENDING;
28         sorting_order[2] = NULL;
29
30         add_sort_index = hildon_sort_dialog_add_sort_key (sort_dialog,
31                         STR_SORT_BY_DATE);
32
33         hildon_sort_dialog_add_sort_key (sort_dialog, STR_SORT_BY_NAME);
34
35         hildon_sort_dialog_add_sort_key (sort_dialog, STR_SORT_BY_SIZE);
36
37         if (dialog.first_time_clicked == TRUE)
38         {
39                 hildon_sort_dialog_set_sort_key (sort_dialog, add_sort_index);
40         }
41
42         if (dialog.first_time_clicked == FALSE)
43         {
44                 hildon_sort_dialog_set_sort_key (sort_dialog, dialog.sort_key);
45                 hildon_sort_dialog_set_sort_order (sort_dialog, dialog.sort_order);
46         }
47
48         gtk_widget_show (GTK_WIDGET (sort_dialog));
49
50         response_id = gtk_dialog_run (GTK_DIALOG (sort_dialog));
51
52         if (response_id == GTK_RESPONSE_OK)
53         {
54                 dialog.sort_key = hildon_sort_dialog_get_sort_key (sort_dialog);
55
56                 gtk_label_set_text (GTK_LABEL ( dialog.label1),
57                                 sort_by [dialog.sort_key]);
58
59
60                 dialog.sort_order = hildon_sort_dialog_get_sort_order (sort_dialog);
61
62                 gtk_label_set_text (GTK_LABEL (dialog.label2),
63                                 sorting_order [dialog.sort_order]);
64
65                 dialog.first_time_clicked = FALSE;
66         }
67 </programlisting>
68 </informalexample>
69 </para>
70
71 <!-- ##### SECTION See_Also ##### -->
72 <para>
73
74 </para>
75
76 <!-- ##### SECTION Stability_Level ##### -->
77
78
79 <!-- ##### FUNCTION hildon_sort_dialog_new ##### -->
80 <para>
81
82 </para>
83
84 @parent: 
85 @Returns: 
86
87
88 <!-- ##### FUNCTION hildon_sort_dialog_get_sort_key ##### -->
89 <para>
90
91 </para>
92
93 @dialog: 
94 @Returns: 
95
96
97 <!-- ##### FUNCTION hildon_sort_dialog_get_sort_order ##### -->
98 <para>
99
100 </para>
101
102 @dialog: 
103 @Returns: 
104
105
106 <!-- ##### FUNCTION hildon_sort_dialog_set_sort_key ##### -->
107 <para>
108
109 </para>
110
111 @dialog: 
112 @key: 
113
114
115 <!-- ##### FUNCTION hildon_sort_dialog_set_sort_order ##### -->
116 <para>
117
118 </para>
119
120 @dialog: 
121 @order: 
122
123
124 <!-- ##### FUNCTION hildon_sort_dialog_add_sort_key ##### -->
125 <para>
126
127 </para>
128
129 @dialog: 
130 @sort_key: 
131 @Returns: 
132
133