9a6875481b8a4e6b949a7b8f6b94f1407058d736
[hildon] / doc / tmpl / hildon-grid-item.sgml
1 <!-- ##### SECTION Title ##### -->
2 HildonGridItem
3
4 <!-- ##### SECTION Short_Description ##### -->
5 #HildonGridItem is indeded to be used with #HildonGrid.
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9 #HildonGridItem is an uninteractive widget representing item on #HildonGrid.
10 Each item has an icon and a label. Depending on current style, icon can be
11 either above or to the left of the label.
12
13 </para>
14
15 <para>
16 <informalexample>
17 Example
18 <programlisting>
19 <!-- hildon-tests/wt/hildon-widgets-combo/testgrid.c -->
20 ##include &lt;hildon-widgets/hildon-grid-item.h&gt;
21 ...
22 static void
23 create_basic_icons (HildonGrid *grid)
24 {
25         w_add_one = hildon_grid_item_new_with_label (
26                         "Calendar", _("Add one"));
27         w_add_eight = hildon_grid_item_new_with_label (
28                         "Clock", _("Add eight"));
29         w_disable_next = hildon_grid_item_new_with_label (
30                         "Calculator", _("Disable next"));
31         w_emblem_next = hildon_grid_item_new_with_label (
32                         "Paint", _("Set emblem"));
33         emblem_this (w_emblem_next);
34
35         gtk_container_add (GTK_CONTAINER (grid), w_add_one);
36         gtk_container_add (GTK_CONTAINER (grid), w_add_eight);
37         gtk_container_add (GTK_CONTAINER (grid), w_disable_next);
38         gtk_container_add (GTK_CONTAINER (grid), w_emblem_next);
39 }
40 ...
41 </programlisting>
42 </informalexample>
43 </para>
44
45 <!-- ##### SECTION See_Also ##### -->
46 <para>
47 #HildonGrid
48 </para>
49
50 <!-- ##### STRUCT HildonGridItem ##### -->
51 <para>
52
53 </para>
54
55
56 <!-- ##### ENUM HildonGridPositionType ##### -->
57 <para>
58
59 </para>
60
61 @HILDON_GRID_ITEM_LABEL_POS_BOTTOM: 
62 @HILDON_GRID_ITEM_LABEL_POS_RIGHT: 
63
64 <!-- ##### ENUM HildonGridItemIconSizeType ##### -->
65 <para>
66
67 </para>
68
69 @HILDON_GRID_ITEM_ICON_27x27: 
70 @HILDON_GRID_ITEM_ICON_128x128: 
71
72 <!-- ##### FUNCTION hildon_grid_item_new ##### -->
73 <para>
74
75 </para>
76
77 @icon_basename: 
78 @Returns: 
79
80
81 <!-- ##### FUNCTION hildon_grid_item_new_with_label ##### -->
82 <para>
83
84 </para>
85
86 @icon_basename: 
87 @label: 
88 @Returns: 
89
90
91 <!-- ##### FUNCTION hildon_grid_item_set_emblem_type ##### -->
92 <para>
93
94 </para>
95
96 @item: 
97 @emblem_basename: 
98
99
100 <!-- ##### FUNCTION hildon_grid_item_get_emblem_type ##### -->
101 <para>
102
103 </para>
104
105 @item: 
106 @Returns: 
107
108