summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Kolesa <d.kolesa@osg.samsung.com>2015-08-07 14:08:01 +0100
committerDaniel Kolesa <d.kolesa@osg.samsung.com>2015-08-07 14:08:01 +0100
commit2e1f8a58d4f58ebf6e43e3ad376e8c2c6a7e8d37 (patch)
treee55e565f93bddb24e87b6425b23ab0f5e5cc520c
parent5ef1c3bfc93b613e7a3a4f3ad0a2031755a6d073 (diff)
table: convert docs
-rw-r--r--src/lib/elm_table.eo167
1 files changed, 61 insertions, 106 deletions
diff --git a/src/lib/elm_table.eo b/src/lib/elm_table.eo
index ce803f3ae..2793f3545 100644
--- a/src/lib/elm_table.eo
+++ b/src/lib/elm_table.eo
@@ -4,159 +4,114 @@ class Elm.Table (Elm.Widget)
4 data: null; 4 data: null;
5 methods { 5 methods {
6 @property homogeneous { 6 @property homogeneous {
7 set { 7 [[Control the homogenous state in a table.]]
8 /*@ 8 set {}
9 @brief Set the homogeneous layout in the table 9 get {}
10
11 @ingroup Table */
12 }
13 get {
14 /*@
15 @brief Get the current table homogeneous mode.
16
17 @return A boolean to indicating if the layout is homogeneous in the table
18 (true = homogeneous, false = no homogeneous)
19
20 @ingroup Table */
21 }
22 values { 10 values {
23 homogeneous: bool; /*@ A boolean to set if the layout is homogeneous in the 11 homogeneous: bool; [[A boolean to set if the layout is
24 table (true = homogeneous, false = no homogeneous) */ 12 homogeneous in the table.]]
25 } 13 }
26 } 14 }
27 @property padding { 15 @property padding {
28 set { 16 set {
29 /*@ 17 [[Set padding between cells. Default value is 0.]]
30 @brief Set padding between cells.
31
32 Default value is 0.
33
34 @ingroup Table */
35 } 18 }
36 get { 19 get {
37 /*@ 20 [[Get padding between cells.]]
38 @brief Get padding between cells.
39
40 @ingroup Table */
41 } 21 }
42 values { 22 values {
43 horizontal: Evas.Coord; /*@ set the horizontal padding. */ 23 horizontal: Evas.Coord; [[The horizontal padding.]]
44 vertical: Evas.Coord; /*@ set the vertical padding. */ 24 vertical: Evas.Coord; [[The vertical padding.]]
45 } 25 }
46 } 26 }
47 @property align { 27 @property align {
48 set { 28 set {
49 /*@ 29 [[Set alignment of table. Default value is 0.5.
50 @brief Set alignment of table
51 @since 1.13
52 30
53 Default value is 0.5. 31 @since 1.13
54 32 ]]
55 @ingroup Table */
56 } 33 }
57 get { 34 get {
58 /*@ 35 [[Get alignment of table.
59 @brief Get alignment of table.
60 @since 1.13
61 36
62 @ingroup Table */ 37 @since 1.13
38 ]]
63 } 39 }
64 values { 40 values {
65 horizontal: double; /*@ the horizontal alignment. */ 41 horizontal: double; [[The horizontal alignment.]]
66 vertical: double; /*@ the vertical alignment. */ 42 vertical: double; [[The vertical alignment.]]
67 } 43 }
68 } 44 }
69 clear { 45 clear {
70 /*@ 46 [[Faster way to remove all child objects from a table object.]]
71 @brief Faster way to remove all child objects from a table object.
72
73 @ingroup Table */
74
75 params { 47 params {
76 @in clear: bool; /*@ If true, will delete children, else just remove from table. */ 48 @in clear: bool; [[If true, will delete children, else just remove from table.]]
77 } 49 }
78 } 50 }
79 child_get @const { 51 child_get @const {
80 /*@ 52 [[Get child object of table at given coordinates.]]
81 @brief Get child object of table at given coordinates. 53 return: Evas.Object *; [[Child of object if find if not return $null.]]
82
83 @return Child of object if find if not return NULL. */
84 return: Evas.Object *;
85 params { 54 params {
86 @in col: int; /*@ Column number of child object */ 55 @in col: int; [[Column number of child object.]]
87 @in row: int; /*@ Row number of child object */ 56 @in row: int; [[Row number of child object.]]
88 } 57 }
89 } 58 }
90 pack_set { 59 pack_set {
91 /*@ 60 [[Set the packing location of an existing child of the table
92 @brief Set the packing location of an existing child of the table
93
94 Modifies the position of an object already in the table.
95
96 @note All positioning inside the table is relative to rows and columns, so
97 a value of 0 for col and row, means the top left cell of the table, and a
98 value of 1 for colspan and rowspan means $subobj only takes that 1 cell.
99 61
100 @ingroup Table */ 62 Modifies the position of an object already in the table.
101 63
64 Note: All positioning inside the table is relative to rows and
65 columns, so a value of 0 for col and row, means the top left
66 cell of the table, and a value of 1 for colspan and rowspan
67 means only takes that 1 cell.
68 ]]
102 params { 69 params {
103 @in subobj: Evas.Object *; /*@ The subobject to be modified in the table */ 70 @in subobj: Evas.Object *; [[The subobject to be modified in the table.]]
104 @in column: int; /*@ Column number */ 71 @in column: int; [[Column number.]]
105 @in row: int; /*@ Row number */ 72 @in row: int; [[Row number.]]
106 @in colspan: int; /*@ colspan */ 73 @in colspan: int;
107 @in rowspan: int; /*@ rowspan */ 74 @in rowspan: int;
108 } 75 }
109 legacy: null; 76 legacy: null;
110 } 77 }
111 pack_get { 78 pack_get {
112 /*@ 79 [[Get the packing location of an existing child of the table.]]
113 @brief Get the packing location of an existing child of the table
114
115 @see elm_table_pack_set()
116
117 @ingroup Table */
118
119 params { 80 params {
120 @in subobj: Evas.Object *; /*@ The subobject to be modified in the table */ 81 @in subobj: Evas.Object *; [[The subobject to be modified in the table.]]
121 @out column: int; /*@ Column number */ 82 @out column: int; [[Column number.]]
122 @out row: int; /*@ Row number */ 83 @out row: int; [[Row number.]]
123 @out colspan: int; /*@ colspan */ 84 @out colspan: int;
124 @out rowspan: int; /*@ rowspan */ 85 @out rowspan: int;
125 } 86 }
126 legacy: null; 87 legacy: null;
127 } 88 }
128 unpack { 89 unpack {
129 /*@ 90 [[Remove child from table.]]
130 @brief Remove child from table.
131
132 @ingroup Table */
133
134 params { 91 params {
135 @in subobj: Evas.Object *; /*@ The subobject */ 92 @in subobj: Evas.Object *; [[The subobject.]]
136 } 93 }
137 } 94 }
138 pack { 95 pack {
139 /*@ 96 [[Add a subobject on the table with the coordinates passed.
140 @brief Add a subobject on the table with the coordinates passed 97
141 98 Note: All positioning inside the table is relative to rows and
142 @note All positioning inside the table is relative to rows and columns, so 99 columns, so a value of 0 for x and y, means the top left cell of
143 a value of 0 for x and y, means the top left cell of the table, and a 100 the table, and a value of 1 for w and h means $subobj only takes
144 value of 1 for w and h means $subobj only takes that 1 cell. 101 that 1 cell.
145 102
146 Note that columns and rows only guarantee 16bit unsigned values at best. 103 Note: Columns and rows only guarantee 16bit unsigned values
147 That means that col + colspan AND row + rowspan must fit inside 16bit 104 at best. That means that col + colspan AND row + rowspan must fit
148 unsigned values cleanly. You will be warned once values exceed 15bit 105 inside 16bit unsigned values cleanly. You will be warned once
149 storage, and attempting to use values not able to fit in 16bits will 106 values exceed 15bit storage, and attempting to use values not
150 result in failure. 107 able to fit in 16bits will result in failure.
151 108 ]]
152 @ingroup Table */
153
154 params { 109 params {
155 @in subobj: Evas.Object *; /*@ The subobject to be added to the table */ 110 @in subobj: Evas.Object *; [[The subobject to be added to the table.]]
156 @in column: int; /*@ Column number */ 111 @in column: int; [[Column number.]]
157 @in row: int; /*@ Row number */ 112 @in row: int; [[Row number.]]
158 @in colspan: int; /*@ colspan */ 113 @in colspan: int;
159 @in rowspan: int; /*@ rowspan */ 114 @in rowspan: int;
160 } 115 }
161 } 116 }
162 } 117 }