summaryrefslogtreecommitdiff
path: root/src/lib/eo/efl_object.eo
diff options
context:
space:
mode:
authorAndy Williams <andy@andywilliams.me>2017-12-20 09:52:31 +0000
committerAndy Williams <andy@andywilliams.me>2017-12-20 09:52:31 +0000
commit5162d66c51ffd328473cd72c1372cb27a955f590 (patch)
tree2c26872b7d83d77bd4992cdb6422188424501783 /src/lib/eo/efl_object.eo
parente942dd6420bf83c6b1d987b19a882846e81c7d01 (diff)
eo: Update grammar and readability
Diffstat (limited to '')
-rw-r--r--src/lib/eo/efl_object.eo62
1 files changed, 31 insertions, 31 deletions
diff --git a/src/lib/eo/efl_object.eo b/src/lib/eo/efl_object.eo
index 1b7c0755bf..4366e550fa 100644
--- a/src/lib/eo/efl_object.eo
+++ b/src/lib/eo/efl_object.eo
@@ -5,7 +5,7 @@ struct Efl.Event.Description {
5 name: string; [[name of the event.]] 5 name: string; [[name of the event.]]
6 unfreezable: bool; [[$true if the event cannot be frozen.]] 6 unfreezable: bool; [[$true if the event cannot be frozen.]]
7 legacy_is: bool; [[Internal use: $true if a legacy event.]] 7 legacy_is: bool; [[Internal use: $true if a legacy event.]]
8 restart: bool; [[$true if when the event is triggered again from a callback, it should start from where it was]] 8 restart: bool; [[$true if when the event is triggered again from a callback it'll start from where it was]]
9} 9}
10 10
11abstract Efl.Object () 11abstract Efl.Object ()
@@ -17,18 +17,18 @@ abstract Efl.Object ()
17 @property parent { 17 @property parent {
18 [[The parent of an object. 18 [[The parent of an object.
19 19
20 Parents keep references to their children so in order to 20 Parents keep references to their children. In order to
21 delete objects that have parents you need to set parent to 21 delete objects which have parents you need to set parent to
22 NULL or use efl_del() that does that for you (and also unrefs 22 NULL or use efl_del(). This will both delete & unref
23 the object). 23 the object).
24 24
25 The Eo parent is conceptually user set. That means that a parent 25 The Eo parent is conceptually user set. That means that a parent
26 should not be changed behind the scenes in a surprising manner. 26 should not be changed behind the scenes in an unexpected way.
27 27
28 For example: 28 For example:
29 if you have a widget that has a box internally, and 29 If you have a widget that has a box internally and
30 when you swallow into that widget the object you swallow ends up in 30 when you 'swallow' a widget and the swallowed object ends up in
31 the box, the parent should be the widget, and not the box. 31 the box, the parent should be the widget, not the box.
32 ]] 32 ]]
33 33
34 set { 34 set {
@@ -45,18 +45,18 @@ abstract Efl.Object ()
45 Because efl_del() unrefs and reparents to NULL, it doesn't really delete the object. 45 Because efl_del() unrefs and reparents to NULL, it doesn't really delete the object.
46 46
47 This method accepts a const object for convenience, so all objects 47 This method accepts a const object for convenience, so all objects
48 could be passed to it easily. 48 can be passed to it easily.
49 ]] 49 ]]
50 } 50 }
51 @property name { 51 @property name {
52 [[ The name of the object. 52 [[ The name of the object.
53 53
54 Every object can have a string name. Names may not contain 54 Every object can have a string name. Names may not contain
55 the following charactors: 55 the following characters:
56 / ? * [ ] ! \ : 56 / ? * [ ] ! \ :
57 They are illegal. Using it in a name will result in undefined 57 Using any of these in a name will result in undefined
58 behavior later on. An empty string is considered the same as a 58 behavior later on. An empty string is considered the same as a
59 NULL string or no string for the name at all. 59 NULL string or no string for the name.
60 ]] 60 ]]
61 set { 61 set {
62 } 62 }
@@ -69,9 +69,9 @@ abstract Efl.Object ()
69 @property comment { 69 @property comment {
70 [[ A human readable comment for the object 70 [[ A human readable comment for the object
71 71
72 Every object can have a string comment intended for developers 72 Every object can have a string comment. This is intended for developers
73 and debugging. An empty string is considered the same as a NULL 73 and debugging. An empty string is considered the same as a NULL
74 string or no string for the comment at all. 74 string or no string for the comment.
75 ]] 75 ]]
76 set { 76 set {
77 } 77 }
@@ -91,7 +91,7 @@ abstract Efl.Object ()
91 efl_debug_name_override(efl_super(obj, MY_CLASS), sb); 91 efl_debug_name_override(efl_super(obj, MY_CLASS), sb);
92 eina_strbuf_append_printf(sb, "new_information"); 92 eina_strbuf_append_printf(sb, "new_information");
93 93
94 In general, more debug information should be added to $sb after 94 Usually more debug information should be added to $sb after
95 calling the super function. 95 calling the super function.
96 96
97 @since 1.21 97 @since 1.21
@@ -123,7 +123,7 @@ abstract Efl.Object ()
123 } 123 }
124 } 124 }
125 @property finalized { 125 @property finalized {
126 [[True if the object is already finalized, false otherwise.]] 126 [[True if the object is already finalized, otherwise false.]]
127 get { 127 get {
128 } 128 }
129 values { 129 values {
@@ -131,7 +131,7 @@ abstract Efl.Object ()
131 } 131 }
132 } 132 }
133 provider_find { 133 provider_find {
134 [[Searches up in the object tree for a provider which knows the given class/interface. 134 [[Searches upwards in the object tree for a provider which knows the given class/interface.
135 135
136 The object from the provider will then be returned. 136 The object from the provider will then be returned.
137 The base implementation calls the provider_find function on the object parent, 137 The base implementation calls the provider_find function on the object parent,
@@ -168,7 +168,7 @@ abstract Efl.Object ()
168 The search string can be a glob (shell style, using *). It can also 168 The search string can be a glob (shell style, using *). It can also
169 specify class name in the format of "class:name" where ":" 169 specify class name in the format of "class:name" where ":"
170 separates class and name. Both class and name can be globs. 170 separates class and name. Both class and name can be globs.
171 If class is specified, and name is empty like "class:" then 171 If the class is specified but the name is empty like "class:" then
172 the search will match any object of that class. 172 the search will match any object of that class.
173 ]] 173 ]]
174 params { 174 params {
@@ -179,25 +179,25 @@ abstract Efl.Object ()
179 event_thaw { 179 event_thaw {
180 [[Thaw events of object. 180 [[Thaw events of object.
181 181
182 Lets event callbacks be called for the object. 182 Allows event callbacks to be called for an object.
183 ]] 183 ]]
184 } 184 }
185 event_freeze { 185 event_freeze {
186 [[Freeze events of object. 186 [[Freeze events of object.
187 187
188 Prevents event callbacks from being called for the object. 188 Prevents event callbacks from being called for an object.
189 ]] 189 ]]
190 } 190 }
191 event_global_thaw @class { 191 event_global_thaw @class {
192 [[Thaw events of object. 192 [[Thaw events of object.
193 193
194 Lets event callbacks be called for the object. 194 Allows event callbacks be called for an object.
195 ]] 195 ]]
196 } 196 }
197 event_global_freeze @class { 197 event_global_freeze @class {
198 [[Freeze events of object. 198 [[Freeze events of object.
199 199
200 Prevents event callbacks from being called for the object. 200 Prevents event callbacks from being called for an object.
201 ]] 201 ]]
202 } 202 }
203 event_callback_stop { 203 event_callback_stop {
@@ -205,8 +205,8 @@ abstract Efl.Object ()
205 205
206 This stops the current callback call. Any other callbacks for the 206 This stops the current callback call. Any other callbacks for the
207 current event will not be called. This is useful when you want to 207 current event will not be called. This is useful when you want to
208 filter out events. You just add higher priority events and call this 208 filter out events. Just add higher priority events and call this
209 on certain conditions to block a certain event. 209 under certain conditions to block a certain event.
210 ]] 210 ]]
211 } 211 }
212 event_callback_forwarder_add { 212 event_callback_forwarder_add {
@@ -231,8 +231,8 @@ abstract Efl.Object ()
231 [[Make an object a composite object of another. 231 [[Make an object a composite object of another.
232 232
233 The class of comp_obj must be part of the extensions of the class of the parent. 233 The class of comp_obj must be part of the extensions of the class of the parent.
234 It is not possible to attach more then 1 composite of the same class. 234 It isn't possible to attach more then 1 composite of the same class.
235 This functions also sets the parent of comp_obj to parent. 235 This function also sets the parent of comp_obj to parent.
236 236
237 See @.composite_detach, @.composite_part_is. 237 See @.composite_detach, @.composite_part_is.
238 ]] 238 ]]
@@ -263,15 +263,15 @@ abstract Efl.Object ()
263 @property allow_parent_unref { 263 @property allow_parent_unref {
264 [[Allow an object to be deleted by unref even if it has a parent. 264 [[Allow an object to be deleted by unref even if it has a parent.
265 265
266 This simply hides error messages warning that an object being 266 This simply hides the error message warning that an object being
267 destructed still has a parent. This property is false by default. 267 destroyed still has a parent. This property is false by default.
268 268
269 In a normal object use case, when ownership of an object is given 269 In a normal object use case, when ownership of an object is given
270 to a caller, said ownership should be released with efl_unref(). But 270 to a caller, said ownership should be released with efl_unref().
271 if the object has a parent, this will print error messages, as 271 If the object has a parent, this will print error messages, as
272 $efl_unref() is stealing the ref from the parent. 272 $efl_unref() is stealing the ref from the parent.
273 273
274 Warning: Use this function very carefully, if you are absolutely 274 Warning: Use this function very carefully, unless you're absolutely
275 sure of what you are doing. 275 sure of what you are doing.
276 ]] 276 ]]
277 values { 277 values {