docs: atspi: add missing docs for atspi action interface

This commit is contained in:
Stefan Schmidt 2016-10-21 16:12:57 +02:00
parent 7493368e54
commit adca8765c0
1 changed files with 9 additions and 9 deletions

View File

@ -12,7 +12,7 @@ mixin Elm.Interface.Atspi_Action ()
name: string; [[Action name]] name: string; [[Action name]]
} }
keys { keys {
id: int; id: int; [[ID to get action name for]]
} }
} }
@property localized_name @protected { @property localized_name @protected {
@ -23,7 +23,7 @@ mixin Elm.Interface.Atspi_Action ()
name: string; [[Localized name]] name: string; [[Localized name]]
} }
keys { keys {
id: int; id: int; [[ID to get localized name for]]
} }
} }
@property description @protected @virtual_pure { @property description @protected @virtual_pure {
@ -31,13 +31,13 @@ mixin Elm.Interface.Atspi_Action ()
get { get {
} }
set { set {
return: bool; return: bool; [[EINA_TRUE if description was set, else EINA_FALSE]]
} }
values { values {
description: string; description: string; [[Action description]]
} }
keys { keys {
id: int; id: int; [[ID to set or get description for]]
} }
} }
@property actions @protected { @property actions @protected {
@ -45,20 +45,20 @@ mixin Elm.Interface.Atspi_Action ()
get @virtual_pure { get @virtual_pure {
} }
values { values {
actions: list<Elm_Atspi_Action>; [[contains statically allocated strings]] actions: list<Elm_Atspi_Action>; [[Contains statically allocated strings]]
} }
} }
action_do @protected @virtual_pure { action_do @protected @virtual_pure {
[[Performs action on given widget.]] [[Performs action on given widget.]]
params { params {
@in id: int; @in id: int; [[ID for widget]]
} }
return: bool; return: bool; [[EINA_TRUE if action was performed, else EINA_FALSE]]
} }
keybinding_get @protected @virtual_pure { keybinding_get @protected @virtual_pure {
[[Gets configured keybinding for specific action and widget.]] [[Gets configured keybinding for specific action and widget.]]
params { params {
@in id: int; @in id: int; [[ID for widget]]
} }
return: own(char *) @warn_unused; [[Should be freed by the user.]] return: own(char *) @warn_unused; [[Should be freed by the user.]]
} }