enlightenment/efl
enlightenment
/
efl
8
7
Fork 15
Code Issues 12 Pull Requests 1 Projects Releases Wiki Activity

docs: efl_input: add missing docs for efl input pointer

This commit is contained in:
Stefan Schmidt 2016-11-07 12:07:28 +01:00
parent 55ee0d8fe8
commit 095c8d2484
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
src/lib/evas/canvas/efl_input_pointer.eo
View File

@ -11,17 +11,17 @@ class Efl.Input.Pointer (Efl.Object, Efl.Input.Event, Efl.Input.State)
@property action { @property action {
[[The action represented by this event.]] [[The action represented by this event.]]
values { values {
act: Efl.Pointer.Action; act: Efl.Pointer.Action; [[Event action]]
} }
} }
@property value_has { @property value_has {
[[$true if this event carries a valid value for the specified $key.]] [[$true if this event carries a valid value for the specified $key.]]
get {} get {}
keys { keys {
key: Efl.Input.Value; key: Efl.Input.Value; [[Pressed $key]]
} }
values { values {
has: bool; has: bool; [[$true if input value is valid, $false otherwise]]
} }
} }
@property value { @property value {
@ -41,10 +41,10 @@ class Efl.Input.Pointer (Efl.Object, Efl.Input.Event, Efl.Input.State)
} }
get {} get {}
keys { keys {
key: Efl.Input.Value; key: Efl.Input.Value; [[$key]]
} }
values { values {
val: double; val: double; [[$key value]]
} }
} }
@property button { @property button {
@ -61,10 +61,10 @@ class Efl.Input.Pointer (Efl.Object, Efl.Input.Event, Efl.Input.State)
Valid if and only if @.value_has($button_pressed) is $true.]] Valid if and only if @.value_has($button_pressed) is $true.]]
keys { keys {
button: int; button: int; [[1 to 32, 0 if not a button event.]]
} }
values { values {
pressed: bool; pressed: bool; [[$true when the button was pressed, $false otherwise]]
} }
} }
@property position { @property position {
@ -76,8 +76,8 @@ class Efl.Input.Pointer (Efl.Object, Efl.Input.Event, Efl.Input.State)
if you need precise coordinates. if you need precise coordinates.
]] ]]
values { values {
x: int; x: int; [[X coordinate of the event]]
y: int; y: int; [[Y coordinate of the event]]
} }
} }
@property previous_position { @property previous_position {
@ -91,8 +91,8 @@ class Efl.Input.Pointer (Efl.Object, Efl.Input.Event, Efl.Input.State)
but prefer the generic interface if you need precise coordinates. but prefer the generic interface if you need precise coordinates.
]] ]]
values { values {
x: int; x: int; [[X coordinate of the previous event]]
y: int; y: int; [[Y coordinate of the previous event]]
} }
} }
@property delta { @property delta {
@ -105,14 +105,14 @@ class Efl.Input.Pointer (Efl.Object, Efl.Input.Event, Efl.Input.State)
]] ]]
get {} get {}
values { values {
dx: int; dx: int; [[X coordinate delta]]
dy: int; dy: int; [[Y coordinate delta]]
} }
} }
@property tool { @property tool {
[[ID of the tool (eg. pen) that triggered this event.]] [[ID of the tool (eg. pen) that triggered this event.]]
values { values {
id: int; id: int; [[Tool ID]]
} }
} }
@property source { @property source {
@ -126,7 +126,7 @@ class Efl.Input.Pointer (Efl.Object, Efl.Input.Event, Efl.Input.State)
@property button_flags { @property button_flags {
[[Double or triple click information.]] [[Double or triple click information.]]
values { values {
flags: Efl.Pointer.Flags; flags: Efl.Pointer.Flags; [[Button information flags]]
} }
} }
@property double_click { @property double_click {
@ -135,7 +135,7 @@ class Efl.Input.Pointer (Efl.Object, Efl.Input.Event, Efl.Input.State)
This is just a helper function around @.button_flags. This is just a helper function around @.button_flags.
]] ]]
values { values {
val: bool; val: bool; [[$true if the button press was a double click, $false otherwise]]
} }
} }
@property triple_click { @property triple_click {
@ -144,7 +144,7 @@ class Efl.Input.Pointer (Efl.Object, Efl.Input.Event, Efl.Input.State)
This is just a helper function around @.button_flags. This is just a helper function around @.button_flags.
]] ]]
values { values {
val: bool; val: bool; [[$true if the button press was a triple click, $false otherwise]]
} }
} }
@property wheel_direction { @property wheel_direction {
@ -156,7 +156,7 @@ class Efl.Input.Pointer (Efl.Object, Efl.Input.Event, Efl.Input.State)
@property wheel_delta { @property wheel_delta {
[[Delta movement of the wheel in discrete steps.]] [[Delta movement of the wheel in discrete steps.]]
values { values {
dist: int; dist: int; [[Wheel movement delta]]
} }
} }
} }