summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorStefan Schmidt <stefan@osg.samsung.com>2016-06-30 17:31:56 +0200
committerStefan Schmidt <stefan@osg.samsung.com>2016-06-30 18:15:44 +0200
commitfca0105b0254b9f8ec4b76ae845e172c0bcaf681 (patch)
treeacc1e4323de38cf8e82b6935e7682fe0e75fc51b /src
parent740e438627cc96a16a76a9ed22aff4cf6e8c37e5 (diff)
atspi_component: improve existing documentation
Ad more descriptions, consolidate property descriptions and fix smaller problems.
Diffstat (limited to 'src')
-rw-r--r--src/lib/elementary/elm_interface_atspi_component.eo37
1 files changed, 20 insertions, 17 deletions
diff --git a/src/lib/elementary/elm_interface_atspi_component.eo b/src/lib/elementary/elm_interface_atspi_component.eo
index 00659a8..79f34d5 100644
--- a/src/lib/elementary/elm_interface_atspi_component.eo
+++ b/src/lib/elementary/elm_interface_atspi_component.eo
@@ -1,55 +1,56 @@
1mixin Elm.Interface.Atspi_Component () 1mixin Elm.Interface.Atspi_Component ()
2{ 2{
3 [[ATSPI component mixin]]
3 eo_prefix: elm_interface_atspi_component; 4 eo_prefix: elm_interface_atspi_component;
4 data: null; 5 data: null;
5 methods { 6 methods {
6 @property size @protected { 7 @property size @protected {
8 [[Size of accessible widget.]]
7 set { 9 set {
8 [[Sets size of accessible widget.]]
9 return: bool; 10 return: bool;
10 } 11 }
11 get { 12 get {
12 [[Gets size of accessible widget.]]
13 } 13 }
14 values { 14 values {
15 w: int; 15 w: int; [[Width of the widget]]
16 h: int; 16 h: int; [[Height of the widget]]
17 } 17 }
18 } 18 }
19 @property layer @protected { 19 @property layer @protected {
20 [[Evas layer of accessible widget.]]
20 get { 21 get {
21 [[Sets evas layer of accessible widget.]]
22 } 22 }
23 values { 23 values {
24 layer: int; 24 layer: int;
25 } 25 }
26 } 26 }
27 @property alpha @protected { 27 @property alpha @protected {
28 [[Gets alpha of accessible widget.]]
28 get { 29 get {
29 [[Gets alpha of accessible widget.]]
30 } 30 }
31 values { 31 values {
32 alpha: double; [[alpha value in [0, 1] range.]] 32 alpha: double; [[Alpha value in [0, 1] range.]]
33 } 33 }
34 } 34 }
35 @property z_order @protected { 35 @property z_order @protected {
36 [[Gets the depth at which the component is shown in relation to other
37 components in the same container.]]
36 get { 38 get {
37 [[Gets the depth at which the component is shown in relation to other components in the same container.]]
38 } 39 }
39 values { 40 values {
40 z_order: int; 41 z_order: int;
41 } 42 }
42 } 43 }
43 @property extents @protected { 44 @property extents @protected {
45 [[Geometry of accessible widget.]]
44 get { 46 get {
45 [[Gets geometry of accessible widget.]]
46 } 47 }
47 set { 48 set {
48 [[Sets geometry of accessible widget.]]
49 return: bool; 49 return: bool;
50 } 50 }
51 keys { 51 keys {
52 screen_coords: bool; [[If true x and y values will be relative to screen origin, otherwise relative to canvas]] 52 screen_coords: bool; [[If true x and y values will be relative to
53 screen origin, otherwise relative to canvas]]
53 } 54 }
54 values { 55 values {
55 x: int; 56 x: int;
@@ -59,15 +60,15 @@ mixin Elm.Interface.Atspi_Component ()
59 } 60 }
60 } 61 }
61 @property position @protected { 62 @property position @protected {
63 [[Position of accessible widget.]]
62 set { 64 set {
63 [[Sets position of accessible widget.]]
64 return: bool; 65 return: bool;
65 } 66 }
66 get { 67 get {
67 [[Gets position of accessible widget.]]
68 } 68 }
69 keys { 69 keys {
70 screen_coords: bool; [[If true x and y values will be relative to screen origin, otherwise relative to canvas]] 70 screen_coords: bool; [[If true x and y values will be relative to
71 screen origin, otherwise relative to canvas]]
71 } 72 }
72 values { 73 values {
73 x: int; 74 x: int;
@@ -76,7 +77,8 @@ mixin Elm.Interface.Atspi_Component ()
76 } 77 }
77 contains @protected { 78 contains @protected {
78 params { 79 params {
79 screen_coords: bool; [[If true x and y values will be relative to screen origin, otherwise relative to canvas]] 80 screen_coords: bool; [[If true x and y values will be relative to
81 screen origin, otherwise relative to canvas]]
80 @in x: int; 82 @in x: int;
81 @in y: int; 83 @in y: int;
82 } 84 }
@@ -85,13 +87,14 @@ mixin Elm.Interface.Atspi_Component ()
85 focus_grab @protected { 87 focus_grab @protected {
86 [[Focuses accessible widget.]] 88 [[Focuses accessible widget.]]
87 89
88 return: bool; [[true if focus grab focus has successed, false otherwise.]] 90 return: bool; [[$true if focus grab focus succeed, $false otherwise.]]
89 91
90 } 92 }
91 accessible_at_point_get @protected { 93 accessible_at_point_get @protected {
92 [[Gets top component object occupying space at given coordinates.]] 94 [[Gets top component object occupying space at given coordinates.]]
93 params { 95 params {
94 screen_coords: bool; [[If true x and y values will be relative to screen origin, otherwise relative to canvas]] 96 screen_coords: bool; [[If $true x and y values will be relative to
97 screen origin, otherwise relative to canvas]]
95 @in x: int; 98 @in x: int;
96 @in y: int; 99 @in y: int;
97 } 100 }