summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Hacohen <tom@stosb.com>2015-08-07 14:25:45 +0100
committerTom Hacohen <tom@stosb.com>2015-08-07 14:31:03 +0100
commit0da82773de41332f875216897b71aeaaa5d9f39d (patch)
tree9ebf004dac5352dd12147ccefb96a3b44c9a504c
parentc026c7aafe7ed2a8cb538cdd4a65b385be670ea1 (diff)
Interface atspi text: migrate docs.
-rw-r--r--src/lib/elm_interface_atspi_text.eo54
1 files changed, 20 insertions, 34 deletions
diff --git a/src/lib/elm_interface_atspi_text.eo b/src/lib/elm_interface_atspi_text.eo
index 7191509ca..f5a7e589f 100644
--- a/src/lib/elm_interface_atspi_text.eo
+++ b/src/lib/elm_interface_atspi_text.eo
@@ -5,56 +5,46 @@ interface Elm_Interface_Atspi_Text ()
5 methods { 5 methods {
6 @property character @protected { 6 @property character @protected {
7 get { 7 get {
8 /*@ Gets single character present in accessible widget's text 8 [[Gets single character present in accessible widget's text at given offset.]]
9 at given offset. */
10 } 9 }
11 keys { 10 keys {
12 offset: int; /*@ Position in text. */ 11 offset: int; [[Position in text.]]
13 } 12 }
14 values { 13 values {
15 character: Eina_Unicode; /*@ Character at offset. 0 when out-of 14 character: Eina_Unicode; [[Character at offset. 0 when out-of bounds offset has been given. Codepoints between DC80 and DCFF indicates that string includes invalid UTF8 chars.]]
16 bounds offset has been given.
17 Codepoints between DC80 and DCFF indicates
18 that string includes invalid UTF8 chars. */
19 } 15 }
20 } 16 }
21 @property string @protected { 17 @property string @protected {
22 get { 18 get {
23 /*@ Gets string, start and end offset in text according to 19 [[Gets string, start and end offset in text according to given initial offset and granulatity.]]
24 given initial offset and granulatity. */
25 } 20 }
26 keys { 21 keys {
27 granularity: Elm_Atspi_Text_Granularity; 22 granularity: Elm_Atspi_Text_Granularity;
28 start_offset: int * @nonull; /*@ Offset indicating start of string 23 start_offset: int * @nonull; [[Offset indicating start of string according to given granularity. -1 in case of error.]]
29 according to given granularity. 24 end_offset: int *; [[Offset indicating end of string according to given granularity. -1 in case of error.]]
30 -1 in case of error. */
31 end_offset: int *; /*@ Offset indicating end of string according
32 to given granularity. -1 in case of error. */
33 } 25 }
34 values { 26 values {
35 string: own(char *); /*@ Newly allocated UTF-8 encoded string. 27 string: own(char *); [[Newly allocated UTF-8 encoded string. Must be free by a user.]]
36 Must be free by a user. */
37 } 28 }
38 } 29 }
39 @property text @protected { 30 @property text @protected {
40 get { 31 get {
41 /*@ Gets text of accessible widget. */ 32 [[Gets text of accessible widget.]]
42 } 33 }
43 keys { 34 keys {
44 start_offset: int; /*@ Position in text. */ 35 start_offset: int; [[Position in text.]]
45 end_offset: int; /*@ End offset of text. */ 36 end_offset: int; [[End offset of text.]]
46 } 37 }
47 values { 38 values {
48 text: own(char *); /*@ UTF-8 encoded text. */ 39 text: own(char *); [[UTF-8 encoded text.]]
49 } 40 }
50 } 41 }
51 @property caret_offset @protected { 42 @property caret_offset @protected {
52 get { 43 get {
53 /*@ Gets offset position of caret (cursor) */ 44 [[Gets offset position of caret (cursor)]]
54 } 45 }
55 set { 46 set {
56 return: bool; /*@ true if caret was successfully moved, 47 return: bool; [[$true if caret was successfully moved, $falseotherwise.]]
57 EINA_FASLE otherwise. */
58 } 48 }
59 values { 49 values {
60 offset: int; 50 offset: int;
@@ -62,23 +52,21 @@ interface Elm_Interface_Atspi_Text ()
62 } 52 }
63 @property attribute @protected { 53 @property attribute @protected {
64 get { 54 get {
65 /*@ Indicate if a text attribute with a given name is set */ 55 [[Indicate if a text attribute with a given name is set]]
66 return: bool; 56 return: bool;
67 } 57 }
68 keys { 58 keys {
69 name: const(char)* @nonull; /*@ text attribute name */ 59 name: const(char)* @nonull; [[text attribute name]]
70 start_offset: int * @nonull; /*@ Position in text from which 60 start_offset: int * @nonull; [[Position in text from which given attribute is set.]]
71 given attribute is set. */ 61 end_offset: int *; [[Position in text to which given attribute is set.]]
72 end_offset: int *; /*@ Position in text to which given attribute
73 is set. */
74 } 62 }
75 values { 63 values {
76 value: own(char *); /*@ Value of text attribute. Should be free() */ 64 value: own(char *); [[Value of text attribute. Should be free()]]
77 } 65 }
78 } 66 }
79 @property attributes @protected { 67 @property attributes @protected {
80 get { 68 get {
81 /*@ Gets list of all text attributes. */ 69 [[Gets list of all text attributes.]]
82 } 70 }
83 keys { 71 keys {
84 start_offset: int * @nonull; 72 start_offset: int * @nonull;
@@ -144,9 +132,7 @@ interface Elm_Interface_Atspi_Text ()
144 return: bool; 132 return: bool;
145 } 133 }
146 keys { 134 keys {
147 screen_coords: bool; /*@ If true x and y values will be relative 135 screen_coords: bool; [[If true x and y values will be relative to screen origin, otherwise relative to canvas]]
148 to screen origin, otherwise relative to
149 canvas */
150 start_offset: int; 136 start_offset: int;
151 end_offset: int; 137 end_offset: int;
152 } 138 }