summaryrefslogtreecommitdiff
path: root/src/lib/evas/canvas/evas_table.eo
blob: 18ed8a14527f99e369623265542be6fedf576202 (plain) (blame)
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
class Evas.Table (Evas.Smart_Clipped)
{
   legacy_prefix: evas_object_table;
   eo_prefix: evas_obj_table;
   methods {
      @property homogeneous {
         set {
            /*@
            @brief Set how this table should layout children.

            @todo consider aspect hint and respect it.

            @par EVAS_OBJECT_TABLE_HOMOGENEOUS_NONE
            If table does not use homogeneous mode then columns and rows will
            be calculated based on hints of individual cells. This operation
            mode is more flexible, but more complex and heavy to calculate as
            well. @b Weight properties are handled as a boolean expand. Negative
            alignment will be considered as 0.5. This is the default.

            @todo @c EVAS_OBJECT_TABLE_HOMOGENEOUS_NONE should balance weight.

            @par EVAS_OBJECT_TABLE_HOMOGENEOUS_TABLE
            When homogeneous is relative to table the own table size is divided
            equally among children, filling the whole table area. That is, if
            table has @c WIDTH and @c COLUMNS, each cell will get <tt>WIDTH /
            COLUMNS</tt> pixels. If children have minimum size that is larger
            than this amount (including padding), then it will overflow and be
            aligned respecting the alignment hint, possible overlapping sibling
            cells. @b Weight hint is used as a boolean, if greater than zero it
            will make the child expand in that axis, taking as much space as
            possible (bounded to maximum size hint). Negative alignment will be
            considered as 0.5.

            @par EVAS_OBJECT_TABLE_HOMOGENEOUS_ITEM
            When homogeneous is relative to item it means the greatest minimum
            cell size will be used. That is, if no element is set to expand,
            the table will have its contents to a minimum size, the bounding
            box of all these children will be aligned relatively to the table
            object using evas_object_table_align_get(). If the table area is
            too small to hold this minimum bounding box, then the objects will
            keep their size and the bounding box will overflow the box area,
            still respecting the alignment. @b Weight hint is used as a
            boolean, if greater than zero it will make that cell expand in that
            axis, toggling the <b>expand mode</b>, which makes the table behave
            much like @b EVAS_OBJECT_TABLE_HOMOGENEOUS_TABLE, except that the
            bounding box will overflow and items will not overlap siblings. If
            no minimum size is provided at all then the table will fallback to
            expand mode as well. */
         }
         get {
            /*@
            Get the current layout homogeneous mode.

            @see evas_object_table_homogeneous_set() */
         }
         values {
            Evas_Object_Table_Homogeneous_Mode homogeneous;
         }
      }
      @property align {
         set {
            /*@
            Set the alignment of the whole bounding box of contents. */
         }
         get {
            /*@
            Get alignment of the whole bounding box of contents. */
         }
         values {
            double horizontal;
            double vertical;
         }
      }
      @property padding {
         set {
            /*@
            Set padding between cells. */
         }
         get {
            /*@
            Get padding between cells. */
         }
         values {
            Evas_Coord horizontal;
            Evas_Coord vertical;
         }
      }
      @property mirrored {
         set {
            /*@
            Sets the mirrored mode of the table. In mirrored mode the table items go
            from right to left instead of left to right. That is, 1,1 is top right, not
            top left.

            @since 1.1 */
         }
         get {
            /*@
            Gets the mirrored mode of the table.

            @return @c EINA_TRUE if it's a mirrored table, @c EINA_FALSE otherwise.
            @since 1.1
            @see evas_object_table_mirrored_set() */
         }
         values {
            bool mirrored; /*@ the mirrored mode to set */
         }
      }
      @property col_row_size {
         get {
            /*@
            Get the number of columns and rows this table takes.

            @note columns and rows are virtual entities, one can specify a table
            with a single object that takes 4 columns and 5 rows. The only
            difference for a single cell table is that paddings will be
            accounted proportionally. */
         }
         values {
            int cols;
            int rows;
         }
      }
      @property children {
         get {
            /*@
            Get the list of children for the table.

            @note This is a duplicate of the list kept by the table internally.
            It's up to the user to destroy it when it no longer needs it.
            It's possible to remove objects from the table when walking this
            list, but these removals won't be reflected on it. */
            return: free(own(list<Evas.Object *> *), eina_list_free) @warn_unused;
         }
      }
      @property child {
         get {
            /*@
            Get the child of the table at the given coordinates

            @note This does not take into account col/row spanning*/
         }
         keys {
            ushort col;
            ushort row;
         }
         values {
            Evas_Object *child;
         }
      }
      clear {
         /*@
         Faster way to remove all child objects from a table object. */

         params {
            @in bool clear; /*@ if true, it will delete just removed children. */
         }
      }
      accessor_new @const {
         /*@
         Get an accessor to get random access to the list of children for the table.

         @note Do not remove or delete objects while walking the list. */
         return: free(own(accessor<Evas.Object *> *), eina_accessor_free)
            @warn_unused;
      }
      iterator_new @const {
         /*@
         Get an iterator to walk the list of children for the table.

         @note Do not remove or delete objects while walking the list. */
         return: free(own(iterator<Evas.Object *> *), eina_iterator_free)
            @warn_unused;
      }
      add_to {
         /*@
         @brief Create a table that is child of a given element @a parent.

         @see evas_object_table_add() */

         return: Evas_Object * @warn_unused;
      }
      pack_get @const {
         /*@
         Get packing location of a child of table

         @return 1 on success, 0 on failure.
         @since 1.1 */
         return: bool;
         params {
            @in Evas_Object *child; /*@ The child object to add. */
            @out ushort col; /*@ pointer to store relative-horizontal position to place child. */
            @out ushort row; /*@ pointer to store relative-vertical position to place child. */
            @out ushort colspan; /*@ pointer to store how many relative-horizontal position to use for this child. */
            @out ushort rowspan; /*@ pointer to store how many relative-vertical position to use for this child. */
         }
      }
      pack {
         /*@
         Add a new child to a table object or set its current packing.

         Note that columns and rows only guarantee 16bit unsigned values at best.
         That means that col + colspan AND row + rowspan must fit inside 16bit
         unsigned values cleanly. You will be warned once values exceed 15bit
         storage, and attempting to use values not able to fit in 16bits will
         result in failure.

         @return 1 on success, 0 on failure. */

         return: bool;
         params {
            @in Evas_Object *child @nonull; /*@ The child object to add. */
            @in ushort col; /*@ relative-horizontal position to place child. */
            @in ushort row; /*@ relative-vertical position to place child. */
            @in ushort colspan; /*@ how many relative-horizontal position to use for this child. */
            @in ushort rowspan; /*@ how many relative-vertical position to use for this child. */
         }
      }
      unpack {
         /*@
         Remove child from table.

         @note removing a child will immediately call a walk over children in order
         to recalculate numbers of columns and rows. If you plan to remove
         all children, use evas_object_table_clear() instead.

         @return 1 on success, 0 on failure. */

         return: bool;
         params {
            @in Evas_Object *child @nonull;
         }
      }
   }
   implements {
      class.constructor; 
      Eo.Base.constructor;
      Evas.Object_Smart.add;
      Evas.Object_Smart.del;
      Evas.Object_Smart.calculate;
      Evas.Object_Smart.resize;
   }
}