summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorStefan Schmidt <stefan@osg.samsung.com>2016-06-30 16:34:24 +0200
committerStefan Schmidt <stefan@osg.samsung.com>2016-06-30 18:15:43 +0200
commit6248d706061434239e545c57019e0649b5824378 (patch)
tree4d97df333fe8062724c60f7f50be55418abffe3c /src
parentab2e608239d0518241454bd7cb6abe3f680764c1 (diff)
atspi_accessible: improve existing documentation
Make sure we describe whole properties and not getters and setters only. Adding some more docs while being there.
Diffstat (limited to 'src')
-rw-r--r--src/lib/elementary/elm_interface_atspi_accessible.eo64
1 files changed, 30 insertions, 34 deletions
diff --git a/src/lib/elementary/elm_interface_atspi_accessible.eo b/src/lib/elementary/elm_interface_atspi_accessible.eo
index a1b89a1..eddcce6 100644
--- a/src/lib/elementary/elm_interface_atspi_accessible.eo
+++ b/src/lib/elementary/elm_interface_atspi_accessible.eo
@@ -232,38 +232,39 @@ type Elm.Atspi.Relation_Set: list<Elm.Atspi.Relation *>;
232 232
233mixin Elm.Interface.Atspi_Accessible () 233mixin Elm.Interface.Atspi_Accessible ()
234{ 234{
235 [[ATSPI accessible mixin]]
235 eo_prefix: elm_interface_atspi_accessible; 236 eo_prefix: elm_interface_atspi_accessible;
236 data: Elm_Interface_Atspi_Accessible_Data; 237 data: Elm_Interface_Atspi_Accessible_Data;
237 methods { 238 methods {
238 @property localized_role_name @protected { 239 @property localized_role_name @protected {
240 [[Gets an localized string describing ATSPI widget role name.]]
239 get { 241 get {
240 [[Gets an localized string describing ATSPI widget role name.]]
241 } 242 }
242 values { 243 values {
243 localized_name: string; 244 localized_name: string; [[Localized widget role name]]
244 } 245 }
245 } 246 }
246 @property name { 247 @property name {
248 [[String describing ATSPI widget role name. Should be free by a user.]]
247 get { 249 get {
248 [[Gets an string describing ATSPI widget role name. Should be free by a user.]]
249 } 250 }
250 set { 251 set {
251 } 252 }
252 values { 253 values {
253 name: char*; [[obj name]] 254 name: char*; [[Obj name]]
254 } 255 }
255 } 256 }
256 @property relation_set @protected { 257 @property relation_set @protected {
258 [[Gets an string describing ATSPI widget role name. Lists and elements Should be free by a user.]]
257 get { 259 get {
258 [[Gets an string describing ATSPI widget role name. Lists and elements Should be free by a user.]]
259 } 260 }
260 values { 261 values {
261 relations: Elm.Atspi.Relation_Set; 262 relations: Elm.Atspi.Relation_Set;
262 } 263 }
263 } 264 }
264 @property role { 265 @property role {
266 [[The role of the widget in ATSPI Accessibility domain.]]
265 get { 267 get {
266 [[Gets the role of the widget in ATSPI Accessibility domain.]]
267 } 268 }
268 set { 269 set {
269 } 270 }
@@ -272,62 +273,60 @@ mixin Elm.Interface.Atspi_Accessible ()
272 } 273 }
273 } 274 }
274 @property children @protected { 275 @property children @protected {
276 [[Gets widget's accessible children.]]
275 get { 277 get {
276 [[Gets widget's accessible children.]]
277 } 278 }
278 values { 279 values {
279 children: free(own(list<Elm.Interface.Atspi_Accessible>), eina_list_free); 280 children: free(own(list<Elm.Interface.Atspi_Accessible>), eina_list_free);
280 } 281 }
281 } 282 }
282 @property role_name @protected { 283 @property role_name @protected {
284 [[Gets human-readable string indentifying widget accessibility role.]]
283 get { 285 get {
284 [[Gets human-readable string indentifying widget accessibility role.]]
285 } 286 }
286 values { 287 values {
287 role_name: string; 288 role_name: string;
288 } 289 }
289 } 290 }
290 @property attributes @protected { 291 @property attributes @protected {
292 [[Gets key-value pairs indentifying widget extra attributes. Must be free by a user.]]
291 get { 293 get {
292 [[Gets key-value pairs indentifying widget extra attributes. Must be free by a user.]]
293 } 294 }
294 values { 295 values {
295 attributes: free(own(list<own(Elm.Atspi.Attribute *)>), elm_atspi_attributes_list_free); 296 attributes: free(own(list<own(Elm.Atspi.Attribute *)>), elm_atspi_attributes_list_free);
296 } 297 }
297 } 298 }
298 @property index_in_parent @protected { 299 @property index_in_parent @protected {
300 [[Gets index of the child in parent's children list.]]
299 get { 301 get {
300 [[Gets index of the child in parent's children list.]]
301 } 302 }
302 values { 303 values {
303 idx: int; 304 idx: int;
304 } 305 }
305 } 306 }
306 @property description { 307 @property description {
308 [[Widget contextual information.]]
307 get { 309 get {
308 [[Gets widget contextual information.]]
309 } 310 }
310 set { 311 set {
311 [[Sets contextual information about widget.]]
312 } 312 }
313 values { 313 values {
314 description: string; 314 description: string; [[Widget contextual information]]
315 } 315 }
316 } 316 }
317 @property parent { 317 @property parent {
318 [[Widget accessible parent.]]
318 get { 319 get {
319 [[Gets widget accessible parent.]]
320 } 320 }
321 set { 321 set {
322 [[Sets widget accessible parent.]]
323 } 322 }
324 values { 323 values {
325 parent: Elm.Interface.Atspi_Accessible; 324 parent: Elm.Interface.Atspi_Accessible;
326 } 325 }
327 } 326 }
328 @property state_set @protected { 327 @property state_set @protected {
328 [[Gets set describing widget accessible states.]]
329 get { 329 get {
330 [[Gets set describing widget accessible states.]]
331 } 330 }
332 values { 331 values {
333 states: Elm.Atspi.State_Set; 332 states: Elm.Atspi.State_Set;
@@ -355,35 +354,32 @@ mixin Elm.Interface.Atspi_Accessible ()
355 } 354 }
356 } 355 }
357 @property translation_domain { 356 @property translation_domain {
358 get { 357 [[Sets the translation domain of "name" and "description"
359 [[Gets the translation domain of "name" and "description" 358 properties.
360 properties.]]
361 }
362 set {
363 [[Sets the translation domain of "name" and "description"
364 properties.
365 359
366 Translation domain should be set if application wants to support i18n 360 Translation domain should be set if application wants to support i18n
367 for accessibily "name" and "description" properties. 361 for accessibily "name" and "description" properties.
368 362
369 When translation domain is set values of "name" and "description" 363 When translation domain is set values of "name" and "description"
370 properties will be translated with dgettext function using 364 properties will be translated with dgettext function using
371 current translation domain as "domainname" parameter. 365 current translation domain as "domainname" parameter.
372 366
373 It is application developer responsibility to ensure that 367 It is application developer responsibility to ensure that
374 translation files are loaded and binded to translation domain 368 translation files are loaded and binded to translation domain
375 when accessibility is enabled.]] 369 when accessibility is enabled.]]
370 get {
371 }
372 set {
376 } 373 }
377 values { 374 values {
378 domain: string; [[ translation domain ]] 375 domain: string; [[Translation domain]]
379 } 376 }
380 } 377 }
381 @property type { 378 @property type {
379 [[Type of accessibility object]]
382 get { 380 get {
383 [[Get type of accessibility object]]
384 } 381 }
385 set { 382 set {
386 [[Set type of accessibility object]]
387 } 383 }
388 values { 384 values {
389 type: Elm.Atspi.Type; 385 type: Elm.Atspi.Type;