summaryrefslogtreecommitdiff
path: root/pages/develop/api/efl/gfx/stack
diff options
context:
space:
mode:
authorAndy Williams <andy@andywilliams.me>2017-12-11 16:59:35 +0000
committerAndy Williams <andy@andywilliams.me>2017-12-11 16:59:49 +0000
commit2782d0c642dcea66ee93d10fa12d78f130e66cdb (patch)
treebd3a7c81cff9903b042a11a1c30efc8760c617ff /pages/develop/api/efl/gfx/stack
parent7dd88611a2938001370bdbac9b72b4a25854a2d0 (diff)
Updated Unified API docs with latest generator
Diffstat (limited to 'pages/develop/api/efl/gfx/stack')
-rw-r--r--pages/develop/api/efl/gfx/stack/event/restack.txt39
-rw-r--r--pages/develop/api/efl/gfx/stack/layer/max.txt19
-rw-r--r--pages/develop/api/efl/gfx/stack/layer/min.txt19
-rw-r--r--pages/develop/api/efl/gfx/stack/method/lower.txt26
-rw-r--r--pages/develop/api/efl/gfx/stack/method/raise.txt26
-rw-r--r--pages/develop/api/efl/gfx/stack/method/stack_above.txt40
-rw-r--r--pages/develop/api/efl/gfx/stack/method/stack_below.txt40
-rw-r--r--pages/develop/api/efl/gfx/stack/property/above.txt31
-rw-r--r--pages/develop/api/efl/gfx/stack/property/below.txt31
-rw-r--r--pages/develop/api/efl/gfx/stack/property/layer.txt64
10 files changed, 335 insertions, 0 deletions
diff --git a/pages/develop/api/efl/gfx/stack/event/restack.txt b/pages/develop/api/efl/gfx/stack/event/restack.txt
new file mode 100644
index 0000000..f794ab3
--- /dev/null
+++ b/pages/develop/api/efl/gfx/stack/event/restack.txt
@@ -0,0 +1,39 @@
1~~Title: Efl.Gfx.Stack: restack~~
2===== Signature =====
3
4<code>
5restack;
6</code>
7
8===== C information =====
9
10<code c>
11EFL_GFX_EVENT_RESTACK(void)
12</code>
13
14===== C usage =====
15
16<code c>
17static void
18on_efl_gfx_event_restack(void *data, const Efl_Event *event)
19{
20 void info = event->info;
21 Eo *obj = event->object;
22 Data *d = data;
23
24 /* event hander code */
25}
26
27static void
28setup_event_handler(Eo *obj, Data *d)
29{
30 efl_event_callback_add(obj, EFL_GFX_EVENT_RESTACK, on_efl_gfx_event_restack, d);
31}
32
33</code>
34
35===== Description =====
36
37%%Object stacking was changed.%%
38{{page>:develop:api-include:efl:gfx:stack:event:restack:description&nouser&nolink&nodate}}
39
diff --git a/pages/develop/api/efl/gfx/stack/layer/max.txt b/pages/develop/api/efl/gfx/stack/layer/max.txt
new file mode 100644
index 0000000..537c298
--- /dev/null
+++ b/pages/develop/api/efl/gfx/stack/layer/max.txt
@@ -0,0 +1,19 @@
1~~Title: Efl.Gfx.Stack.Layer.Max~~
2===== Signature =====
3
4<code>
5const Efl.Gfx.Stack.Layer.Max: short = 32767;
6</code>
7
8===== C signature =====
9
10<code c>
11#define EFL_GFX_STACK_LAYER_MAX 32767
12</code>
13
14===== Description =====
15
16%%top-most layer number%%
17
18{{page>:develop:api-include:efl:gfx:stack:layer:max:description&nouser&nolink&nodate}}
19
diff --git a/pages/develop/api/efl/gfx/stack/layer/min.txt b/pages/develop/api/efl/gfx/stack/layer/min.txt
new file mode 100644
index 0000000..6ed3151
--- /dev/null
+++ b/pages/develop/api/efl/gfx/stack/layer/min.txt
@@ -0,0 +1,19 @@
1~~Title: Efl.Gfx.Stack.Layer.Min~~
2===== Signature =====
3
4<code>
5const Efl.Gfx.Stack.Layer.Min: short = +32768;
6</code>
7
8===== C signature =====
9
10<code c>
11#define EFL_GFX_STACK_LAYER_MIN -32768/* +32768 */
12</code>
13
14===== Description =====
15
16%%bottom-most layer number%%
17
18{{page>:develop:api-include:efl:gfx:stack:layer:min:description&nouser&nolink&nodate}}
19
diff --git a/pages/develop/api/efl/gfx/stack/method/lower.txt b/pages/develop/api/efl/gfx/stack/method/lower.txt
new file mode 100644
index 0000000..cc88a61
--- /dev/null
+++ b/pages/develop/api/efl/gfx/stack/method/lower.txt
@@ -0,0 +1,26 @@
1~~Title: Efl.Gfx.Stack.lower~~
2===== Signature =====
3
4<code>
5lower @pure_virtual {}
6</code>
7
8===== C signature =====
9
10<code c>
11void efl_gfx_stack_lower(Eo *obj);
12</code>
13
14===== Description =====
15
16%%Lower %%''obj''%% to the bottom of its layer.%%
17
18%%%%''obj''%% will, then, be the lowest one in the layer it belongs to. Objects on other layers won't get touched.%%
19
20%%See also %%[[:develop:api:interface:efl:gfx:stack:method:stack_above|Efl.Gfx.Stack.stack_above]]%%(), %%[[:develop:api:interface:efl:gfx:stack:method:stack_below|Efl.Gfx.Stack.stack_below]]%%() and %%[[:develop:api:interface:efl:gfx:stack:method:raise|Efl.Gfx.Stack.raise]]%%()%%
21{{page>:develop:api-include:efl:gfx:stack:method:lower:description&nouser&nolink&nodate}}
22
23===== Implemented by =====
24
25 * **Efl.Gfx.Stack.lower**
26
diff --git a/pages/develop/api/efl/gfx/stack/method/raise.txt b/pages/develop/api/efl/gfx/stack/method/raise.txt
new file mode 100644
index 0000000..f0a1878
--- /dev/null
+++ b/pages/develop/api/efl/gfx/stack/method/raise.txt
@@ -0,0 +1,26 @@
1~~Title: Efl.Gfx.Stack.raise~~
2===== Signature =====
3
4<code>
5raise @pure_virtual {}
6</code>
7
8===== C signature =====
9
10<code c>
11void efl_gfx_stack_raise(Eo *obj);
12</code>
13
14===== Description =====
15
16%%Raise %%''obj''%% to the top of its layer.%%
17
18%%%%''obj''%% will, then, be the highest one in the layer it belongs to. Object on other layers won't get touched.%%
19
20%%See also %%[[:develop:api:interface:efl:gfx:stack:method:stack_above|Efl.Gfx.Stack.stack_above]]%%(), %%[[:develop:api:interface:efl:gfx:stack:method:stack_below|Efl.Gfx.Stack.stack_below]]%%() and %%[[:develop:api:interface:efl:gfx:stack:method:lower|Efl.Gfx.Stack.lower]]%%()%%
21{{page>:develop:api-include:efl:gfx:stack:method:raise:description&nouser&nolink&nodate}}
22
23===== Implemented by =====
24
25 * **Efl.Gfx.Stack.raise**
26
diff --git a/pages/develop/api/efl/gfx/stack/method/stack_above.txt b/pages/develop/api/efl/gfx/stack/method/stack_above.txt
new file mode 100644
index 0000000..f933205
--- /dev/null
+++ b/pages/develop/api/efl/gfx/stack/method/stack_above.txt
@@ -0,0 +1,40 @@
1~~Title: Efl.Gfx.Stack.stack_above~~
2===== Signature =====
3
4<code>
5stack_above @pure_virtual {
6 params {
7 @in above: free(Efl.Gfx.Stack, efl_del) @nonull;
8 }
9}
10</code>
11
12===== C signature =====
13
14<code c>
15void efl_gfx_stack_above(Eo *obj, Efl_Gfx_Stack *above);
16</code>
17
18===== Parameters =====
19
20 * **above** //(in)// - %%The object above which to stack%%
21
22===== Description =====
23
24%%Stack %%''obj''%% immediately %%''above''%%%%
25
26%%Objects, in a given canvas, are stacked in the order they get added to it. This means that, if they overlap, the highest ones will cover the lowest ones, in that order. This function is a way to change the stacking order for the objects.%%
27
28%%This function is intended to be used with objects belonging to the same layer in a given canvas, otherwise it will fail (and accomplish nothing).%%
29
30%%If you have smart objects on your canvas and %%''obj''%% is a member of one of them, then %%''above''%% must also be a member of the same smart object.%%
31
32%%Similarly, if %%''obj''%% is not a member of a smart object, %%''above''%% must not be either.%%
33
34%%See also %%[[:develop:api:interface:efl:gfx:stack:property:layer|Efl.Gfx.Stack.layer.get]]%%(), %%[[:develop:api:interface:efl:gfx:stack:property:layer|Efl.Gfx.Stack.layer.set]]%%() and %%[[:develop:api:interface:efl:gfx:stack:method:stack_below|Efl.Gfx.Stack.stack_below]]%%()%%
35{{page>:develop:api-include:efl:gfx:stack:method:stack_above:description&nouser&nolink&nodate}}
36
37===== Implemented by =====
38
39 * **Efl.Gfx.Stack.stack_above**
40
diff --git a/pages/develop/api/efl/gfx/stack/method/stack_below.txt b/pages/develop/api/efl/gfx/stack/method/stack_below.txt
new file mode 100644
index 0000000..fcfb828
--- /dev/null
+++ b/pages/develop/api/efl/gfx/stack/method/stack_below.txt
@@ -0,0 +1,40 @@
1~~Title: Efl.Gfx.Stack.stack_below~~
2===== Signature =====
3
4<code>
5stack_below @pure_virtual {
6 params {
7 @in below: free(Efl.Gfx.Stack, efl_del) @nonull;
8 }
9}
10</code>
11
12===== C signature =====
13
14<code c>
15void efl_gfx_stack_below(Eo *obj, Efl_Gfx_Stack *below);
16</code>
17
18===== Parameters =====
19
20 * **below** //(in)// - %%The object below which to stack%%
21
22===== Description =====
23
24%%Stack %%''obj''%% immediately %%''below''%%%%
25
26%%Objects, in a given canvas, are stacked in the order they get added to it. This means that, if they overlap, the highest ones will cover the lowest ones, in that order. This function is a way to change the stacking order for the objects.%%
27
28%%This function is intended to be used with objects belonging to the same layer in a given canvas, otherwise it will fail (and accomplish nothing).%%
29
30%%If you have smart objects on your canvas and %%''obj''%% is a member of one of them, then %%''below''%% must also be a member of the same smart object.%%
31
32%%Similarly, if %%''obj''%% is not a member of a smart object, %%''below''%% must not be either.%%
33
34%%See also %%[[:develop:api:interface:efl:gfx:stack:property:layer|Efl.Gfx.Stack.layer.get]]%%(), %%[[:develop:api:interface:efl:gfx:stack:property:layer|Efl.Gfx.Stack.layer.set]]%%() and %%[[:develop:api:interface:efl:gfx:stack:method:stack_below|Efl.Gfx.Stack.stack_below]]%%()%%
35{{page>:develop:api-include:efl:gfx:stack:method:stack_below:description&nouser&nolink&nodate}}
36
37===== Implemented by =====
38
39 * **Efl.Gfx.Stack.stack_below**
40
diff --git a/pages/develop/api/efl/gfx/stack/property/above.txt b/pages/develop/api/efl/gfx/stack/property/above.txt
new file mode 100644
index 0000000..1491880
--- /dev/null
+++ b/pages/develop/api/efl/gfx/stack/property/above.txt
@@ -0,0 +1,31 @@
1~~Title: Efl.Gfx.Stack.above~~
2===== Signature =====
3
4<code>
5@property above @pure_virtual {
6 get {
7 return: free(Efl.Gfx.Stack, efl_del) @warn_unused;
8 }
9}
10</code>
11
12===== C signature =====
13
14<code c>
15Efl_Gfx_Stack *efl_gfx_stack_above_get(const Eo *obj);
16</code>
17
18===== Description =====
19
20%%Get the Evas object stacked right above %%''obj''%%%%
21
22%%This function will traverse layers in its search, if there are objects on layers above the one %%''obj''%% is placed at.%%
23
24%%See also %%[[:develop:api:interface:efl:gfx:stack:property:layer|Efl.Gfx.Stack.layer.get]]%%(), %%[[:develop:api:interface:efl:gfx:stack:property:layer|Efl.Gfx.Stack.layer.set]]%%() and %%[[:develop:api:interface:efl:gfx:stack:property:below|Efl.Gfx.Stack.below.get]]%%()%%
25
26{{page>:develop:api-include:efl:gfx:stack:property:above:description&nouser&nolink&nodate}}
27
28===== Implemented by =====
29
30 * **Efl.Gfx.Stack.above**
31
diff --git a/pages/develop/api/efl/gfx/stack/property/below.txt b/pages/develop/api/efl/gfx/stack/property/below.txt
new file mode 100644
index 0000000..d6958bc
--- /dev/null
+++ b/pages/develop/api/efl/gfx/stack/property/below.txt
@@ -0,0 +1,31 @@
1~~Title: Efl.Gfx.Stack.below~~
2===== Signature =====
3
4<code>
5@property below @pure_virtual {
6 get {
7 return: free(Efl.Gfx.Stack, efl_del) @warn_unused;
8 }
9}
10</code>
11
12===== C signature =====
13
14<code c>
15Efl_Gfx_Stack *efl_gfx_stack_below_get(const Eo *obj);
16</code>
17
18===== Description =====
19
20%%Get the Evas object stacked right below %%''obj''%%%%
21
22%%This function will traverse layers in its search, if there are objects on layers below the one %%''obj''%% is placed at.%%
23
24%%See also %%[[:develop:api:interface:efl:gfx:stack:property:layer|Efl.Gfx.Stack.layer.get]]%%(), %%[[:develop:api:interface:efl:gfx:stack:property:layer|Efl.Gfx.Stack.layer.set]]%%() and %%[[:develop:api:interface:efl:gfx:stack:property:below|Efl.Gfx.Stack.below.get]]%%()%%
25
26{{page>:develop:api-include:efl:gfx:stack:property:below:description&nouser&nolink&nodate}}
27
28===== Implemented by =====
29
30 * **Efl.Gfx.Stack.below**
31
diff --git a/pages/develop/api/efl/gfx/stack/property/layer.txt b/pages/develop/api/efl/gfx/stack/property/layer.txt
new file mode 100644
index 0000000..5279527
--- /dev/null
+++ b/pages/develop/api/efl/gfx/stack/property/layer.txt
@@ -0,0 +1,64 @@
1~~Title: Efl.Gfx.Stack.layer~~
2===== Signature =====
3
4<code>
5@property layer @pure_virtual {
6 get {
7 values {
8 l: short;
9 }
10 }
11 set {
12 values {
13 l: short;
14 }
15 }
16}
17</code>
18
19===== C signature =====
20
21<code c>
22short efl_gfx_stack_layer_get(const Eo *obj);
23void efl_gfx_stack_layer_set(Eo *obj, short l);
24</code>
25
26===== Values =====
27
28 * **l** - %%The number of the layer to place the object on. Must be between #EFL_GFX_STACK_LAYER_MIN and #EFL_GFX_STACK_LAYER_MAX.%%
29===== Description =====
30
31
32
33
34{{page>:develop:api-include:efl:gfx:stack:property:layer:description&nouser&nolink&nodate}}
35
36==== Getter ====
37
38%%Retrieves the layer of its canvas that the given object is part of.%%
39
40%%See also %%[[:develop:api:interface:efl:gfx:stack:property:layer|Efl.Gfx.Stack.layer.set]]%%()%%
41
42
43{{page>:develop:api-include:efl:gfx:stack:property:layer:getter_description&nouser&nolink&nodate}}
44
45==== Setter ====
46
47%%Sets the layer of its canvas that the given object will be part of.%%
48
49%%If you don't use this function, you'll be dealing with an unique layer of objects, the default one. Additional layers are handy when you don't want a set of objects to interfere with another set with regard to stacking. Two layers are completely disjoint in that matter.%%
50
51%%This is a low-level function, which you'd be using when something should be always on top, for example.%%
52
53<note warning>
54%%Be careful, it doesn't make sense to change the layer of smart objects' children. Smart objects have a layer of their own, which should contain all their children objects.%%
55</note>
56
57%%See also %%[[:develop:api:interface:efl:gfx:stack:property:layer|Efl.Gfx.Stack.layer.get]]%%()%%
58{{page>:develop:api-include:efl:gfx:stack:property:layer:getter_description&nouser&nolink&nodate}}
59
60
61===== Implemented by =====
62
63 * **Efl.Gfx.Stack.layer**
64