summaryrefslogtreecommitdiff
path: root/pages/develop/api/efl/canvas/layout.txt
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-11-29 12:02:18 +0100
committerXavi Artigas <xavierartigas@yahoo.es>2019-11-29 12:02:18 +0100
commit005b875e15f138926b07bc0ab226ac880fe34416 (patch)
treee4c715c970d80e5e46a614a3c699753f211ebc3f /pages/develop/api/efl/canvas/layout.txt
parenta5b73ce5680864276c941cf8c8947ecb51cf339b (diff)
Update C API reference guide to 1.23
Generated with edocgen.lua from efl.git branch efl-1.23
Diffstat (limited to '')
-rw-r--r--pages/develop/api/efl/canvas/layout.txt506
1 files changed, 0 insertions, 506 deletions
diff --git a/pages/develop/api/efl/canvas/layout.txt b/pages/develop/api/efl/canvas/layout.txt
deleted file mode 100644
index 4890907..0000000
--- a/pages/develop/api/efl/canvas/layout.txt
+++ /dev/null
@@ -1,506 +0,0 @@
1~~Title: Efl.Canvas.Layout~~
2====== Efl.Canvas.Layout (class) ======
3
4===== Description =====
5
6%%Edje object class%%
7
8{{page>:develop:api-include:efl:canvas:layout:description&nouser&nolink&nodate}}
9
10===== Inheritance =====
11
12 => [[:develop:api:efl:canvas:group|Efl.Canvas.Group]] //(class)// => [[:develop:api:efl:canvas:object|Efl.Canvas.Object]] //(class)// => [[:develop:api:efl:object|Efl.Object]] //(class)//
13++++ Full hierarchy |
14
15 * [[:develop:api:efl:canvas:group|Efl.Canvas.Group]] //(class)//
16 * [[:develop:api:efl:canvas:object|Efl.Canvas.Object]] //(class)//
17 * [[:develop:api:efl:object|Efl.Object]] //(class)//
18 * [[:develop:api:efl:gfx|Efl.Gfx]] //(interface)//
19 * [[:develop:api:efl:gfx:color|Efl.Gfx.Color]] //(mixin)//
20 * [[:develop:api:efl:gfx:stack|Efl.Gfx.Stack]] //(interface)//
21 * [[:develop:api:efl:animator|Efl.Animator]] //(interface)//
22 * [[:develop:api:efl:input:interface|Efl.Input.Interface]] //(interface)//
23 * [[:develop:api:efl:gfx:size:hint|Efl.Gfx.Size.Hint]] //(interface)//
24 * [[:develop:api:efl:gfx:map|Efl.Gfx.Map]] //(mixin)//
25 * [[:develop:api:efl:interface|Efl.Interface]] //(interface)//
26 * [[:develop:api:efl:object|Efl.Object]] //(class)//
27 * [[:develop:api:efl:loop:consumer|Efl.Loop.Consumer]] //(class)//
28 * [[:develop:api:efl:object|Efl.Object]] //(class)//
29 * [[:develop:api:efl:ui:base|Efl.Ui.Base]] //(interface)//
30 * [[:develop:api:efl:canvas:pointer|Efl.Canvas.Pointer]] //(interface)//
31 * [[:develop:api:efl:file|Efl.File]] //(mixin)//
32 * [[:develop:api:efl:container|Efl.Container]] //(interface)//
33 * [[:develop:api:efl:part|Efl.Part]] //(interface)//
34 * [[:develop:api:efl:observer|Efl.Observer]] //(interface)//
35 * [[:develop:api:efl:ui:base|Efl.Ui.Base]] //(interface)//
36 * [[:develop:api:efl:layout:calc|Efl.Layout.Calc]] //(interface)//
37 * [[:develop:api:efl:layout:signal|Efl.Layout.Signal]] //(interface)//
38 * [[:develop:api:efl:layout:group|Efl.Layout.Group]] //(interface)//
39 * [[:develop:api:efl:player|Efl.Player]] //(interface)//
40 * [[:develop:api:efl:gfx:color_class|Efl.Gfx.Color_Class]] //(interface)//
41 * [[:develop:api:efl:gfx:text_class|Efl.Gfx.Text_Class]] //(interface)//
42 * [[:develop:api:efl:gfx:size_class|Efl.Gfx.Size_Class]] //(interface)//
43
44
45++++
46===== Members =====
47
48**[[:develop:api:efl:canvas:layout:method:access_part_iterate|access_part_iterate]]**\\
49> %%Iterates over all accessibility-enabled part names.%%
50<code c>
51Eina_Iterator *efl_canvas_layout_access_part_iterate(Eo *obj);
52</code>
53\\
54**[[:develop:api:efl:canvas:layout:property:animation|animation]]** //**(get, set)**//\\
55> %%Whether this object is animating or not.%%
56<code c>
57Eina_Bool efl_canvas_layout_animation_get(const Eo *obj);
58void efl_canvas_layout_animation_set(Eo *obj, Eina_Bool on);
59</code>
60\\
61**[[:develop:api:efl:canvas:layout:property:calc_auto_update_hints|calc_auto_update_hints]]** //**(get, set)**//// [Overridden from [[:develop:api:efl:layout:calc|Efl.Layout.Calc]]]//\\
62> %%Whether this object updates its size hints automatically.%%
63<code c>
64Eina_Bool efl_layout_calc_auto_update_hints_get(const Eo *obj);
65void efl_layout_calc_auto_update_hints_set(Eo *obj, Eina_Bool update);
66</code>
67\\
68**[[:develop:api:efl:canvas:layout:method:calc_freeze|calc_freeze]]**// [Overridden from [[:develop:api:efl:layout:calc|Efl.Layout.Calc]]]//\\
69> %%Freezes the layout object.%%
70<code c>
71int efl_layout_calc_freeze(Eo *obj);
72</code>
73\\
74**[[:develop:api:efl:canvas:layout:method:calc_parts_extends|calc_parts_extends]]**// [Overridden from [[:develop:api:efl:layout:calc|Efl.Layout.Calc]]]//\\
75> %%Calculates the geometry of the region, relative to a given layout object's area, occupied by all parts in the object.%%
76<code c>
77Eina_Rect efl_layout_calc_parts_extends(Eo *obj);
78</code>
79\\
80**[[:develop:api:efl:canvas:layout:method:calc_size_min|calc_size_min]]**// [Overridden from [[:develop:api:efl:layout:calc|Efl.Layout.Calc]]]//\\
81> %%Calculates the minimum required size for a given layout object.%%
82<code c>
83Eina_Size2D efl_layout_calc_size_min(Eo *obj, Eina_Size2D restricted);
84</code>
85\\
86**[[:develop:api:efl:canvas:layout:method:calc_thaw|calc_thaw]]**// [Overridden from [[:develop:api:efl:layout:calc|Efl.Layout.Calc]]]//\\
87> %%Thaws the layout object.%%
88<code c>
89int efl_layout_calc_thaw(Eo *obj);
90</code>
91\\
92**[[:develop:api:efl:canvas:layout:property:color_class|color_class]]** //**(get, set)**//// [Overridden from [[:develop:api:efl:gfx:color_class|Efl.Gfx.Color_Class]]]//\\
93>
94<code c>
95Eina_Bool efl_gfx_color_class_get(const Eo *obj, const char *color_class, Efl_Gfx_Color_Class_Layer layer, int *r, int *g, int *b, int *a);
96Eina_Bool efl_gfx_color_class_set(Eo *obj, const char *color_class, Efl_Gfx_Color_Class_Layer layer, int r, int g, int b, int a);
97</code>
98\\
99**[[:develop:api:efl:canvas:layout:method:color_class_clear|color_class_clear]]**// [Overridden from [[:develop:api:efl:gfx:color_class|Efl.Gfx.Color_Class]]]//\\
100> %%Delete all color classes defined in object level.%%
101<code c>
102void efl_gfx_color_class_clear(Eo *obj);
103</code>
104\\
105**[[:develop:api:efl:canvas:layout:method:color_class_del|color_class_del]]**// [Overridden from [[:develop:api:efl:gfx:color_class|Efl.Gfx.Color_Class]]]//\\
106> %%Delete the color class.%%
107<code c>
108void efl_gfx_color_class_del(Eo *obj, const char *color_class);
109</code>
110\\
111**[[:develop:api:efl:canvas:layout:property:color_class_description|color_class_description]]** //**(get)**//// [Overridden from [[:develop:api:efl:gfx:color_class|Efl.Gfx.Color_Class]]]//\\
112> %%Get the description of a color class.%%
113<code c>
114const char *efl_gfx_color_class_description_get(const Eo *obj, const char *color_class);
115</code>
116\\
117**[[:develop:api:efl:canvas:layout:method:constructor|constructor]]**// [Overridden from [[:develop:api:efl:object|Efl.Object]]]//\\
118> %%Call the object's constructor.%%
119<code c>
120Efl_Object *efl_constructor(Eo *obj);
121</code>
122\\
123**[[:develop:api:efl:canvas:layout:method:content_remove|content_remove]]**// [Overridden from [[:develop:api:efl:container|Efl.Container]]]//\\
124> %%Unswallow an object from this container.%%
125<code c>
126Eina_Bool efl_content_remove(Eo *obj, Efl_Gfx *content);
127</code>
128\\
129**[[:develop:api:efl:canvas:layout:method:debug_name_override|debug_name_override]]**// [Overridden from [[:develop:api:efl:object|Efl.Object]]]//\\
130> %%Build a read-only name for this object used for debugging.%%
131<code c>
132void efl_debug_name_override(Eo *obj, Eina_Strbuf *sb);
133</code>
134\\
135**[[:develop:api:efl:canvas:layout:method:group_calculate|group_calculate]]**// [Overridden from [[:develop:api:efl:canvas:group|Efl.Canvas.Group]]]//\\
136> %%Triggers an immediate recalculation of this object's geometry.%%
137<code c>
138void efl_canvas_group_calculate(Eo *obj);
139</code>
140\\
141**[[:develop:api:efl:canvas:layout:property:group_data|group_data]]** //**(get)**//// [Overridden from [[:develop:api:efl:layout:group|Efl.Layout.Group]]]//\\
142> %%Retrives an EDC data field's value from a given Edje object's group.%%
143<code c>
144const char *efl_layout_group_data_get(const Eo *obj, const char *key);
145</code>
146\\
147**[[:develop:api:efl:canvas:layout:property:group_size_max|group_size_max]]** //**(get)**//// [Overridden from [[:develop:api:efl:layout:group|Efl.Layout.Group]]]//\\
148> %%Gets the maximum size specified -- as an EDC property -- for a given Edje object%%
149<code c>
150Eina_Size2D efl_layout_group_size_max_get(const Eo *obj);
151</code>
152\\
153**[[:develop:api:efl:canvas:layout:property:group_size_min|group_size_min]]** //**(get)**//// [Overridden from [[:develop:api:efl:layout:group|Efl.Layout.Group]]]//\\
154> %%Gets the minimum size specified -- as an EDC property -- for a given Edje object%%
155<code c>
156Eina_Size2D efl_layout_group_size_min_get(const Eo *obj);
157</code>
158\\
159**[[:develop:api:efl:canvas:layout:property:item_provider|item_provider]]** //**(set)**//\\
160> %%Sets the function that provides item objects for named items in an edje entry text%%
161<code c>
162void efl_canvas_layout_item_provider_set(Eo *obj, Edje_Item_Provider_Cb func, void *data);
163</code>
164\\
165**[[:develop:api:efl:canvas:layout:property:language|language]]** //**(get, set)**//// [Overridden from [[:develop:api:efl:ui:base|Efl.Ui.Base]]]//\\
166> %%The (human) language for this object.%%
167<code c>
168const char *efl_ui_language_get(const Eo *obj);
169void efl_ui_language_set(Eo *obj, const char *language);
170</code>
171\\
172**[[:develop:api:efl:canvas:layout:property:load_error|load_error]]** //**(get)**//// [Overridden from [[:develop:api:efl:file|Efl.File]]]//\\
173> %%Gets the (last) file loading error for a given object.%%
174<code c>
175Efl_Image_Load_Error efl_file_load_error_get(const Eo *obj);
176</code>
177\\
178**[[:develop:api:efl:canvas:layout:method:message_send|message_send]]**// [Overridden from [[:develop:api:efl:layout:signal|Efl.Layout.Signal]]]//\\
179> %%Sends an (Edje) message to a given Edje object%%
180<code c>
181void efl_layout_signal_message_send(Eo *obj, int id, const Eina_Value msg);
182</code>
183\\
184**[[:develop:api:efl:canvas:layout:property:mirrored|mirrored]]** //**(get, set)**//// [Overridden from [[:develop:api:efl:ui:base|Efl.Ui.Base]]]//\\
185> %%Whether this object should be mirrored.%%
186<code c>
187Eina_Bool efl_ui_mirrored_get(const Eo *obj);
188void efl_ui_mirrored_set(Eo *obj, Eina_Bool rtl);
189</code>
190\\
191**[[:develop:api:efl:canvas:layout:property:mmap|mmap]]** //**(get, set)**//// [Overridden from [[:develop:api:efl:file|Efl.File]]]//\\
192>
193<code c>
194void efl_file_mmap_get(const Eo *obj, const Eina_File **f, const char **key);
195Eina_Bool efl_file_mmap_set(Eo *obj, const Eina_File *f, const char *key);
196</code>
197\\
198**[[:develop:api:efl:canvas:layout:property:no_render|no_render]]** //**(get, set)**//// [Overridden from [[:develop:api:efl:canvas:object|Efl.Canvas.Object]]]//\\
199>
200<code c>
201Eina_Bool efl_canvas_object_no_render_get(const Eo *obj);
202void efl_canvas_object_no_render_set(Eo *obj, Eina_Bool enable);
203</code>
204\\
205**[[:develop:api:efl:canvas:layout:property:paragraph_direction|paragraph_direction]]** //**(get, set)**//// [Overridden from [[:develop:api:efl:canvas:object|Efl.Canvas.Object]]]//\\
206> %%This handles text paragraph direction of the given object. Even if the given object is not textblock or text, its smart child objects can inherit the paragraph direction from the given object. The default paragraph direction is %%''inherit''%%.%%
207<code c>
208Efl_Text_Bidirectional_Type efl_canvas_object_paragraph_direction_get(const Eo *obj);
209void efl_canvas_object_paragraph_direction_set(Eo *obj, Efl_Text_Bidirectional_Type dir);
210</code>
211\\
212**[[:develop:api:efl:canvas:layout:method:part|part]]**// [Overridden from [[:develop:api:efl:part|Efl.Part]]]//\\
213> %%Returns %%[[:develop:api:efl:canvas:layout:part|Efl.Canvas.Layout.Part]]%%.%%
214<code c>
215Efl_Object *efl_part(const Eo *obj, const char *name);
216</code>
217\\
218**[[:develop:api:efl:canvas:layout:property:play|play]]** //**(get, set)**//// [Overridden from [[:develop:api:efl:player|Efl.Player]]]//\\
219>
220<code c>
221Eina_Bool efl_player_play_get(const Eo *obj);
222void efl_player_play_set(Eo *obj, Eina_Bool play);
223</code>
224\\
225**[[:develop:api:efl:canvas:layout:property:play_speed|play_speed]]** //**(get, set)**//// [Overridden from [[:develop:api:efl:player|Efl.Player]]]//\\
226> %%Control the play speed of the media file.%%
227<code c>
228double efl_player_play_speed_get(const Eo *obj);
229void efl_player_play_speed_set(Eo *obj, double speed);
230</code>
231\\
232**[[:develop:api:efl:canvas:layout:property:playable|playable]]** //**(get)**//// [Overridden from [[:develop:api:efl:player|Efl.Player]]]//\\
233> %%Whether or not the object data can be played.%%
234<code c>
235Eina_Bool efl_player_playable_get(const Eo *obj);
236</code>
237\\
238**[[:develop:api:efl:canvas:layout:property:position|position]]** //**(get, set)**//// [Overridden from [[:develop:api:efl:gfx|Efl.Gfx]]]//\\
239> %%The 2D position of a canvas object.%%
240<code c>
241Eina_Position2D efl_gfx_position_get(const Eo *obj);
242void efl_gfx_position_set(Eo *obj, Eina_Position2D pos);
243</code>
244\\
245**[[:develop:api:efl:canvas:layout:property:scale|scale]]** //**(get, set)**//// [Overridden from [[:develop:api:efl:gfx|Efl.Gfx]]]//\\
246> %%The scaling factor of an object.%%
247<code c>
248double efl_gfx_scale_get(const Eo *obj);
249void efl_gfx_scale_set(Eo *obj, double scale);
250</code>
251\\
252**[[:develop:api:efl:canvas:layout:property:seat|seat]]** //**(get)**//\\
253> %%Returns the seat device given its Edje's name.%%
254<code c>
255Efl_Input_Device *efl_canvas_layout_seat_get(const Eo *obj, Eina_Stringshare *name);
256</code>
257\\
258**[[:develop:api:efl:canvas:layout:property:seat_name|seat_name]]** //**(get)**//\\
259> %%Gets the name given to a set by Edje.%%
260<code c>
261Eina_Stringshare *efl_canvas_layout_seat_name_get(const Eo *obj, Efl_Input_Device *device);
262</code>
263\\
264**[[:develop:api:efl:canvas:layout:method:signal_callback_add|signal_callback_add]]**// [Overridden from [[:develop:api:efl:layout:signal|Efl.Layout.Signal]]]//\\
265> %%Adds a callback for an arriving Edje signal, emitted by a given Edje object.%%
266<code c>
267Eina_Bool efl_layout_signal_callback_add(Eo *obj, const char *emission, const char *source, Efl_Signal_Cb func, void *data);
268</code>
269\\
270**[[:develop:api:efl:canvas:layout:method:signal_callback_del|signal_callback_del]]**// [Overridden from [[:develop:api:efl:layout:signal|Efl.Layout.Signal]]]//\\
271> %%Removes a signal-triggered callback from an object.%%
272<code c>
273Eina_Bool efl_layout_signal_callback_del(Eo *obj, const char *emission, const char *source, Efl_Signal_Cb func, void *data);
274</code>
275\\
276**[[:develop:api:efl:canvas:layout:method:signal_emit|signal_emit]]**// [Overridden from [[:develop:api:efl:layout:signal|Efl.Layout.Signal]]]//\\
277> %%Sends/emits an Edje signal to this layout.%%
278<code c>
279void efl_layout_signal_emit(Eo *obj, const char *emission, const char *source);
280</code>
281\\
282**[[:develop:api:efl:canvas:layout:method:signal_process|signal_process]]**// [Overridden from [[:develop:api:efl:layout:signal|Efl.Layout.Signal]]]//\\
283> %%Processes an object's messages and signals queue.%%
284<code c>
285void efl_layout_signal_process(Eo *obj, Eina_Bool recurse);
286</code>
287\\
288**[[:develop:api:efl:canvas:layout:property:size|size]]** //**(get, set)**//// [Overridden from [[:develop:api:efl:gfx|Efl.Gfx]]]//\\
289> %%The 2D size of a canvas object.%%
290<code c>
291Eina_Size2D efl_gfx_size_get(const Eo *obj);
292void efl_gfx_size_set(Eo *obj, Eina_Size2D size);
293</code>
294\\
295**[[:develop:api:efl:canvas:layout:property:size_class|size_class]]** //**(get, set)**//// [Overridden from [[:develop:api:efl:gfx:size_class|Efl.Gfx.Size_Class]]]//\\
296>
297<code c>
298Eina_Bool efl_gfx_size_class_get(const Eo *obj, const char *size_class, int *minw, int *minh, int *maxw, int *maxh);
299Eina_Bool efl_gfx_size_class_set(Eo *obj, const char *size_class, int minw, int minh, int maxw, int maxh);
300</code>
301\\
302**[[:develop:api:efl:canvas:layout:method:size_class_del|size_class_del]]**// [Overridden from [[:develop:api:efl:gfx:size_class|Efl.Gfx.Size_Class]]]//\\
303> %%Delete the size class.%%
304<code c>
305void efl_gfx_size_class_del(Eo *obj, const char *size_class);
306</code>
307\\
308**[[:develop:api:efl:canvas:layout:property:text_class|text_class]]** //**(get, set)**//// [Overridden from [[:develop:api:efl:gfx:text_class|Efl.Gfx.Text_Class]]]//\\
309>
310<code c>
311Eina_Bool efl_gfx_text_class_get(const Eo *obj, const char *text_class, const char **font, Efl_Font_Size *size);
312Eina_Bool efl_gfx_text_class_set(Eo *obj, const char *text_class, const char *font, Efl_Font_Size size);
313</code>
314\\
315**[[:develop:api:efl:canvas:layout:method:text_class_del|text_class_del]]**// [Overridden from [[:develop:api:efl:gfx:text_class|Efl.Gfx.Text_Class]]]//\\
316> %%Delete the text class.%%
317<code c>
318void efl_gfx_text_class_del(Eo *obj, const char *text_class);
319</code>
320\\
321**[[:develop:api:efl:canvas:layout:method:update|update]]**// [Overridden from [[:develop:api:efl:observer|Efl.Observer]]]//\\
322> %%Update observer according to the changes of observable object.%%
323<code c>
324void efl_observer_update(Eo *obj, Efl_Object *obs, const char *key, void *data);
325</code>
326\\
327**[[:develop:api:efl:canvas:layout:property:visible|visible]]** //**(get, set)**//// [Overridden from [[:develop:api:efl:gfx|Efl.Gfx]]]//\\
328> %%The visibility of a canvas object.%%
329<code c>
330Eina_Bool efl_gfx_visible_get(const Eo *obj);
331void efl_gfx_visible_set(Eo *obj, Eina_Bool v);
332</code>
333\\
334**[[:develop:api:efl:canvas:layout:method:calc_force|calc_force]]** ''protected''// [Overridden from [[:develop:api:efl:layout:calc|Efl.Layout.Calc]]]//\\
335> %%Forces a Size/Geometry calculation.%%
336<code c>
337void efl_layout_calc_force(Eo *obj);
338</code>
339\\
340
341==== Inherited ====
342
343^ [[:develop:api:efl:canvas:group|Efl.Canvas.Group]] ^^^
344| | **[[:develop:api:efl:canvas:group:property:clip|clip]]** //**(get, set)**// | |
345| | **[[:develop:api:efl:canvas:group:property:color|color]]** //**(get, set)**// | |
346| | **[[:develop:api:efl:canvas:group:method:destructor|destructor]]** | %%Call the object's destructor.%% |
347| | **[[:develop:api:efl:canvas:group:method:group_change|group_change]]** | %%Marks the object as dirty.%% |
348| | **[[:develop:api:efl:canvas:group:method:group_member_add|group_member_add]]** | %%Set a canvas object as a member of a given group (or smart object).%% |
349| | **[[:develop:api:efl:canvas:group:method:group_member_del|group_member_del]]** | %%Removes a member object from a given smart object.%% |
350| | **[[:develop:api:efl:canvas:group:method:group_member_is|group_member_is]]** | %%Finds out if a given object is a member of this group.%% |
351| | **[[:develop:api:efl:canvas:group:method:group_members_iterate|group_members_iterate]]** | %%Returns an iterator over the children of this object, which are canvas objects.%% |
352| | **[[:develop:api:efl:canvas:group:property:group_need_recalculate|group_need_recalculate]]** //**(get, set)**// | %%Indicates that the group's layout needs to be recalculated.%% |
353| ''protected'' | **[[:develop:api:efl:canvas:group:property:group_clipper|group_clipper]]** //**(get)**// | %%The internal clipper object used by this group.%% |
354^ [[:develop:api:efl:canvas:object|Efl.Canvas.Object]] ^^^
355| | **[[:develop:api:efl:canvas:object:property:above|above]]** //**(get)**// | %%Get the Evas object stacked right above %%''obj''%%%% |
356| | **[[:develop:api:efl:canvas:object:property:anti_alias|anti_alias]]** //**(get, set)**// | |
357| | **[[:develop:api:efl:canvas:object:property:below|below]]** //**(get)**// | %%Get the Evas object stacked right below %%''obj''%%%% |
358| | **[[:develop:api:efl:canvas:object:property:clipees|clipees]]** //**(get)**// | %%Return a list of objects currently clipped by %%''obj''%%.%% |
359| | **[[:develop:api:efl:canvas:object:method:clipees_has|clipees_has]]** | %%Test if any object is clipped by %%''obj''%%.%% |
360| | **[[:develop:api:efl:canvas:object:property:coords_inside|coords_inside]]** //**(get)**// | %%Returns whether the coords are logically inside the object.%% |
361| | **[[:develop:api:efl:canvas:object:method:del|del]]** | %%Unrefs the object and reparents it to NULL.%% |
362| | **[[:develop:api:efl:canvas:object:property:event_animation|event_animation]]** //**(get, set)**// | %%Set the %%''animation''%% which starts when the given %%''event_name''%% happens to the object.%% |
363| | **[[:develop:api:efl:canvas:object:method:finalize|finalize]]** | %%Called at the end of efl_add. Should not be called, just overridden.%% |
364| | **[[:develop:api:efl:canvas:object:property:freeze_events|freeze_events]]** //**(get, set)**// | |
365| | **[[:develop:api:efl:canvas:object:property:geometry|geometry]]** //**(get, set)**// | %%Rectangular geometry that combines both position and size.%% |
366| | **[[:develop:api:efl:canvas:object:property:hint_align|hint_align]]** //**(get, set)**// | %%Hints for an object's alignment.%% |
367| | **[[:develop:api:efl:canvas:object:property:hint_aspect|hint_aspect]]** //**(get, set)**// | %%Defines the aspect ratio to respect when scaling this object.%% |
368| | **[[:develop:api:efl:canvas:object:property:hint_combined_min|hint_combined_min]]** //**(get)**// | %%Read-only minimum size combining both %%[[:develop:api:efl:gfx:size:hint:property:hint_restricted_min|Efl.Gfx.Size.Hint.hint_restricted_min]]%% and %%[[:develop:api:efl:gfx:size:hint:property:hint_min|Efl.Gfx.Size.Hint.hint_min]]%% size hints.%% |
369| | **[[:develop:api:efl:canvas:object:property:hint_margin|hint_margin]]** //**(get, set)**// | %%Hints for an object's margin or padding space.%% |
370| | **[[:develop:api:efl:canvas:object:property:hint_max|hint_max]]** //**(get, set)**// | %%Hints on the object's maximum size.%% |
371| | **[[:develop:api:efl:canvas:object:property:hint_min|hint_min]]** //**(get, set)**// | %%Hints on the object's minimum size.%% |
372| ''protected set'' | **[[:develop:api:efl:canvas:object:property:hint_restricted_min|hint_restricted_min]]** //**(get, set)**// | %%Internal hints for an object's minimum size.%% |
373| | **[[:develop:api:efl:canvas:object:property:hint_weight|hint_weight]]** //**(get, set)**// | %%Hints for an object's weight.%% |
374| | **[[:develop:api:efl:canvas:object:property:is_frame_object|is_frame_object]]** //**(get, set)**// | %%If %%''true''%% the object belongs to the window border decorations.%% |
375| | **[[:develop:api:efl:canvas:object:property:key_focus|key_focus]]** //**(get, set)**// | %%Indicates that this object is the keyboard event receiver on its canvas.%% |
376| | **[[:develop:api:efl:canvas:object:method:key_grab|key_grab]]** | %%Requests %%''keyname''%% key events be directed to %%''obj''%%.%% |
377| | **[[:develop:api:efl:canvas:object:method:key_ungrab|key_ungrab]]** | %%Removes the grab on %%''keyname''%% key events by %%''obj''%%.%% |
378| | **[[:develop:api:efl:canvas:object:property:layer|layer]]** //**(get, set)**// | |
379| | **[[:develop:api:efl:canvas:object:property:loop|loop]]** //**(get)**// | %%The loop to which this object belongs to.%% |
380| | **[[:develop:api:efl:canvas:object:method:lower|lower]]** | %%Lower %%''obj''%% to the bottom of its layer.%% |
381| | **[[:develop:api:efl:canvas:object:property:pass_events|pass_events]]** //**(get, set)**// | |
382| | **[[:develop:api:efl:canvas:object:property:pointer_inside|pointer_inside]]** //**(get)**// | %%Returns whether the mouse pointer is logically inside the canvas.%% |
383| | **[[:develop:api:efl:canvas:object:property:pointer_mode|pointer_mode]]** //**(get, set)**// | %%Low-level pointer behaviour.%% |
384| | **[[:develop:api:efl:canvas:object:property:pointer_mode_by_device|pointer_mode_by_device]]** //**(get, set)**// | %%Low-level pointer behaviour by device. See %%[[:develop:api:efl:canvas:object:property:pointer_mode|Efl.Canvas.Object.pointer_mode.get]]%% and %%[[:develop:api:efl:canvas:object:property:pointer_mode|Efl.Canvas.Object.pointer_mode.set]]%% for more explanation.%% |
385| | **[[:develop:api:efl:canvas:object:property:precise_is_inside|precise_is_inside]]** //**(get, set)**// | |
386| | **[[:develop:api:efl:canvas:object:property:propagate_events|propagate_events]]** //**(get, set)**// | |
387| | **[[:develop:api:efl:canvas:object:method:provider_find|provider_find]]** | %%Searches upwards in the object tree for a provider which knows the given class/interface.%% |
388| | **[[:develop:api:efl:canvas:object:method:raise|raise]]** | %%Raise %%''obj''%% to the top of its layer.%% |
389| | **[[:develop:api:efl:canvas:object:property:render_op|render_op]]** //**(get, set)**// | %%Render mode to be used for compositing the Evas object.%% |
390| | **[[:develop:api:efl:canvas:object:property:repeat_events|repeat_events]]** //**(get, set)**// | |
391| | **[[:develop:api:efl:canvas:object:property:seat_event_filter|seat_event_filter]]** //**(get, set)**// | |
392| | **[[:develop:api:efl:canvas:object:property:seat_focus|seat_focus]]** //**(get)**// | %%Check if this object is focused.%% |
393| | **[[:develop:api:efl:canvas:object:method:seat_focus_add|seat_focus_add]]** | %%Add a seat to the focus list.%% |
394| | **[[:develop:api:efl:canvas:object:method:seat_focus_check|seat_focus_check]]** | %%Check if this object is focused by a given seat%% |
395| | **[[:develop:api:efl:canvas:object:method:seat_focus_del|seat_focus_del]]** | %%Remove a seat from the focus list.%% |
396| | **[[:develop:api:efl:canvas:object:method:stack_above|stack_above]]** | %%Stack %%''obj''%% immediately %%''above''%%%% |
397| | **[[:develop:api:efl:canvas:object:method:stack_below|stack_below]]** | %%Stack %%''obj''%% immediately %%''below''%%%% |
398| ''protected'' | **[[:develop:api:efl:canvas:object:property:render_parent|render_parent]]** //**(get)**// | %%Gets the parent smart object of a given Evas object, if it has one.%% |
399^ [[:develop:api:efl:container|Efl.Container]] ^^^
400| | **[[:develop:api:efl:container:method:content_count|content_count]]** | %%Returns the number of UI elements packed in this container.%% |
401| | **[[:develop:api:efl:container:method:content_iterate|content_iterate]]** | %%Begin iterating over this object's contents.%% |
402^ [[:develop:api:efl:file|Efl.File]] ^^^
403| | **[[:develop:api:efl:file:property:file|file]]** //**(get, set)**// | |
404| | **[[:develop:api:efl:file:method:save|save]]** | %%Save the given image object's contents to an (image) file.%% |
405^ [[:develop:api:efl:gfx:color|Efl.Gfx.Color]] ^^^
406| | **[[:develop:api:efl:gfx:color:property:color_class_code|color_class_code]]** //**(get, set)**// | |
407| | **[[:develop:api:efl:gfx:color:property:color_code|color_code]]** //**(get, set)**// | |
408^ [[:develop:api:efl:gfx:map|Efl.Gfx.Map]] ^^^
409| | **[[:develop:api:efl:gfx:map:method:lightning_3d|lightning_3d]]** | %%Apply a lighting effect on the object.%% |
410| | **[[:develop:api:efl:gfx:map:method:lightning_3d_absolute|lightning_3d_absolute]]** | %%Apply a lighting effect to the object.%% |
411| | **[[:develop:api:efl:gfx:map:property:map_alpha|map_alpha]]** //**(get, set)**// | %%Alpha flag for map rendering.%% |
412| | **[[:develop:api:efl:gfx:map:property:map_clockwise|map_clockwise]]** //**(get)**// | %%Clockwise state of a map (read-only).%% |
413| | **[[:develop:api:efl:gfx:map:property:map_color|map_color]]** //**(get, set)**// | %%Color of a vertex in the map.%% |
414| | **[[:develop:api:efl:gfx:map:property:map_coord_absolute|map_coord_absolute]]** //**(get, set)**// | %%A point's absolute coordinate on the canvas.%% |
415| | **[[:develop:api:efl:gfx:map:method:map_has|map_has]]** | %%Read-only property indicating whether an object is mapped.%% |
416| | **[[:develop:api:efl:gfx:map:property:map_point_count|map_point_count]]** //**(get, set)**// | %%Number of points of a map.%% |
417| | **[[:develop:api:efl:gfx:map:method:map_reset|map_reset]]** | %%Resets the map transformation to its default state.%% |
418| | **[[:develop:api:efl:gfx:map:property:map_smooth|map_smooth]]** //**(get, set)**// | %%Smoothing state for map rendering.%% |
419| | **[[:develop:api:efl:gfx:map:property:map_uv|map_uv]]** //**(get, set)**// | %%Map point's U and V texture source point.%% |
420| | **[[:develop:api:efl:gfx:map:method:perspective_3d|perspective_3d]]** | %%Apply a perspective transform to the map%% |
421| | **[[:develop:api:efl:gfx:map:method:perspective_3d_absolute|perspective_3d_absolute]]** | %%Apply a perspective transform to the map%% |
422| | **[[:develop:api:efl:gfx:map:method:rotate|rotate]]** | %%Apply a rotation to the object.%% |
423| | **[[:develop:api:efl:gfx:map:method:rotate_3d|rotate_3d]]** | %%Rotate the object around 3 axes in 3D.%% |
424| | **[[:develop:api:efl:gfx:map:method:rotate_3d_absolute|rotate_3d_absolute]]** | %%Rotate the object around 3 axes in 3D, using absolute coordinates.%% |
425| | **[[:develop:api:efl:gfx:map:method:rotate_absolute|rotate_absolute]]** | %%Apply a rotation to the object, using absolute coordinates.%% |
426| | **[[:develop:api:efl:gfx:map:method:rotate_quat|rotate_quat]]** | %%Rotate the object in 3D using a unit quaternion.%% |
427| | **[[:develop:api:efl:gfx:map:method:rotate_quat_absolute|rotate_quat_absolute]]** | %%Rotate the object in 3D using a unit quaternion, using absolute coordinates.%% |
428| | **[[:develop:api:efl:gfx:map:method:translate|translate]]** | %%Apply a translation to the object using map.%% |
429| | **[[:develop:api:efl:gfx:map:method:zoom|zoom]]** | %%Apply a zoom to the object.%% |
430| | **[[:develop:api:efl:gfx:map:method:zoom_absolute|zoom_absolute]]** | %%Apply a zoom to the object, using absolute coordinates.%% |
431^ [[:develop:api:efl:gfx:size:hint|Efl.Gfx.Size.Hint]] ^^^
432| | **[[:develop:api:efl:gfx:size:hint:property:hint_base|hint_base]]** //**(get, set)**// | %%Base size for objects with sizing restrictions.%% |
433| | **[[:develop:api:efl:gfx:size:hint:property:hint_step|hint_step]]** //**(get, set)**// | %%Step size for objects with sizing restrictions.%% |
434^ [[:develop:api:efl:object|Efl.Object]] ^^^
435| | **[[:develop:api:efl:object:property:allow_parent_unref|allow_parent_unref]]** //**(get, set)**// | %%Allow an object to be deleted by unref even if it has a parent.%% |
436| | **[[:develop:api:efl:object:method:children_iterator_new|children_iterator_new]]** | %%Get an iterator on all childrens%% |
437| | **[[:develop:api:efl:object:property:comment|comment]]** //**(get, set)**// | %%A human readable comment for the object%% |
438| | **[[:develop:api:efl:object:method:composite_attach|composite_attach]]** | %%Make an object a composite object of another.%% |
439| | **[[:develop:api:efl:object:method:composite_detach|composite_detach]]** | %%Detach a composite object from another object.%% |
440| | **[[:develop:api:efl:object:method:composite_part_is|composite_part_is]]** | %%Check if an object is part of a composite object.%% |
441| | **[[:develop:api:efl:object:method:event_callback_forwarder_add|event_callback_forwarder_add]]** | %%Add an event callback forwarder for an event and an object.%% |
442| | **[[:develop:api:efl:object:method:event_callback_forwarder_del|event_callback_forwarder_del]]** | %%Remove an event callback forwarder for an event and an object.%% |
443| | **[[:develop:api:efl:object:method:event_callback_stop|event_callback_stop]]** | %%Stop the current callback call.%% |
444| | **[[:develop:api:efl:object:method:event_freeze|event_freeze]]** | %%Freeze events of object.%% |
445| | **[[:develop:api:efl:object:property:event_freeze_count|event_freeze_count]]** //**(get)**// | %%Return freeze events of object.%% |
446| ''class'' | **[[:develop:api:efl:object:method:event_global_freeze|event_global_freeze]]** | %%Freeze events of object.%% |
447| ''class'' | **[[:develop:api:efl:object:property:event_global_freeze_count|event_global_freeze_count]]** //**(get)**// | %%Return freeze events of object.%% |
448| ''class'' | **[[:develop:api:efl:object:method:event_global_thaw|event_global_thaw]]** | %%Thaw events of object.%% |
449| | **[[:develop:api:efl:object:method:event_thaw|event_thaw]]** | %%Thaw events of object.%% |
450| | **[[:develop:api:efl:object:property:finalized|finalized]]** //**(get)**// | %%True if the object is already finalized, otherwise false.%% |
451| | **[[:develop:api:efl:object:property:name|name]]** //**(get, set)**// | %%The name of the object.%% |
452| | **[[:develop:api:efl:object:method:name_find|name_find]]** | %%Find a child object with the given name and return it.%% |
453| | **[[:develop:api:efl:object:property:parent|parent]]** //**(get, set)**// | %%The parent of an object.%% |
454^ [[:develop:api:efl:player|Efl.Player]] ^^^
455| | **[[:develop:api:efl:player:property:length|length]]** //**(get)**// | %%Get the length of play for the media file.%% |
456| | **[[:develop:api:efl:player:property:mute|mute]]** //**(get, set)**// | %%This property controls the audio mute state.%% |
457| | **[[:develop:api:efl:player:property:position|position]]** //**(get, set)**// | |
458| | **[[:develop:api:efl:player:property:progress|progress]]** //**(get)**// | %%Get how much of the file has been played.%% |
459| | **[[:develop:api:efl:player:property:seekable|seekable]]** //**(get)**// | %%Get whether the media file is seekable.%% |
460| | **[[:develop:api:efl:player:property:volume|volume]]** //**(get, set)**// | %%Control the audio volume.%% |
461^ [[:develop:api:efl:ui:base|Efl.Ui.Base]] ^^^
462| | **[[:develop:api:efl:ui:base:property:mirrored_automatic|mirrored_automatic]]** //**(get, set)**// | %%Whether the property %%[[:develop:api:efl:ui:base:property:mirrored|Efl.Ui.Base.mirrored]]%% should be set automatically.%% |
463
464===== Events =====
465
466==== Inherited ====
467
468^ [[:develop:api:efl:animator|Efl.Animator]] ^^^
469| | **[[:develop:api:efl:animator:event:animator_tick|animator,tick]]** | %%Animator tick synchronized with screen vsync if possible.%% |
470^ [[:develop:api:efl:container|Efl.Container]] ^^^
471| | **[[:develop:api:efl:container:event:content_added|content,added]]** | %%Sent after a new item was added.%% |
472| | **[[:develop:api:efl:container:event:content_removed|content,removed]]** | %%Sent after an item was removed, before unref.%% |
473^ [[:develop:api:efl:gfx|Efl.Gfx]] ^^^
474| | **[[:develop:api:efl:gfx:event:hide|hide]]** | %%Object just became invisible.%% |
475| | **[[:develop:api:efl:gfx:event:move|move]]** | %%Object was moved, its position during the event is the new one.%% |
476| | **[[:develop:api:efl:gfx:event:resize|resize]]** | %%Object was resized, its size during the event is the new one.%% |
477| | **[[:develop:api:efl:gfx:event:show|show]]** | %%Object just became visible.%% |
478^ [[:develop:api:efl:gfx:size:hint|Efl.Gfx.Size.Hint]] ^^^
479| | **[[:develop:api:efl:gfx:size:hint:event:change_size_hints|change,size,hints]]** | %%Object size hints changed.%% |
480^ [[:develop:api:efl:gfx:stack|Efl.Gfx.Stack]] ^^^
481| | **[[:develop:api:efl:gfx:stack:event:restack|restack]]** | %%Object stacking was changed.%% |
482^ [[:develop:api:efl:input:interface|Efl.Input.Interface]] ^^^
483| | **[[:develop:api:efl:input:interface:event:finger_down|finger,down]]** | %%Finger pressed (finger id is known).%% |
484| | **[[:develop:api:efl:input:interface:event:finger_move|finger,move]]** | %%Finger moved (current and previous positions are known).%% |
485| | **[[:develop:api:efl:input:interface:event:finger_up|finger,up]]** | %%Finger released (finger id is known).%% |
486| | **[[:develop:api:efl:input:interface:event:focus_in|focus,in]]** | %%A focus in event.%% |
487| | **[[:develop:api:efl:input:interface:event:focus_out|focus,out]]** | %%A focus out event.%% |
488| | **[[:develop:api:efl:input:interface:event:hold|hold]]** | %%All input events are on hold or resumed.%% |
489| | **[[:develop:api:efl:input:interface:event:key_down|key,down]]** | %%Keyboard key press.%% |
490| | **[[:develop:api:efl:input:interface:event:key_up|key,up]]** | %%Keyboard key release.%% |
491| | **[[:develop:api:efl:input:interface:event:pointer_axis|pointer,axis]]** | %%Pen or other axis event update.%% |
492| | **[[:develop:api:efl:input:interface:event:pointer_cancel|pointer,cancel]]** | %%Main pointer button press was cancelled (button id is known). This can happen in rare cases when the window manager passes the focus to a more urgent window, for instance. You probably don't need to listen to this event, as it will be accompanied by an up event.%% |
493| | **[[:develop:api:efl:input:interface:event:pointer_down|pointer,down]]** | %%Main pointer button pressed (button id is known).%% |
494| | **[[:develop:api:efl:input:interface:event:pointer_in|pointer,in]]** | %%Pointer entered a window or a widget.%% |
495| | **[[:develop:api:efl:input:interface:event:pointer_move|pointer,move]]** | %%Main pointer move (current and previous positions are known).%% |
496| | **[[:develop:api:efl:input:interface:event:pointer_out|pointer,out]]** | %%Pointer left a window or a widget.%% |
497| | **[[:develop:api:efl:input:interface:event:pointer_up|pointer,up]]** | %%Main pointer button released (button id is known).%% |
498| | **[[:develop:api:efl:input:interface:event:pointer_wheel|pointer,wheel]]** | %%Mouse wheel event.%% |
499^ [[:develop:api:efl:layout:calc|Efl.Layout.Calc]] ^^^
500| | **[[:develop:api:efl:layout:calc:event:circular_dependency|circular,dependency]]** | %%A circular dependency between parts of the object was found.%% |
501| | **[[:develop:api:efl:layout:calc:event:recalc|recalc]]** | %%The layout was recalculated.%% |
502^ [[:develop:api:efl:object|Efl.Object]] ^^^
503| | **[[:develop:api:efl:object:event:callback_add|callback,add]]** | %%A callback was added.%% |
504| | **[[:develop:api:efl:object:event:callback_del|callback,del]]** | %%A callback was deleted.%% |
505| | **[[:develop:api:efl:object:event:del|del]]** | %%Object is being deleted.%% |
506| | **[[:develop:api:efl:object:event:destruct|destruct]]** | %%Object has been fully destroyed. It can not be used beyond this point. This event should only serve to clean up any dangling pointer.%% |