aboutsummaryrefslogtreecommitdiffstats
path: root/pages/develop/api/efl/canvas/object/method/key_grab.txt
diff options
context:
space:
mode:
Diffstat (limited to 'pages/develop/api/efl/canvas/object/method/key_grab.txt')
-rw-r--r--pages/develop/api/efl/canvas/object/method/key_grab.txt38
1 files changed, 19 insertions, 19 deletions
diff --git a/pages/develop/api/efl/canvas/object/method/key_grab.txt b/pages/develop/api/efl/canvas/object/method/key_grab.txt
index 367f07c7b..96dd08646 100644
--- a/pages/develop/api/efl/canvas/object/method/key_grab.txt
+++ b/pages/develop/api/efl/canvas/object/method/key_grab.txt
@@ -1,4 +1,23 @@
~~Title: Efl.Canvas.Object.key_grab~~
+===== Description =====
+
+%%Requests %%''keyname''%% key events be directed to %%''obj''%%.%%
+
+%%Key grabs allow one or more objects to receive key events for specific key strokes even if other objects have focus. Whenever a key is grabbed, only the objects grabbing it will get the events for the given keys.%%
+
+%%%%''keyname''%% is a platform dependent symbolic name for the key pressed (see @ref Evas_Keys for more information).%%
+
+%%%%''modifiers''%% and %%''not_modifiers''%% are bit masks of all the modifiers that must and mustn't, respectively, be pressed along with %%''keyname''%% key in order to trigger this new key grab. Modifiers can be things such as Shift and Ctrl as well as user defined types via @ref evas_key_modifier_add. Retrieve them with @ref evas_key_modifier_mask_get or use 0 for empty masks.%%
+
+%%%%''exclusive''%% will make the given object the only one permitted to grab the given key. If given %%''true''%%, subsequent calls on this function with different %%''obj''%% arguments will fail, unless the key is ungrabbed again.%%
+
+<note warning>
+%%Providing impossible modifier sets creates undefined behavior.%%
+</note>
+
+%%See also %%[[:develop:api:efl:canvas:object:method:key_ungrab|Efl.Canvas.Object.key_ungrab]]%%, %%[[:develop:api:efl:canvas:object:property:key_focus|Efl.Canvas.Object.key_focus.get]]%%, %%[[:develop:api:efl:canvas:object:property:key_focus|Efl.Canvas.Object.key_focus.set]]%%, @ref evas_focus_get, @ref evas_key_modifier_add.%%
+{{page>:develop:api-include:efl:canvas:object:method:key_grab:description&nouser&nolink&nodate}}
+
===== Signature =====
<code>
@@ -26,25 +45,6 @@ Eina_Bool efl_canvas_object_key_grab(Eo *obj, const char *keyname, Efl_Input_Mod
* **not_modifiers** //(in)// - %%A combinaison of modifier keys that must not be present to trigger the event.%%
* **exclusive** //(in)// - %%Request that the %%''obj''%% is the only object receiving the %%''keyname''%% events.%%
-===== Description =====
-
-%%Requests %%''keyname''%% key events be directed to %%''obj''%%.%%
-
-%%Key grabs allow one or more objects to receive key events for specific key strokes even if other objects have focus. Whenever a key is grabbed, only the objects grabbing it will get the events for the given keys.%%
-
-%%%%''keyname''%% is a platform dependent symbolic name for the key pressed (see @ref Evas_Keys for more information).%%
-
-%%%%''modifiers''%% and %%''not_modifiers''%% are bit masks of all the modifiers that must and mustn't, respectively, be pressed along with %%''keyname''%% key in order to trigger this new key grab. Modifiers can be things such as Shift and Ctrl as well as user defined types via @ref evas_key_modifier_add. Retrieve them with @ref evas_key_modifier_mask_get or use 0 for empty masks.%%
-
-%%%%''exclusive''%% will make the given object the only one permitted to grab the given key. If given %%''true''%%, subsequent calls on this function with different %%''obj''%% arguments will fail, unless the key is ungrabbed again.%%
-
-<note warning>
-%%Providing impossible modifier sets creates undefined behavior.%%
-</note>
-
-%%See also %%[[:develop:api:efl:canvas:object:method:key_ungrab|Efl.Canvas.Object.key_ungrab]]%%, %%[[:develop:api:efl:canvas:object:property:key_focus|Efl.Canvas.Object.key_focus.get]]%%, %%[[:develop:api:efl:canvas:object:property:key_focus|Efl.Canvas.Object.key_focus.set]]%%, @ref evas_focus_get, @ref evas_key_modifier_add.%%
-{{page>:develop:api-include:efl:canvas:object:method:key_grab:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* **Efl.Canvas.Object.key_grab**