aboutsummaryrefslogtreecommitdiffstats
path: root/pages/develop/api/efl/canvas/method/pointer_iterate.txt
diff options
context:
space:
mode:
Diffstat (limited to 'pages/develop/api/efl/canvas/method/pointer_iterate.txt')
-rw-r--r--pages/develop/api/efl/canvas/method/pointer_iterate.txt28
1 files changed, 14 insertions, 14 deletions
diff --git a/pages/develop/api/efl/canvas/method/pointer_iterate.txt b/pages/develop/api/efl/canvas/method/pointer_iterate.txt
index 79f51cc78..627118aab 100644
--- a/pages/develop/api/efl/canvas/method/pointer_iterate.txt
+++ b/pages/develop/api/efl/canvas/method/pointer_iterate.txt
@@ -1,8 +1,21 @@
~~Title: Efl.Canvas.pointer_iterate~~
+===== Description =====
+
+%%Returns an iterator over the current known pointer positions.%%
+
+%%This is used to iterate over the current known multi-touch positions, including the first finger. Each pointer position is represented by an object of type %%[[:develop:api:efl:input:pointer|Efl.Input.Pointer]]%%.%%
+
+%%Each finger in a multi touch environment can then be identified by the %%[[:develop:api:efl:input:pointer:property:tool|Efl.Input.Pointer.tool]]%% property. The order of the pointers in this iterator is not defined.%%
+
+<note>
+%%If the input surface supports hovering input, some pointers may not be in a "down" state. To retrieve the list of such pointers, set the %%''hover''%% value to %%''true''%%. Remember though that most devices currently don't support this.%%
+</note>
+{{page>:develop:api-include:efl:canvas:method:pointer_iterate:description&nouser&nolink&nodate}}
+
===== Signature =====
<code>
-pointer_iterate @const @pure_virtual {
+pointer_iterate @beta @const @pure_virtual {
params {
@in hover: bool @optional;
}
@@ -20,19 +33,6 @@ Eina_Iterator *efl_canvas_pointer_iterate(const Eo *obj, Eina_Bool hover);
* **hover** //(in)// - %%%%''false''%% by default, %%''true''%% means to include fingers that are currently hovering.%%
-===== Description =====
-
-%%Returns an iterator over the current known pointer positions.%%
-
-%%This is used to iterate over the current known multi-touch positions, including the first finger. Each pointer position is represented by an object of type %%[[:develop:api:efl:input:pointer|Efl.Input.Pointer]]%%.%%
-
-%%Each finger in a multi touch environment can then be identified by the %%[[:develop:api:efl:input:pointer:property:tool|Efl.Input.Pointer.tool]]%% property. The order of the pointers in this iterator is not defined.%%
-
-<note>
-%%If the input surface supports hovering input, some pointers may not be in a "down" state. To retrieve the list of such pointers, set the %%''hover''%% value to %%''true''%%. Remember though that most devices currently don't support this.%%
-</note>
-{{page>:develop:api-include:efl:canvas:method:pointer_iterate:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* **Efl.Canvas.pointer_iterate**