enlightenment/www-content
enlightenment
/
www-content
6
0
Fork 2
Code Issues Pull Requests Projects Releases Wiki Activity

Update C API reference guide to 1.23 

Generated with edocgen.lua from efl.git branch efl-1.23
This commit is contained in:
Xavi Artigas 2019-11-29 12:02:18 +01:00
parent a5b73ce568
commit 005b875e15
7351 changed files with 114146 additions and 161273 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

126
pages/develop/api/efl/accelerate_interpolator.txt Normal file
View File

@ -0,0 +1,126 @@
~~Title: Efl.Accelerate_Interpolator~~
====== Efl.Accelerate_Interpolator (class) ======
''beta'' This class is still in beta, api will probably change
%%Efl accelerate interpolator class%%
%%output = 1 - sin(Pi / 2 + input * Pi / 2);%%
{{page>:develop:api-include:efl:efl.accelerate_interpolator:{section}&nouser&nolink&nodate}}
===== Inheritance =====
=> [[:develop:api:efl:object|Efl.Object]]
++++ Full hierarchy |
* [[:develop:api:efl:interpolator|Efl.Interpolator]] //(interface)//
++++
===== Properties =====
{{anchor:factor}}
**[[:develop:api:efl:Accelerate_Interpolator#factor|factor]]** (double) ''rw'' \\
> %%Factor property%% //Since None//
++++ more... |
^ values ^ type ^ description ^
|**factor**|[[:develop:api:double|double]]|%%Factor of the interpolation function.%%|
++++
===== Methods =====
{{anchor:constructor}}
**[[:develop:api:efl:Object#constructor|constructor]]** () => //Object// //[Overridden from [[:develop:api:efl:object|Efl.Object]]]// \\
> %%Implement this method to provide optional initialization code for your object.%% //Since 1.22//
++++ more... |
%%See the Life Cycle section in this class' description.%%
**This function does not accept any parameter.**
^ return ^ description ^
|**[[:develop:api:efl:Object|Efl.Object]]**|%%The new object, can be %%''NULL''%% if aborted.%% |
++++
{{anchor:interpolate}}
**[[:develop:api:efl:Interpolator#interpolate|interpolate]]** (//double// ''in'' **progress**) => //double// //[Overridden from [[:develop:api:efl:interpolator|Efl.Interpolator]]]// \\
> %%Interpolate the given value.%% //Since None//
++++ more... |
^ parameters ^ type ^ description ^
| ''in'' **progress**|[[:develop:api:double|double]] |%%Input value mapped from 0.0 to 1.0.%% |
^ return ^ description ^
|**[[:develop:api:double|double]]**|%%Output value calculated by interpolating the input value.%% |
++++
===== Inherited members =====
^ [[:develop:api:efl:object|Efl.Object]] //(class)//^^^
| | **[[:develop:api:efl:Object#parent|parent]]** | %%The parent of an object.%% |
| | **[[:develop:api:efl:Object#name|name]]** | %%The name of the object.%% |
| | **[[:develop:api:efl:Object#comment|comment]]** | %%A human readable comment for the object.%% |
| | **[[:develop:api:efl:Object#debug_name_override|debug_name_override]]** | %%Build a read-only name for this object used for debugging.%% |
| ''static method'' | **[[:develop:api:efl:Object#event_global_freeze_count|event_global_freeze_count]]** | |
| | **[[:develop:api:efl:Object#event_freeze_count|event_freeze_count]]** | |
| | **[[:develop:api:efl:Object#finalized|finalized]]** | |
| | **[[:develop:api:efl:Object#invalidated|invalidated]]** | |
| | **[[:develop:api:efl:Object#invalidating|invalidating]]** | |
| | **[[:develop:api:efl:Object#provider_find|provider_find]]** | %%Searches upwards in the object tree for a provider which knows the given class/interface.%% |
| | **[[:develop:api:efl:Object#constructor|constructor]]** | %%Implement this method to provide optional initialization code for your object.%% |
| | **[[:develop:api:efl:Object#destructor|destructor]]** | %%Implement this method to provide deinitialization code for your object if you need it.%% |
| | **[[:develop:api:efl:Object#finalize|finalize]]** | %%Implement this method to finish the initialization of your object after all (if any) user-provided configuration methods have been executed.%% |
| | **[[:develop:api:efl:Object#invalidate|invalidate]]** | %%Implement this method to perform special actions when your object loses its parent, if you need to.%% |
| | **[[:develop:api:efl:Object#name_find|name_find]]** | %%Find a child object with the given name and return it.%% |
| | **[[:develop:api:efl:Object#event_thaw|event_thaw]]** | %%Thaw events of object.%% |
| | **[[:develop:api:efl:Object#event_freeze|event_freeze]]** | %%Freeze events of this object.%% |
| ''static method'' | **[[:develop:api:efl:Object#event_global_thaw|event_global_thaw]]** | %%Globally thaw events for ALL EFL OBJECTS.%% |
| ''static method'' | **[[:develop:api:efl:Object#event_global_freeze|event_global_freeze]]** | %%Globally freeze events for ALL EFL OBJECTS.%% |
| | **[[:develop:api:efl:Object#event_callback_stop|event_callback_stop]]** | %%Stop the current callback call.%% |
| | **[[:develop:api:efl:Object#event_callback_forwarder_priority_add|event_callback_forwarder_priority_add]]** | %%Add an event callback forwarder that will make this object emit an event whenever another object (%%''source''%%) emits it. The event is said to be forwarded from %%''source''%% to this object.%% |
| | **[[:develop:api:efl:Object#event_callback_forwarder_del|event_callback_forwarder_del]]** | %%Remove an event callback forwarder for a specified event and object.%% |
| | **[[:develop:api:efl:Object#children_iterator_new|children_iterator_new]]** | %%Get an iterator on all children.%% |
| | **[[:develop:api:efl:Object#composite_attach|composite_attach]]** | %%Make an object a composite object of another.%% |
| | **[[:develop:api:efl:Object#composite_detach|composite_detach]]** | %%Detach a composite object from another object.%% |
| | **[[:develop:api:efl:Object#composite_part_is|composite_part_is]]** | %%Check if an object is part of a composite object.%% |
| | **[[:develop:api:efl:Object#allow_parent_unref|allow_parent_unref]]** | %%Allow an object to be deleted by unref even if it has a parent.%% |
| | **[[:develop:api:efl:Object#provider_register|provider_register]]** | %%Will register a manager of a specific class to be answered by %%[[:develop:api:efl:object|Efl.Object]].[[:develop:api:efl:Object#provider_find|provider_find]]%%.%% |
| | **[[:develop:api:efl:Object#provider_unregister|provider_unregister]]** | %%Will unregister a manager of a specific class that was previously registered and answered by %%[[:develop:api:efl:object|Efl.Object]].[[:develop:api:efl:Object#provider_find|provider_find]]%%.%% |
^ [[:develop:api:efl:interpolator|Efl.Interpolator]] //(interface)//^^^
| | **[[:develop:api:efl:Interpolator#interpolate|interpolate]]** | %%Interpolate the given value.%% |
===== Events =====
^ Inherited from [[:develop:api:efl:object|Efl.Object]] //(class)// ^^ event info ^
| ''del'' | %%Object is being deleted. See %%[[:develop:api:efl:object|Efl.Object]].[[:develop:api:efl:Object#destructor|destructor]]%%.%% ''hot'' | None |
| ''invalidate'' | %%Object is being invalidated and losing its parent. See %%[[:develop:api:efl:object|Efl.Object]].[[:develop:api:efl:Object#invalidate|invalidate]]%%.%% ''hot'' | None |
| ''noref'' | %%Object has lost its last reference, only parent relationship is keeping it alive. Advanced usage.%% ''hot'' | None |
| ''ownership,unique'' | %%Object has lost a reference and only one is left. It has just one owner now. Triggered whenever the refcount goes from two to one.%% ''hot'' | None |
| ''ownership,shared'' | %%Object has acquired a second reference. It has multiple owners now. Triggered whenever increasing the refcount from one to two, it will not trigger by further increasing the refcount beyond two.%% ''hot'' | None |
| ''destruct'' | %%Object has been fully destroyed. It can not be used beyond this point. This event should only serve to clean up any reference you keep to the object.%% ''hot'' | None |

250
pages/develop/api/efl/access.txt
View File

@ -1,250 +0,0 @@
~~Title: Efl.Access~~
====== Efl.Access (mixin) ======
===== Description =====
%%Accessibility accessible mixin%%
{{page>:develop:api-include:efl:access:description&nouser&nolink&nodate}}
===== Inheritance =====
=> [[:develop:api:efl:interface|Efl.Interface]] //(interface)//
++++ Full hierarchy |
* [[:develop:api:efl:interface|Efl.Interface]] //(interface)//
* [[:develop:api:efl:object|Efl.Object]] //(class)//
++++
===== Members =====
**[[:develop:api:efl:access:method:attribute_append|attribute_append]]**\\
> %%Add key-value pair identifying object extra attributes%%
<code c>
void efl_access_attribute_append(Eo *obj, const char *key, const char *value);
</code>
\\
**[[:develop:api:efl:access:method:attributes_clear|attributes_clear]]**\\
> %%Removes all attributes in accessible object.%%
<code c>
void efl_access_attributes_clear(Eo *obj);
</code>
\\
**[[:develop:api:efl:access:property:description|description]]** //**(get, set)**//\\
> %%Contextual information about object.%%
<code c>
const char *efl_access_description_get(const Eo *obj);
void efl_access_description_set(Eo *obj, const char *description);
</code>
\\
**[[:develop:api:efl:access:method:destructor|destructor]]**// [Overridden from [[:develop:api:efl:object|Efl.Object]]]//\\
> %%Call the object's destructor.%%
<code c>
void efl_destructor(Eo *obj);
</code>
\\
**[[:develop:api:efl:access:property:name|name]]** //**(get, set)**//\\
> %%Accessible name of the object.%%
<code c>
const char *efl_access_name_get(const Eo *obj);
void efl_access_name_set(Eo *obj, const char *name);
</code>
\\
**[[:develop:api:efl:access:property:parent|parent]]** //**(get, set)**//\\
> %%Object's accessible parent.%%
<code c>
Efl_Access *efl_access_parent_get(const Eo *obj);
void efl_access_parent_set(Eo *obj, Efl_Access *parent);
</code>
\\
**[[:develop:api:efl:access:method:relationship_append|relationship_append]]**\\
> %%Defines the relationship between two accessible objects.%%
<code c>
Eina_Bool efl_access_relationship_append(Eo *obj, Efl_Access_Relation_Type type, const Efl_Access *relation_object);
</code>
\\
**[[:develop:api:efl:access:method:relationship_remove|relationship_remove]]**\\
> %%Removes the relationship between two accessible objects.%%
<code c>
void efl_access_relationship_remove(Eo *obj, Efl_Access_Relation_Type type, const Efl_Access *relation_object);
</code>
\\
**[[:develop:api:efl:access:method:relationships_clear|relationships_clear]]**\\
> %%Removes all relationships in accessible object.%%
<code c>
void efl_access_relationships_clear(Eo *obj);
</code>
\\
**[[:develop:api:efl:access:property:role|role]]** //**(get, set)**//\\
> %%The role of the object in accessibility domain.%%
<code c>
Efl_Access_Role efl_access_role_get(const Eo *obj);
void efl_access_role_set(Eo *obj, Efl_Access_Role role);
</code>
\\
**[[:develop:api:efl:access:property:root|root]]** //**(get)**// ''class''\\
> %%Get root object of accessible object hierarchy%%
<code c>
Efl_Object *efl_access_root_get(Efl_Class *klass);
</code>
\\
**[[:develop:api:efl:access:property:translation_domain|translation_domain]]** //**(get, set)**//\\
> %%The translation domain of "name" and "description" properties.%%
<code c>
const char *efl_access_translation_domain_get(const Eo *obj);
void efl_access_translation_domain_set(Eo *obj, const char *domain);
</code>
\\
**[[:develop:api:efl:access:property:type|type]]** //**(get, set)**//\\
> %%Type of accessibility object%%
<code c>
Efl_Access_Type efl_access_type_get(const Eo *obj);
void efl_access_type_set(Eo *obj, Efl_Access_Type type);
</code>
\\
**[[:develop:api:efl:access:property:attributes|attributes]]** //**(get)**// ''protected''\\
> %%Gets key-value pairs indentifying object extra attributes. Must be free by a user.%%
<code c>
Eina_List *efl_access_attributes_get(const Eo *obj);
</code>
\\
**[[:develop:api:efl:access:property:children|children]]** //**(get)**// ''protected''\\
> %%Gets object's accessible children.%%
<code c>
Eina_List *efl_access_children_get(const Eo *obj);
</code>
\\
**[[:develop:api:efl:access:method:event_emit|event_emit]]** ''class'' ''protected''\\
> %%Emit event%%
<code c>
void efl_access_event_emit(Efl_Class *klass, Efl_Access *accessible, const Efl_Event_Description *event, void *event_info);
</code>
\\
**[[:develop:api:efl:access:method:event_handler_add|event_handler_add]]** ''class'' ''protected''\\
> %%Register accessibility event listener%%
<code c>
Efl_Access_Event_Handler *efl_access_event_handler_add(Efl_Class *klass, Efl_Event_Cb cb, void *data);
</code>
\\
**[[:develop:api:efl:access:method:event_handler_del|event_handler_del]]** ''class'' ''protected''\\
> %%Deregister accessibility event listener%%
<code c>
void efl_access_event_handler_del(Efl_Class *klass, Efl_Access_Event_Handler *handler);
</code>
\\
**[[:develop:api:efl:access:property:index_in_parent|index_in_parent]]** //**(get)**// ''protected''\\
> %%Gets index of the child in parent's children list.%%
<code c>
int efl_access_index_in_parent_get(const Eo *obj);
</code>
\\
**[[:develop:api:efl:access:property:localized_role_name|localized_role_name]]** //**(get)**// ''protected''\\
> %%Gets an localized string describing accessible object role name.%%
<code c>
const char *efl_access_localized_role_name_get(const Eo *obj);
</code>
\\
**[[:develop:api:efl:access:property:reading_info_type|reading_info_type]]** //**(get, set)**// ''protected''\\
>
<code c>
Efl_Access_Reading_Info_Type efl_access_reading_info_type_get(const Eo *obj);
void efl_access_reading_info_type_set(Eo *obj, Efl_Access_Reading_Info_Type reading_info);
</code>
\\
**[[:develop:api:efl:access:property:relation_set|relation_set]]** //**(get)**// ''protected''\\
> %%Gets an all relations between accessible object and other accessible objects.%%
<code c>
Efl_Access_Relation_Set efl_access_relation_set_get(const Eo *obj);
</code>
\\
**[[:develop:api:efl:access:property:role_name|role_name]]** //**(get)**// ''protected''\\
> %%Gets human-readable string indentifying object accessibility role.%%
<code c>
const char *efl_access_role_name_get(const Eo *obj);
</code>
\\
**[[:develop:api:efl:access:property:state_set|state_set]]** //**(get)**// ''protected''\\
> %%Gets set describing object accessible states.%%
<code c>
Efl_Access_State_Set efl_access_state_set_get(const Eo *obj);
</code>
\\
==== Inherited ====
^ [[:develop:api:efl:object|Efl.Object]] ^^^
| | **[[:develop:api:efl:object:property:allow_parent_unref|allow_parent_unref]]** //**(get, set)**// | %%Allow an object to be deleted by unref even if it has a parent.%% |
| | **[[:develop:api:efl:object:method:children_iterator_new|children_iterator_new]]** | %%Get an iterator on all childrens%% |
| | **[[:develop:api:efl:object:property:comment|comment]]** //**(get, set)**// | %%A human readable comment for the object%% |
| | **[[:develop:api:efl:object:method:composite_attach|composite_attach]]** | %%Make an object a composite object of another.%% |
| | **[[:develop:api:efl:object:method:composite_detach|composite_detach]]** | %%Detach a composite object from another object.%% |
| | **[[:develop:api:efl:object:method:composite_part_is|composite_part_is]]** | %%Check if an object is part of a composite object.%% |
| | **[[:develop:api:efl:object:method:constructor|constructor]]** | %%Call the object's constructor.%% |
| | **[[:develop:api:efl:object:method:debug_name_override|debug_name_override]]** | %%Build a read-only name for this object used for debugging.%% |
| | **[[:develop:api:efl:object:method:del|del]]** | %%Unrefs the object and reparents it to NULL.%% |
| | **[[:develop:api:efl:object:method:event_callback_forwarder_add|event_callback_forwarder_add]]** | %%Add an event callback forwarder for an event and an object.%% |
| | **[[:develop:api:efl:object:method:event_callback_forwarder_del|event_callback_forwarder_del]]** | %%Remove an event callback forwarder for an event and an object.%% |
| | **[[:develop:api:efl:object:method:event_callback_stop|event_callback_stop]]** | %%Stop the current callback call.%% |
| | **[[:develop:api:efl:object:method:event_freeze|event_freeze]]** | %%Freeze events of object.%% |
| | **[[:develop:api:efl:object:property:event_freeze_count|event_freeze_count]]** //**(get)**// | %%Return freeze events of object.%% |
| ''class'' | **[[:develop:api:efl:object:method:event_global_freeze|event_global_freeze]]** | %%Freeze events of object.%% |
| ''class'' | **[[:develop:api:efl:object:property:event_global_freeze_count|event_global_freeze_count]]** //**(get)**// | %%Return freeze events of object.%% |
| ''class'' | **[[:develop:api:efl:object:method:event_global_thaw|event_global_thaw]]** | %%Thaw events of object.%% |
| | **[[:develop:api:efl:object:method:event_thaw|event_thaw]]** | %%Thaw events of object.%% |
| | **[[:develop:api:efl:object:method:finalize|finalize]]** | %%Called at the end of efl_add. Should not be called, just overridden.%% |
| | **[[:develop:api:efl:object:property:finalized|finalized]]** //**(get)**// | %%True if the object is already finalized, otherwise false.%% |
| | **[[:develop:api:efl:object:property:name|name]]** //**(get, set)**// | %%The name of the object.%% |
| | **[[:develop:api:efl:object:method:name_find|name_find]]** | %%Find a child object with the given name and return it.%% |
| | **[[:develop:api:efl:object:property:parent|parent]]** //**(get, set)**// | %%The parent of an object.%% |
| | **[[:develop:api:efl:object:method:provider_find|provider_find]]** | %%Searches upwards in the object tree for a provider which knows the given class/interface.%% |
===== Events =====
**[[:develop:api:efl:access:event:active_descendant_changed|active,descendant,changed]]**\\
> %%Called when active state of descendant has changed%%
<code c>
EFL_ACCESS_EVENT_ACTIVE_DESCENDANT_CHANGED(void)
</code>
\\ **[[:develop:api:efl:access:event:added|added]]**\\
> %%Called when item is added%%
<code c>
EFL_ACCESS_EVENT_ADDED(void)
</code>
\\ **[[:develop:api:efl:access:event:bounds_changed|bounds,changed]]**\\
> %%Called when boundaries have changed%%
<code c>
EFL_ACCESS_EVENT_BOUNDS_CHANGED(Efl_Access_Event_Geometry_Changed_Data)
</code>
\\ **[[:develop:api:efl:access:event:children_changed|children,changed]]**\\
> %%Called when children have changed%%
<code c>
EFL_ACCESS_EVENT_CHILDREN_CHANGED(Efl_Access_Event_Children_Changed_Data)
</code>
\\ **[[:develop:api:efl:access:event:property_changed|property,changed]]**\\
> %%Called when property has changed%%
<code c>
EFL_ACCESS_EVENT_PROPERTY_CHANGED(const char *)
</code>
\\ **[[:develop:api:efl:access:event:removed|removed]]**\\
> %%Called when item is removed%%
<code c>
EFL_ACCESS_EVENT_REMOVED(void)
</code>
\\ **[[:develop:api:efl:access:event:state_changed|state,changed]]**\\
> %%Called when state has changed%%
<code c>
EFL_ACCESS_EVENT_STATE_CHANGED(Efl_Access_Event_State_Changed_Data)
</code>
\\ **[[:develop:api:efl:access:event:visible_data_changed|visible,data,changed]]**\\
> %%Called when visibility has changed%%
<code c>
EFL_ACCESS_EVENT_VISIBLE_DATA_CHANGED(void)
</code>
\\ ==== Inherited ====
^ [[:develop:api:efl:object|Efl.Object]] ^^^
| | **[[:develop:api:efl:object:event:callback_add|callback,add]]** | %%A callback was added.%% |
| | **[[:develop:api:efl:object:event:callback_del|callback,del]]** | %%A callback was deleted.%% |
| | **[[:develop:api:efl:object:event:del|del]]** | %%Object is being deleted.%% |
| | **[[:develop:api:efl:object:event:destruct|destruct]]** | %%Object has been fully destroyed. It can not be used beyond this point. This event should only serve to clean up any dangling pointer.%% |

51
pages/develop/api/efl/access/action.txt
View File

@ -1,51 +0,0 @@
~~Title: Efl.Access.Action~~
====== Efl.Access.Action (mixin) ======
===== Description =====
%%Accessible action mixin%%
{{page>:develop:api-include:efl:access:action:description&nouser&nolink&nodate}}
===== Members =====
**[[:develop:api:efl:access:action:property:action_description|action_description]]** //**(get, set)**// ''protected''\\
> %%Action description for given id%%
<code c>
const char *efl_access_action_description_get(const Eo *obj, int id);
Eina_Bool efl_access_action_description_set(Eo *obj, int id, const char *description);
</code>
\\
**[[:develop:api:efl:access:action:method:action_do|action_do]]** ''protected''\\
> %%Performs action on given widget.%%
<code c>
Eina_Bool efl_access_action_do(Eo *obj, int id);
</code>
\\
**[[:develop:api:efl:access:action:method:action_keybinding_get|action_keybinding_get]]** ''protected''\\
> %%Gets configured keybinding for specific action and widget.%%
<code c>
char *efl_access_action_keybinding_get(Eo *obj, int id);
</code>
\\
**[[:develop:api:efl:access:action:property:action_localized_name|action_localized_name]]** //**(get)**// ''protected''\\
> %%Gets localized action name for given id%%
<code c>
const char *efl_access_action_localized_name_get(const Eo *obj, int id);
</code>
\\
**[[:develop:api:efl:access:action:property:action_name|action_name]]** //**(get)**// ''protected''\\
> %%Gets action name for given id%%
<code c>
const char *efl_access_action_name_get(const Eo *obj, int id);
</code>
\\
**[[:develop:api:efl:access:action:property:actions|actions]]** //**(get)**// ''protected''\\
> %%Get list of available widget actions%%
<code c>
Eina_List *efl_access_action_actions_get(const Eo *obj);
</code>
\\
===== Events =====

31
pages/develop/api/efl/access/action/method/action_do.txt
View File

@ -1,31 +0,0 @@
~~Title: Efl.Access.Action.action_do~~
===== Description =====
%%Performs action on given widget.%%
{{page>:develop:api-include:efl:access:action:method:action_do:description&nouser&nolink&nodate}}
===== Signature =====
<code>
action_do @beta @protected @pure_virtual {
params {
@in id: int;
}
return: bool;
}
</code>
===== C signature =====
<code c>
Eina_Bool efl_access_action_do(Eo *obj, int id);
</code>
===== Parameters =====
* **id** //(in)// - %%ID for widget%%
===== Implemented by =====
* **Efl.Access.Action.action_do**

31
pages/develop/api/efl/access/action/method/action_keybinding_get.txt
View File

@ -1,31 +0,0 @@
~~Title: Efl.Access.Action.action_keybinding_get~~
===== Description =====
%%Gets configured keybinding for specific action and widget.%%
{{page>:develop:api-include:efl:access:action:method:action_keybinding_get:description&nouser&nolink&nodate}}
===== Signature =====
<code>
action_keybinding_get @beta @protected @pure_virtual {
params {
@in id: int;
}
return: mstring @warn_unused;
}
</code>
===== C signature =====
<code c>
char *efl_access_action_keybinding_get(Eo *obj, int id);
</code>
===== Parameters =====
* **id** //(in)// - %%ID for widget%%
===== Implemented by =====
* **Efl.Access.Action.action_keybinding_get**

48
pages/develop/api/efl/access/action/property/action_description.txt
View File

@ -1,48 +0,0 @@
~~Title: Efl.Access.Action.action_description~~
===== Description =====
%%Action description for given id%%
{{page>:develop:api-include:efl:access:action:property:action_description:description&nouser&nolink&nodate}}
===== Keys =====
* **id** - %%ID to set or get description for%%
===== Values =====
* **description** - %%Action description%%
===== Signature =====
<code>
@property action_description @beta @protected @pure_virtual {
get {
keys {
id: int;
}
values {
description: free(string, free);
}
}
set {
keys {
id: int;
}
values {
description: free(string, free);
}
return: bool;
}
}
</code>
===== C signature =====
<code c>
const char *efl_access_action_description_get(const Eo *obj, int id);
Eina_Bool efl_access_action_description_set(Eo *obj, int id, const char *description);
</code>
===== Implemented by =====
* **Efl.Access.Action.action_description**

36
pages/develop/api/efl/access/action/property/action_localized_name.txt
View File

@ -1,36 +0,0 @@
~~Title: Efl.Access.Action.action_localized_name~~
===== Keys =====
* **id** - %%ID to get localized name for%%
===== Values =====
* **name** - %%Localized name%%
\\ {{page>:develop:api-include:efl:access:action:property:action_localized_name:description&nouser&nolink&nodate}}
===== Signature =====
<code>
@property action_localized_name @beta {
get @protected {
keys {
id: int;
}
values {
name: free(string, free);
}
}
}
</code>
===== C signature =====
<code c>
const char *efl_access_action_localized_name_get(const Eo *obj, int id);
</code>
===== Implemented by =====
* **Efl.Access.Action.action_localized_name**

36
pages/develop/api/efl/access/action/property/action_name.txt
View File

@ -1,36 +0,0 @@
~~Title: Efl.Access.Action.action_name~~
===== Keys =====
* **id** - %%ID to get action name for%%
===== Values =====
* **name** - %%Action name%%
\\ {{page>:develop:api-include:efl:access:action:property:action_name:description&nouser&nolink&nodate}}
===== Signature =====
<code>
@property action_name @beta @pure_virtual {
get @protected {
keys {
id: int;
}
values {
name: free(string, free);
}
}
}
</code>
===== C signature =====
<code c>
const char *efl_access_action_name_get(const Eo *obj, int id);
</code>
===== Implemented by =====
* **Efl.Access.Action.action_name**

30
pages/develop/api/efl/access/action/property/actions.txt
View File

@ -1,30 +0,0 @@
~~Title: Efl.Access.Action.actions~~
===== Values =====
* **actions** - %%Contains statically allocated strings.%%
\\ {{page>:develop:api-include:efl:access:action:property:actions:description&nouser&nolink&nodate}}
===== Signature =====
<code>
@property actions @beta @pure_virtual {
get @protected {
values {
actions: free(list<ptr(Efl.Access.Action_Data)>, eina_list_free);
}
}
}
</code>
===== C signature =====
<code c>
Eina_List *efl_access_action_actions_get(const Eo *obj);
</code>
===== Implemented by =====
* **Efl.Access.Action.actions**

19
pages/develop/api/efl/access/action_data.txt
View File

@ -1,19 +0,0 @@
~~Title: Efl.Access.Action_Data~~
===== Description =====
%%Internal struct for accesssibility.%%
{{page>:develop:api-include:efl:access:action_data:description&nouser&nolink&nodate}}
===== Signature =====
<code>
type @extern Efl.Access.Action_Data: __undefined_type;
</code>
===== C signature =====
<code c>
typedef __undefined_type Efl_Access_Action_Data;
</code>

32
pages/develop/api/efl/access/attribute.txt
View File

@ -1,32 +0,0 @@
~~Title: Efl.Access.Attribute~~
===== Description =====
%%Accessibility Attribute%%
{{page>:develop:api-include:efl:access:attribute:description&nouser&nolink&nodate}}
===== Fields =====
{{page>:develop:api-include:efl:access:attribute:fields&nouser&nolink&nodate}}
* **key** - %%Attribute key%%
* **value** - %%Attribute value%%
===== Signature =====
<code>
struct Efl.Access.Attribute {
key: free(string, free);
value: free(string, free);
}
</code>
===== C signature =====
<code c>
typedef struct _Efl_Access_Attribute {
const char *key;
const char *value;
} Efl_Access_Attribute;
</code>

71
pages/develop/api/efl/access/component.txt
View File

@ -1,71 +0,0 @@
~~Title: Efl.Access.Component~~
====== Efl.Access.Component (mixin) ======
===== Description =====
%%AT-SPI component mixin%%
{{page>:develop:api-include:efl:access:component:description&nouser&nolink&nodate}}
===== Members =====
**[[:develop:api:efl:access:component:method:accessible_at_point_get|accessible_at_point_get]]** ''protected''\\
> %%Gets top component object occupying space at given coordinates.%%
<code c>
Efl_Object *efl_access_component_accessible_at_point_get(Eo *obj, Eina_Bool screen_coords, int x, int y);
</code>
\\
**[[:develop:api:efl:access:component:property:alpha|alpha]]** //**(get)**// ''protected''\\
> %%Gets alpha of accessible widget.%%
<code c>
double efl_access_component_alpha_get(const Eo *obj);
</code>
\\
**[[:develop:api:efl:access:component:method:contains|contains]]** ''protected''\\
> %%Contains accessible widget%%
<code c>
Eina_Bool efl_access_component_contains(Eo *obj, Eina_Bool screen_coords, int x, int y);
</code>
\\
**[[:develop:api:efl:access:component:property:extents|extents]]** //**(get, set)**// ''protected''\\
> %%Geometry of accessible widget.%%
<code c>
Eina_Rect efl_access_component_extents_get(const Eo *obj, Eina_Bool screen_coords);
Eina_Bool efl_access_component_extents_set(Eo *obj, Eina_Bool screen_coords, Eina_Rect rect);
</code>
\\
**[[:develop:api:efl:access:component:method:focus_grab|focus_grab]]** ''protected''\\
> %%Focuses accessible widget.%%
<code c>
Eina_Bool efl_access_component_focus_grab(Eo *obj);
</code>
\\
**[[:develop:api:efl:access:component:property:layer|layer]]** //**(get)**// ''protected''\\
> %%Evas layer of accessible widget.%%
<code c>
int efl_access_component_layer_get(const Eo *obj);
</code>
\\
**[[:develop:api:efl:access:component:property:position|position]]** //**(get, set)**// ''protected''\\
> %%Position of accessible widget.%%
<code c>
void efl_access_component_position_get(const Eo *obj, Eina_Bool screen_coords, int *x, int *y);
Eina_Bool efl_access_component_position_set(Eo *obj, Eina_Bool screen_coords, int x, int y);
</code>
\\
**[[:develop:api:efl:access:component:property:size|size]]** //**(get, set)**// ''protected''\\
> %%Size of accessible widget.%%
<code c>
void efl_access_component_size_get(const Eo *obj, int *w, int *h);
Eina_Bool efl_access_component_size_set(Eo *obj, int w, int h);
</code>
\\
**[[:develop:api:efl:access:component:property:z_order|z_order]]** //**(get)**// ''protected''\\
> %%Gets the depth at which the component is shown in relation to other components in the same container.%%
<code c>
int efl_access_component_z_order_get(const Eo *obj);
</code>
\\
===== Events =====

35
pages/develop/api/efl/access/component/method/accessible_at_point_get.txt
View File

@ -1,35 +0,0 @@
~~Title: Efl.Access.Component.accessible_at_point_get~~
===== Description =====
%%Gets top component object occupying space at given coordinates.%%
{{page>:develop:api-include:efl:access:component:method:accessible_at_point_get:description&nouser&nolink&nodate}}
===== Signature =====
<code>
accessible_at_point_get @beta @protected {
params {
@in screen_coords: bool;
@in x: int;
@in y: int;
}
return: free(Efl.Object, efl_del);
}
</code>
===== C signature =====
<code c>
Efl_Object *efl_access_component_accessible_at_point_get(Eo *obj, Eina_Bool screen_coords, int x, int y);
</code>
===== Parameters =====
* **screen_coords** //(in)// - %%If %%''true''%% x and y values will be relative to screen origin, otherwise relative to canvas%%
* **x** //(in)// - %%X coordinate%%
* **y** //(in)// - %%Y coordinate%%
===== Implemented by =====
* **Efl.Access.Component.accessible_at_point_get**

35
pages/develop/api/efl/access/component/method/contains.txt
View File

@ -1,35 +0,0 @@
~~Title: Efl.Access.Component.contains~~
===== Description =====
%%Contains accessible widget%%
{{page>:develop:api-include:efl:access:component:method:contains:description&nouser&nolink&nodate}}
===== Signature =====
<code>
contains @beta @protected {
params {
@in screen_coords: bool;
@in x: int;
@in y: int;
}
return: bool;
}
</code>
===== C signature =====
<code c>
Eina_Bool efl_access_component_contains(Eo *obj, Eina_Bool screen_coords, int x, int y);
</code>
===== Parameters =====
* **screen_coords** //(in)// - %%If %%''true''%% x and y values will be relative to screen origin, otherwise relative to canvas%%
* **x** //(in)// - %%X coordinate%%
* **y** //(in)// - %%Y coordinate%%
===== Implemented by =====
* **Efl.Access.Component.contains**

24
pages/develop/api/efl/access/component/method/focus_grab.txt
View File

@ -1,24 +0,0 @@
~~Title: Efl.Access.Component.focus_grab~~
===== Description =====
%%Focuses accessible widget.%%
{{page>:develop:api-include:efl:access:component:method:focus_grab:description&nouser&nolink&nodate}}
===== Signature =====
<code>
focus_grab @beta @protected {
return: bool;
}
</code>
===== C signature =====
<code c>
Eina_Bool efl_access_component_focus_grab(Eo *obj);
</code>
===== Implemented by =====
* **Efl.Access.Component.focus_grab**

30
pages/develop/api/efl/access/component/property/alpha.txt
View File

@ -1,30 +0,0 @@
~~Title: Efl.Access.Component.alpha~~
===== Values =====
* **alpha** - %%Alpha value in [0, 1] range.%%
\\ {{page>:develop:api-include:efl:access:component:property:alpha:description&nouser&nolink&nodate}}
===== Signature =====
<code>
@property alpha @beta {
get @protected {
values {
alpha: double;
}
}
}
</code>
===== C signature =====
<code c>
double efl_access_component_alpha_get(const Eo *obj);
</code>
===== Implemented by =====
* **Efl.Access.Component.alpha**

48
pages/develop/api/efl/access/component/property/extents.txt
View File

@ -1,48 +0,0 @@
~~Title: Efl.Access.Component.extents~~
===== Description =====
%%Geometry of accessible widget.%%
{{page>:develop:api-include:efl:access:component:property:extents:description&nouser&nolink&nodate}}
===== Keys =====
* **screen_coords** - %%If %%''true''%% x and y values will be relative to screen origin, otherwise relative to canvas%%
===== Values =====
* **rect** - %%The geometry.%%
===== Signature =====
<code>
@property extents @beta @protected {
get {
keys {
screen_coords: bool;
}
values {
rect: free(Eina.Rect, eina_rectangle_free);
}
}
set {
keys {
screen_coords: bool;
}
values {
rect: free(Eina.Rect, eina_rectangle_free);
}
return: bool;
}
}
</code>
===== C signature =====
<code c>
Eina_Rect efl_access_component_extents_get(const Eo *obj, Eina_Bool screen_coords);
Eina_Bool efl_access_component_extents_set(Eo *obj, Eina_Bool screen_coords, Eina_Rect rect);
</code>
===== Implemented by =====
* **Efl.Access.Component.extents**

30
pages/develop/api/efl/access/component/property/layer.txt
View File

@ -1,30 +0,0 @@
~~Title: Efl.Access.Component.layer~~
===== Values =====
* **layer** - %%Evas layer of the widget%%
\\ {{page>:develop:api-include:efl:access:component:property:layer:description&nouser&nolink&nodate}}
===== Signature =====
<code>
@property layer @beta {
get @protected {
values {
layer: int;
}
}
}
</code>
===== C signature =====
<code c>
int efl_access_component_layer_get(const Eo *obj);
</code>
===== Implemented by =====
* **Efl.Access.Component.layer**

51
pages/develop/api/efl/access/component/property/position.txt
View File

@ -1,51 +0,0 @@
~~Title: Efl.Access.Component.position~~
===== Description =====
%%Position of accessible widget.%%
{{page>:develop:api-include:efl:access:component:property:position:description&nouser&nolink&nodate}}
===== Keys =====
* **screen_coords** - %%If %%''true''%% x and y values will be relative to screen origin, otherwise relative to canvas%%
===== Values =====
* **x** - %%X coordinate%%
* **y** - %%Y coordinate%%
===== Signature =====
<code>
@property position @beta @protected {
get {
keys {
screen_coords: bool;
}
values {
x: int;
y: int;
}
}
set {
keys {
screen_coords: bool;
}
values {
x: int;
y: int;
}
return: bool;
}
}
</code>
===== C signature =====
<code c>
void efl_access_component_position_get(const Eo *obj, Eina_Bool screen_coords, int *x, int *y);
Eina_Bool efl_access_component_position_set(Eo *obj, Eina_Bool screen_coords, int x, int y);
</code>
===== Implemented by =====
* **Efl.Access.Component.position**

42
pages/develop/api/efl/access/component/property/size.txt
View File

@ -1,42 +0,0 @@
~~Title: Efl.Access.Component.size~~
===== Description =====
%%Size of accessible widget.%%
{{page>:develop:api-include:efl:access:component:property:size:description&nouser&nolink&nodate}}
===== Values =====
* **w** - %%Width of the widget%%
* **h** - %%Height of the widget%%
===== Signature =====
<code>
@property size @beta @protected {
get {
values {
w: int;
h: int;
}
}
set {
values {
w: int;
h: int;
}
return: bool;
}
}
</code>
===== C signature =====
<code c>
void efl_access_component_size_get(const Eo *obj, int *w, int *h);
Eina_Bool efl_access_component_size_set(Eo *obj, int w, int h);
</code>
===== Implemented by =====
* **Efl.Access.Component.size**

30
pages/develop/api/efl/access/component/property/z_order.txt
View File

@ -1,30 +0,0 @@
~~Title: Efl.Access.Component.z_order~~
===== Values =====
* **z_order** - %%Z order of component%%
\\ {{page>:develop:api-include:efl:access:component:property:z_order:description&nouser&nolink&nodate}}
===== Signature =====
<code>
@property z_order @beta {
get @protected {
values {
z_order: int;
}
}
}
</code>
===== C signature =====
<code c>
int efl_access_component_z_order_get(const Eo *obj);
</code>
===== Implemented by =====
* **Efl.Access.Component.z_order**

50
pages/develop/api/efl/access/editable/text.txt
View File

@ -1,50 +0,0 @@
~~Title: Efl.Access.Editable.Text~~
====== Efl.Access.Editable.Text (interface) ======
===== Description =====
%%Elementary editable text interface%%
{{page>:develop:api-include:efl:access:editable:text:description&nouser&nolink&nodate}}
===== Members =====
**[[:develop:api:efl:access:editable:text:property:content|content]]** //**(set)**// ''protected''\\
> %%Editable content property%%
<code c>
Eina_Bool efl_access_editable_text_content_set(Eo *obj, const char *string);
</code>
\\
**[[:develop:api:efl:access:editable:text:method:copy|copy]]** ''protected''\\
> %%Copy text between start and end parameter%%
<code c>
Eina_Bool efl_access_editable_text_copy(Eo *obj, int start, int end);
</code>
\\
**[[:develop:api:efl:access:editable:text:method:cut|cut]]** ''protected''\\
> %%Cut text between start and end parameter%%
<code c>
Eina_Bool efl_access_editable_text_cut(Eo *obj, int start, int end);
</code>
\\
**[[:develop:api:efl:access:editable:text:method:delete|delete]]** ''protected''\\
> %%Delete text between start and end parameter%%
<code c>
Eina_Bool efl_access_editable_text_delete(Eo *obj, int start, int end);
</code>
\\
**[[:develop:api:efl:access:editable:text:method:insert|insert]]** ''protected''\\
> %%Insert text at given position%%
<code c>
Eina_Bool efl_access_editable_text_insert(Eo *obj, const char *string, int position);
</code>
\\
**[[:develop:api:efl:access:editable:text:method:paste|paste]]** ''protected''\\
> %%Paste text at given position%%
<code c>
Eina_Bool efl_access_editable_text_paste(Eo *obj, int position);
</code>
\\
===== Events =====

33
pages/develop/api/efl/access/editable/text/method/copy.txt
View File

@ -1,33 +0,0 @@
~~Title: Efl.Access.Editable.Text.copy~~
===== Description =====
%%Copy text between start and end parameter%%
{{page>:develop:api-include:efl:access:editable:text:method:copy:description&nouser&nolink&nodate}}
===== Signature =====
<code>
copy @beta @protected @pure_virtual {
params {
@in start: int;
@in end: int;
}
return: bool;
}
</code>
===== C signature =====
<code c>
Eina_Bool efl_access_editable_text_copy(Eo *obj, int start, int end);
</code>
===== Parameters =====
* **start** //(in)// - %%Start position to copy%%
* **end** //(in)// - %%End position to copy%%
===== Implemented by =====
* **Efl.Access.Editable.Text.copy**

33
pages/develop/api/efl/access/editable/text/method/cut.txt
View File

@ -1,33 +0,0 @@
~~Title: Efl.Access.Editable.Text.cut~~
===== Description =====
%%Cut text between start and end parameter%%
{{page>:develop:api-include:efl:access:editable:text:method:cut:description&nouser&nolink&nodate}}
===== Signature =====
<code>
cut @beta @protected @pure_virtual {
params {
@in start: int;
@in end: int;
}
return: bool;
}
</code>
===== C signature =====
<code c>
Eina_Bool efl_access_editable_text_cut(Eo *obj, int start, int end);
</code>
===== Parameters =====
* **start** //(in)// - %%Start position to cut%%
* **end** //(in)// - %%End position to cut%%
===== Implemented by =====
* **Efl.Access.Editable.Text.cut**

33
pages/develop/api/efl/access/editable/text/method/delete.txt
View File

@ -1,33 +0,0 @@
~~Title: Efl.Access.Editable.Text.delete~~
===== Description =====
%%Delete text between start and end parameter%%
{{page>:develop:api-include:efl:access:editable:text:method:delete:description&nouser&nolink&nodate}}
===== Signature =====
<code>
delete @beta @protected @pure_virtual {
params {
@in start: int;
@in end: int;
}
return: bool;
}
</code>
===== C signature =====
<code c>
Eina_Bool efl_access_editable_text_delete(Eo *obj, int start, int end);
</code>
===== Parameters =====
* **start** //(in)// - %%Start position to delete%%
* **end** //(in)// - %%End position to delete%%
===== Implemented by =====
* **Efl.Access.Editable.Text.delete**

33
pages/develop/api/efl/access/editable/text/method/insert.txt
View File

@ -1,33 +0,0 @@
~~Title: Efl.Access.Editable.Text.insert~~
===== Description =====
%%Insert text at given position%%
{{page>:develop:api-include:efl:access:editable:text:method:insert:description&nouser&nolink&nodate}}
===== Signature =====
<code>
insert @beta @protected @pure_virtual {
params {
@in string: free(string, free);
@in position: int;
}
return: bool;
}
</code>
===== C signature =====
<code c>
Eina_Bool efl_access_editable_text_insert(Eo *obj, const char *string, int position);
</code>
===== Parameters =====
* **string** //(in)// - %%String to be inserted%%
* **position** //(in)// - %%Position to insert string%%
===== Implemented by =====
* **Efl.Access.Editable.Text.insert**

31
pages/develop/api/efl/access/editable/text/method/paste.txt
View File

@ -1,31 +0,0 @@
~~Title: Efl.Access.Editable.Text.paste~~
===== Description =====
%%Paste text at given position%%
{{page>:develop:api-include:efl:access:editable:text:method:paste:description&nouser&nolink&nodate}}
===== Signature =====
<code>
paste @beta @protected @pure_virtual {
params {
@in position: int;
}
return: bool;
}
</code>
===== C signature =====
<code c>
Eina_Bool efl_access_editable_text_paste(Eo *obj, int position);
</code>
===== Parameters =====
* **position** //(in)// - %%Position to insert text%%
===== Implemented by =====
* **Efl.Access.Editable.Text.paste**

28
pages/develop/api/efl/access/editable/text/property/content.txt
View File

@ -1,28 +0,0 @@
~~Title: Efl.Access.Editable.Text.content~~
===== Values =====
* **string** - %%Content%%
\\ {{page>:develop:api-include:efl:access:editable:text:property:content:description&nouser&nolink&nodate}}
===== Signature =====
<code>
@property content @beta @pure_virtual {
set @protected {
return: bool;
}
}
</code>
===== C signature =====
<code c>
Eina_Bool efl_access_editable_text_content_set(Eo *obj, const char *string);
</code>
===== Implemented by =====
* **Efl.Access.Editable.Text.content**

39
pages/develop/api/efl/access/event/active_descendant_changed.txt
View File

@ -1,39 +0,0 @@
~~Title: Efl.Access: active,descendant,changed~~
===== Description =====
%%Called when active state of descendant has changed%%
{{page>:develop:api-include:efl:access:event:active_descendant_changed:description&nouser&nolink&nodate}}
===== Signature =====
<code>
active,descendant,changed;
</code>
===== C information =====
<code c>
EFL_ACCESS_EVENT_ACTIVE_DESCENDANT_CHANGED(void)
</code>
===== C usage =====
<code c>
static void
on_efl_access_event_active_descendant_changed(void *data, const Efl_Event *event)
{
void info = event->info;
Eo *obj = event->object;
Data *d = data;
/* event hander code */
}
static void
setup_event_handler(Eo *obj, Data *d)
{
efl_event_callback_add(obj, EFL_ACCESS_EVENT_ACTIVE_DESCENDANT_CHANGED, on_efl_access_event_active_descendant_changed, d);
}
</code>

39
pages/develop/api/efl/access/event/added.txt
View File

@ -1,39 +0,0 @@
~~Title: Efl.Access: added~~
===== Description =====
%%Called when item is added%%
{{page>:develop:api-include:efl:access:event:added:description&nouser&nolink&nodate}}
===== Signature =====
<code>
added;
</code>
===== C information =====
<code c>
EFL_ACCESS_EVENT_ADDED(void)
</code>
===== C usage =====
<code c>
static void
on_efl_access_event_added(void *data, const Efl_Event *event)
{
void info = event->info;
Eo *obj = event->object;
Data *d = data;
/* event hander code */
}
static void
setup_event_handler(Eo *obj, Data *d)
{
efl_event_callback_add(obj, EFL_ACCESS_EVENT_ADDED, on_efl_access_event_added, d);
}
</code>

39
pages/develop/api/efl/access/event/bounds_changed.txt
View File

@ -1,39 +0,0 @@
~~Title: Efl.Access: bounds,changed~~
===== Description =====
%%Called when boundaries have changed%%
{{page>:develop:api-include:efl:access:event:bounds_changed:description&nouser&nolink&nodate}}
===== Signature =====
<code>
bounds,changed: Efl.Access.Event.Geometry_Changed.Data;
</code>
===== C information =====
<code c>
EFL_ACCESS_EVENT_BOUNDS_CHANGED(Efl_Access_Event_Geometry_Changed_Data)
</code>
===== C usage =====
<code c>
static void
on_efl_access_event_bounds_changed(void *data, const Efl_Event *event)
{
Efl_Access_Event_Geometry_Changed_Data info = event->info;
Eo *obj = event->object;
Data *d = data;
/* event hander code */
}
static void
setup_event_handler(Eo *obj, Data *d)
{
efl_event_callback_add(obj, EFL_ACCESS_EVENT_BOUNDS_CHANGED, on_efl_access_event_bounds_changed, d);
}
</code>

39
pages/develop/api/efl/access/event/children_changed.txt
View File

@ -1,39 +0,0 @@
~~Title: Efl.Access: children,changed~~
===== Description =====
%%Called when children have changed%%
{{page>:develop:api-include:efl:access:event:children_changed:description&nouser&nolink&nodate}}
===== Signature =====
<code>
children,changed: Efl.Access.Event.Children_Changed.Data;
</code>
===== C information =====
<code c>
EFL_ACCESS_EVENT_CHILDREN_CHANGED(Efl_Access_Event_Children_Changed_Data)
</code>
===== C usage =====
<code c>
static void
on_efl_access_event_children_changed(void *data, const Efl_Event *event)
{
Efl_Access_Event_Children_Changed_Data info = event->info;
Eo *obj = event->object;
Data *d = data;
/* event hander code */
}
static void
setup_event_handler(Eo *obj, Data *d)
{
efl_event_callback_add(obj, EFL_ACCESS_EVENT_CHILDREN_CHANGED, on_efl_access_event_children_changed, d);
}
</code>

32
pages/develop/api/efl/access/event/children_changed/data.txt
View File

@ -1,32 +0,0 @@
~~Title: Efl.Access.Event.Children_Changed.Data~~
===== Description =====
%%Accessibility children changed event data%%
{{page>:develop:api-include:efl:access:event:children_changed:data:description&nouser&nolink&nodate}}
===== Fields =====
{{page>:develop:api-include:efl:access:event:children_changed:data:fields&nouser&nolink&nodate}}
* **is_added** - %%Child is added or not%%
* **child** - %%Child object%%
===== Signature =====
<code>
struct Efl.Access.Event.Children_Changed.Data {
is_added: bool;
child: free(Efl.Object, efl_del);
}
</code>
===== C signature =====
<code c>
typedef struct _Efl_Access_Event_Children_Changed_Data {
Eina_Bool is_added;
Efl_Object *child;
} Efl_Access_Event_Children_Changed_Data;
</code>

38
pages/develop/api/efl/access/event/geometry_changed/data.txt
View File

@ -1,38 +0,0 @@
~~Title: Efl.Access.Event.Geometry_Changed.Data~~
===== Description =====
%%Accessibility geometry changed event data%%
{{page>:develop:api-include:efl:access:event:geometry_changed:data:description&nouser&nolink&nodate}}
===== Fields =====
{{page>:develop:api-include:efl:access:event:geometry_changed:data:fields&nouser&nolink&nodate}}
* **x** - %%X coordinate%%
* **y** - %%Y coordinate%%
* **width** - %%Width%%
* **height** - %%Height%%
===== Signature =====
<code>
struct Efl.Access.Event.Geometry_Changed.Data {
x: int;
y: int;
width: int;
height: int;
}
</code>
===== C signature =====
<code c>
typedef struct _Efl_Access_Event_Geometry_Changed_Data {
int x;
int y;
int width;
int height;
} Efl_Access_Event_Geometry_Changed_Data;
</code>

24
pages/develop/api/efl/access/event/handler.txt
View File

@ -1,24 +0,0 @@
~~Title: Efl.Access.Event.Handler~~
===== Description =====
%%Accessibility event listener%%
{{page>:develop:api-include:efl:access:event:handler:description&nouser&nolink&nodate}}
===== Fields =====
{{page>:develop:api-include:efl:access:event:handler:fields&nouser&nolink&nodate}}
===== Signature =====
<code>
struct Efl.Access.Event.Handler;
</code>
===== C signature =====
<code c>
typedef struct _Efl_Access_Event_Handler Efl_Access_Event_Handler;
</code>

39
pages/develop/api/efl/access/event/property_changed.txt
View File

@ -1,39 +0,0 @@
~~Title: Efl.Access: property,changed~~
===== Description =====
%%Called when property has changed%%
{{page>:develop:api-include:efl:access:event:property_changed:description&nouser&nolink&nodate}}
===== Signature =====
<code>
property,changed: free(string, free);
</code>
===== C information =====
<code c>
EFL_ACCESS_EVENT_PROPERTY_CHANGED(const char *)
</code>
===== C usage =====
<code c>
static void
on_efl_access_event_property_changed(void *data, const Efl_Event *event)
{
const char *info = event->info;
Eo *obj = event->object;
Data *d = data;
/* event hander code */
}
static void
setup_event_handler(Eo *obj, Data *d)
{
efl_event_callback_add(obj, EFL_ACCESS_EVENT_PROPERTY_CHANGED, on_efl_access_event_property_changed, d);
}
</code>

39
pages/develop/api/efl/access/event/removed.txt
View File

@ -1,39 +0,0 @@
~~Title: Efl.Access: removed~~
===== Description =====
%%Called when item is removed%%
{{page>:develop:api-include:efl:access:event:removed:description&nouser&nolink&nodate}}
===== Signature =====
<code>
removed;
</code>
===== C information =====
<code c>
EFL_ACCESS_EVENT_REMOVED(void)
</code>
===== C usage =====
<code c>
static void
on_efl_access_event_removed(void *data, const Efl_Event *event)
{
void info = event->info;
Eo *obj = event->object;
Data *d = data;
/* event hander code */
}
static void
setup_event_handler(Eo *obj, Data *d)
{
efl_event_callback_add(obj, EFL_ACCESS_EVENT_REMOVED, on_efl_access_event_removed, d);
}
</code>

39
pages/develop/api/efl/access/event/state_changed.txt
View File

@ -1,39 +0,0 @@
~~Title: Efl.Access: state,changed~~
===== Description =====
%%Called when state has changed%%
{{page>:develop:api-include:efl:access:event:state_changed:description&nouser&nolink&nodate}}
===== Signature =====
<code>
state,changed: Efl.Access.Event.State_Changed.Data;
</code>
===== C information =====
<code c>
EFL_ACCESS_EVENT_STATE_CHANGED(Efl_Access_Event_State_Changed_Data)
</code>
===== C usage =====
<code c>
static void
on_efl_access_event_state_changed(void *data, const Efl_Event *event)
{
Efl_Access_Event_State_Changed_Data info = event->info;
Eo *obj = event->object;
Data *d = data;
/* event hander code */
}
static void
setup_event_handler(Eo *obj, Data *d)
{
efl_event_callback_add(obj, EFL_ACCESS_EVENT_STATE_CHANGED, on_efl_access_event_state_changed, d);
}
</code>

32
pages/develop/api/efl/access/event/state_changed/data.txt
View File

@ -1,32 +0,0 @@
~~Title: Efl.Access.Event.State_Changed.Data~~
===== Description =====
%%Accessibility state changed event data%%
{{page>:develop:api-include:efl:access:event:state_changed:data:description&nouser&nolink&nodate}}
===== Fields =====
{{page>:develop:api-include:efl:access:event:state_changed:data:fields&nouser&nolink&nodate}}
* **type** - %%Type of the state changed event%%
* **new_value** - %%New value%%
===== Signature =====
<code>
struct Efl.Access.Event.State_Changed.Data {
type: Efl.Access.State_Type;
new_value: bool;
}
</code>
===== C signature =====
<code c>
typedef struct _Efl_Access_Event_State_Changed_Data {
Efl_Access_State_Type type;
Eina_Bool new_value;
} Efl_Access_Event_State_Changed_Data;
</code>

39
pages/develop/api/efl/access/event/visible_data_changed.txt
View File

@ -1,39 +0,0 @@
~~Title: Efl.Access: visible,data,changed~~
===== Description =====
%%Called when visibility has changed%%
{{page>:develop:api-include:efl:access:event:visible_data_changed:description&nouser&nolink&nodate}}
===== Signature =====
<code>
visible,data,changed;
</code>
===== C information =====
<code c>
EFL_ACCESS_EVENT_VISIBLE_DATA_CHANGED(void)
</code>
===== C usage =====
<code c>
static void
on_efl_access_event_visible_data_changed(void *data, const Efl_Event *event)
{
void info = event->info;
Eo *obj = event->object;
Data *d = data;
/* event hander code */
}
static void
setup_event_handler(Eo *obj, Data *d)
{
efl_event_callback_add(obj, EFL_ACCESS_EVENT_VISIBLE_DATA_CHANGED, on_efl_access_event_visible_data_changed, d);
}
</code>

33
pages/develop/api/efl/access/image.txt
View File

@ -1,33 +0,0 @@
~~Title: Efl.Access.Image~~
====== Efl.Access.Image (mixin) ======
===== Description =====
%%Accessible image mixin%%
{{page>:develop:api-include:efl:access:image:description&nouser&nolink&nodate}}
===== Members =====
**[[:develop:api:efl:access:image:property:description|description]]** //**(get, set)**// ''protected''\\
> %%Textual description of image%%
<code c>
const char *efl_access_image_description_get(const Eo *obj);
void efl_access_image_description_set(Eo *obj, const char *description);
</code>
\\
**[[:develop:api:efl:access:image:property:extents|extents]]** //**(get)**// ''protected''\\
> %%Gets an image extents.%%
<code c>
void efl_access_image_extents_get(const Eo *obj, Eina_Bool screen_coords, int *x, int *y, int *width, int *height);
</code>
\\
**[[:develop:api:efl:access:image:property:locale|locale]]** //**(get)**// ''protected''\\
> %%Gets locale of the image description.%%
<code c>
const char *efl_access_image_locale_get(const Eo *obj);
</code>
\\
===== Events =====

38
pages/develop/api/efl/access/image/property/description.txt
View File

@ -1,38 +0,0 @@
~~Title: Efl.Access.Image.description~~
===== Description =====
%%Textual description of image%%
{{page>:develop:api-include:efl:access:image:property:description:description&nouser&nolink&nodate}}
===== Values =====
* **description** - %%Textual image description%%
===== Signature =====
<code>
@property description @beta @protected {
get {
values {
description: free(string, free);
}
}
set {
values {
description: free(string, free);
}
}
}
</code>
===== C signature =====
<code c>
const char *efl_access_image_description_get(const Eo *obj);
void efl_access_image_description_set(Eo *obj, const char *description);
</code>
===== Implemented by =====
* **Efl.Access.Image.description**

42
pages/develop/api/efl/access/image/property/extents.txt
View File

@ -1,42 +0,0 @@
~~Title: Efl.Access.Image.extents~~
===== Keys =====
* **screen_coords** - %%%%''true''%% if we have the screen coordinates, otherwise %%''false''%%%%
===== Values =====
* **x** - %%X coordinate%%
* **y** - %%Y coordinate%%
* **width** - %%Image width%%
* **height** - %%Image height%%
\\ {{page>:develop:api-include:efl:access:image:property:extents:description&nouser&nolink&nodate}}
===== Signature =====
<code>
@property extents @beta @pure_virtual {
get @protected {
keys {
screen_coords: bool;
}
values {
x: int;
y: int;
width: int;
height: int;
}
}
}
</code>
===== C signature =====
<code c>
void efl_access_image_extents_get(const Eo *obj, Eina_Bool screen_coords, int *x, int *y, int *width, int *height);
</code>
===== Implemented by =====
* **Efl.Access.Image.extents**

30
pages/develop/api/efl/access/image/property/locale.txt
View File

@ -1,30 +0,0 @@
~~Title: Efl.Access.Image.locale~~
===== Values =====
* **locale** - %%Locale of description%%
\\ {{page>:develop:api-include:efl:access:image:property:locale:description&nouser&nolink&nodate}}
===== Signature =====
<code>
@property locale @beta {
get @protected {
values {
locale: free(string, free);
}
}
}
</code>
===== C signature =====
<code c>
const char *efl_access_image_locale_get(const Eo *obj);
</code>
===== Implemented by =====
* **Efl.Access.Image.locale**

32
pages/develop/api/efl/access/method/attribute_append.txt
View File

@ -1,32 +0,0 @@
~~Title: Efl.Access.attribute_append~~
===== Description =====
%%Add key-value pair identifying object extra attributes%%
{{page>:develop:api-include:efl:access:method:attribute_append:description&nouser&nolink&nodate}}
===== Signature =====
<code>
attribute_append {
params {
@in key: free(string, free);
@in value: free(string, free);
}
}
</code>
===== C signature =====
<code c>
void efl_access_attribute_append(Eo *obj, const char *key, const char *value);
</code>
===== Parameters =====
* **key** //(in)// - %%The string key to give extra information%%
* **value** //(in)// - %%The string value to give extra information%%
===== Implemented by =====
* **Efl.Access.attribute_append**

24
pages/develop/api/efl/access/method/attributes_clear.txt
View File

@ -1,24 +0,0 @@
~~Title: Efl.Access.attributes_clear~~
===== Description =====
%%Removes all attributes in accessible object.%%
%%@internal%%
{{page>:develop:api-include:efl:access:method:attributes_clear:description&nouser&nolink&nodate}}
===== Signature =====
<code>
attributes_clear {}
</code>
===== C signature =====
<code c>
void efl_access_attributes_clear(Eo *obj);
</code>
===== Implemented by =====
* **Efl.Access.attributes_clear**

24
pages/develop/api/efl/access/method/destructor.txt
View File

@ -1,24 +0,0 @@
~~Title: Efl.Access.destructor~~
===== Description =====
%%Call the object's destructor.%%
%%Should not be used with #eo_do. Only use it with #eo_do_super.%%
{{page>:develop:api-include:efl:access:method:destructor:description&nouser&nolink&nodate}}
//Overridden from [[:develop:api:efl:object:method:destructor|Efl.Object.destructor]].//===== Signature =====
<code>
destructor {}
</code>
===== C signature =====
<code c>
void efl_destructor(Eo *obj);
</code>
===== Implemented by =====
* [[:develop:api:efl:object:method:destructor|Efl.Object.destructor]]

34
pages/develop/api/efl/access/method/event_emit.txt
View File

@ -1,34 +0,0 @@
~~Title: Efl.Access.event_emit~~
===== Description =====
%%Emit event%%
{{page>:develop:api-include:efl:access:method:event_emit:description&nouser&nolink&nodate}}
===== Signature =====
<code>
event_emit @beta @protected @class {
params {
@in accessible: free(Efl.Access, efl_del);
@in event: ptr(const(Efl.Event.Description));
@in event_info: void_ptr;
}
}
</code>
===== C signature =====
<code c>
void efl_access_event_emit(Efl_Class *klass, Efl_Access *accessible, const Efl_Event_Description *event, void *event_info);
</code>
===== Parameters =====
* **accessible** //(in)// - %%Accessibility object.%%
* **event** //(in)// - %%Accessibility event type.%%
* **event_info** //(in)// - %%Accessibility event details.%%
===== Implemented by =====
* **Efl.Access.event_emit**

33
pages/develop/api/efl/access/method/event_handler_add.txt
View File

@ -1,33 +0,0 @@
~~Title: Efl.Access.event_handler_add~~
===== Description =====
%%Register accessibility event listener%%
{{page>:develop:api-include:efl:access:method:event_handler_add:description&nouser&nolink&nodate}}
===== Signature =====
<code>
event_handler_add @beta @protected @class {
params {
@in cb: Efl_Event_Cb;
@in data: void_ptr;
}
return: ptr(Efl.Access.Event.Handler);
}
</code>
===== C signature =====
<code c>
Efl_Access_Event_Handler *efl_access_event_handler_add(Efl_Class *klass, Efl_Event_Cb cb, void *data);
</code>
===== Parameters =====
* **cb** //(in)// - %%Callback%%
* **data** //(in)// - %%Data%%
===== Implemented by =====
* **Efl.Access.event_handler_add**

30
pages/develop/api/efl/access/method/event_handler_del.txt
View File

@ -1,30 +0,0 @@
~~Title: Efl.Access.event_handler_del~~
===== Description =====
%%Deregister accessibility event listener%%
{{page>:develop:api-include:efl:access:method:event_handler_del:description&nouser&nolink&nodate}}
===== Signature =====
<code>
event_handler_del @beta @protected @class {
params {
@in handler: ptr(Efl.Access.Event.Handler);
}
}
</code>
===== C signature =====
<code c>
void efl_access_event_handler_del(Efl_Class *klass, Efl_Access_Event_Handler *handler);
</code>
===== Parameters =====
* **handler** //(in)// - %%Event handler%%
===== Implemented by =====
* **Efl.Access.event_handler_del**

39
pages/develop/api/efl/access/method/relationship_append.txt
View File

@ -1,39 +0,0 @@
~~Title: Efl.Access.relationship_append~~
===== Description =====
%%Defines the relationship between two accessible objects.%%
%%Adds a unique relationship between source object and relation_object of a given type.%%
%%Relationships can be queried by Assistive Technology clients to provide customized feedback, improving overall user experience.%%
%%Relationship_append API is asymmetric, which means that appending, for example, relation EFL_ACCESS_RELATION_FLOWS_TO from object A to B, do NOT append relation EFL_ACCESS_RELATION_FLOWS_FROM from object B to object A.%%
{{page>:develop:api-include:efl:access:method:relationship_append:description&nouser&nolink&nodate}}
===== Signature =====
<code>
relationship_append @beta {
params {
@in type: Efl.Access.Relation_Type;
@in relation_object: free(const(Efl.Access), efl_del);
}
return: bool;
}
</code>
===== C signature =====
<code c>
Eina_Bool efl_access_relationship_append(Eo *obj, Efl_Access_Relation_Type type, const Efl_Access *relation_object);
</code>
===== Parameters =====
* **type** //(in)// - %%Relation type%%
* **relation_object** //(in)// - %%Object to relate to%%
===== Implemented by =====
* **Efl.Access.relationship_append**

34
pages/develop/api/efl/access/method/relationship_remove.txt
View File

@ -1,34 +0,0 @@
~~Title: Efl.Access.relationship_remove~~
===== Description =====
%%Removes the relationship between two accessible objects.%%
%%If relation_object is NULL function removes all relations of the given type.%%
{{page>:develop:api-include:efl:access:method:relationship_remove:description&nouser&nolink&nodate}}
===== Signature =====
<code>
relationship_remove @beta {
params {
@in type: Efl.Access.Relation_Type;
@in relation_object: free(const(Efl.Access), efl_del);
}
}
</code>
===== C signature =====
<code c>
void efl_access_relationship_remove(Eo *obj, Efl_Access_Relation_Type type, const Efl_Access *relation_object);
</code>
===== Parameters =====
* **type** //(in)// - %%Relation type%%
* **relation_object** //(in)// - %%Object to remove relation from%%
===== Implemented by =====
* **Efl.Access.relationship_remove**

22
pages/develop/api/efl/access/method/relationships_clear.txt
View File

@ -1,22 +0,0 @@
~~Title: Efl.Access.relationships_clear~~
===== Description =====
%%Removes all relationships in accessible object.%%
{{page>:develop:api-include:efl:access:method:relationships_clear:description&nouser&nolink&nodate}}
===== Signature =====
<code>
relationships_clear @beta {}
</code>
===== C signature =====
<code c>
void efl_access_relationships_clear(Eo *obj);
</code>
===== Implemented by =====
* **Efl.Access.relationships_clear**

494
pages/develop/api/efl/access/object.txt Normal file
View File

@ -0,0 +1,494 @@
~~Title: Efl.Access.Object~~
====== Efl.Access.Object (mixin) ======
''beta'' This class is still in beta, api will probably change
%%Accessibility accessible mixin%%
{{page>:develop:api-include:efl:access:efl.access.object:{section}&nouser&nolink&nodate}}
===== Properties =====
{{anchor:localized_role_name}}
**[[:develop:api:efl:access:Object#localized_role_name|localized_role_name]]** (string) ''read only'' \\
>
++++ more... |
^ values ^ type ^ description ^
|**localized_name**|[[:develop:api:string|string]]|%%Localized accessible object role name%%|
++++
{{anchor:i18n_name}}
**[[:develop:api:efl:access:Object#i18n_name|i18n_name]]** (string) ''rw'' \\
> %%Accessible name of the object.%% //Since None//
++++ more... |
^ values ^ type ^ description ^
|**i18n_name**|[[:develop:api:string|string]]|%%Accessible name%%|
++++
{{anchor:role}}
**[[:develop:api:efl:access:Object#role|role]]** (Role) ''rw'' \\
> %%The role of the object in accessibility domain.%% //Since None//
++++ more... |
^ values ^ type ^ description ^
|**role**|[[:develop:api:efl:access:Role|Efl.Access.Role]]|%%Accessible role%%|
++++
{{anchor:access_children}}
**[[:develop:api:efl:access:Object#access_children|access_children]]** (list) ''read only'' \\
>
++++ more... |
^ values ^ type ^ description ^
|**children**|[[:develop:api:list|list]]|%%List of widget's children%%|
++++
{{anchor:role_name}}
**[[:develop:api:efl:access:Object#role_name|role_name]]** (string) ''read only'' \\
>
++++ more... |
^ values ^ type ^ description ^
|**role_name**|[[:develop:api:string|string]]|%%Accessible role name%%|
++++
{{anchor:attributes}}
**[[:develop:api:efl:access:Object#attributes|attributes]]** (list) ''read only'' \\
>
++++ more... |
^ values ^ type ^ description ^
|**attributes**|[[:develop:api:list|list]]|%%List of object attributes. Must be freed by the user%%|
++++
{{anchor:reading_info_type}}
**[[:develop:api:efl:access:Object#reading_info_type|reading_info_type]]** (Type) ''rw'' ''protected get'' ''protected set'' \\
> %%Reading information of an accessible object.%% //Since None//
++++ more... |
%%If no reading information is set, 0 is returned which means all four reading information types will be read from object highlight. If set to 0, existing reading info will be deleted.%%
^ values ^ type ^ description ^
|**reading_info**|[[:develop:api:efl:access:reading:info:Type|Efl.Access.Reading.Info.Type]]|%%Reading information types%%|
++++
{{anchor:index_in_parent}}
**[[:develop:api:efl:access:Object#index_in_parent|index_in_parent]]** (int) ''read only'' \\
>
++++ more... |
^ values ^ type ^ description ^
|**idx**|[[:develop:api:int|int]]|%%Index in children list%%|
++++
{{anchor:description}}
**[[:develop:api:efl:access:Object#description|description]]** (string) ''rw'' \\
> %%Contextual information about object.%% //Since None//
++++ more... |
^ values ^ type ^ description ^
|**description**|[[:develop:api:string|string]]|%%Accessible contextual information%%|
++++
{{anchor:state_set}}
**[[:develop:api:efl:access:Object#state_set|state_set]]** (State_Set) ''read only'' \\
>
++++ more... |
^ values ^ type ^ description ^
|**states**|[[:develop:api:efl:access:State_Set|Efl.Access.State_Set]]|%%Accessible state set%%|
++++
{{anchor:translation_domain}}
**[[:develop:api:efl:access:Object#translation_domain|translation_domain]]** (string) ''rw'' \\
> %%The translation domain of "name" and "description" properties.%% //Since None//
++++ more... |
%%Translation domain should be set if the application wants to support i18n for accessibility "name" and "description" properties.%%
%%When translation domain is set, values of "name" and "description" properties will be translated with the dgettext function using the current translation domain as the "domainname" parameter.%%
%%It is the application developer's responsibility to ensure that translation files are loaded and bound to the translation domain when accessibility is enabled.%%
^ values ^ type ^ description ^
|**domain**|[[:develop:api:string|string]]|%%Translation domain%%|
++++
{{anchor:access_type}}
**[[:develop:api:efl:access:Object#access_type|access_type]]** (Type) ''rw'' \\
> %%Type of accessibility object%% //Since None//
++++ more... |
^ values ^ type ^ description ^
|**type**|[[:develop:api:efl:access:Type|Efl.Access.Type]]|%%Object type%%|
++++
{{anchor:access_root}}
**[[:develop:api:efl:access:Object#access_root|access_root]]** (Object) ''read only'' ''static method'' \\
>
++++ more... |
^ values ^ type ^ description ^
|**ret**|[[:develop:api:efl:Object|Efl.Object]]|%%Root object%%|
++++
===== Methods =====
{{anchor:relations_get}}
**[[:develop:api:efl:access:Object#relations_get|relations_get]]** () => //iterator// ''protected'' \\
> %%Gets an all relations between accessible object and other accessible objects.%% //Since None//
++++ more... |
**This function does not accept any parameter.**
^ return ^ description ^
|**[[:develop:api:iterator|iterator]]**|%%Accessible relation set%% |
++++
{{anchor:attribute_append}}
**[[:develop:api:efl:access:Object#attribute_append|attribute_append]]** (//string// ''in'' **key**, //string// ''in'' **value**) => //None// \\
> %%Add key-value pair identifying object extra attributes%% //Since None//
++++ more... |
^ parameters ^ type ^ description ^
| ''in'' **key**|[[:develop:api:string|string]] |%%The string key to give extra information%% |
| ''in'' **value**|[[:develop:api:string|string]] |%%The string value to give extra information%% |
**This function does not return anything.**
++++
{{anchor:attribute_del}}
**[[:develop:api:efl:access:Object#attribute_del|attribute_del]]** (//string// ''in'' **key**) => //None// \\
> %%delete key-value pair identifying object extra attributes when key is given%% //Since None//
++++ more... |
^ parameters ^ type ^ description ^
| ''in'' **key**|[[:develop:api:string|string]] |%%The string key to identify the key-value pair%% |
**This function does not return anything.**
++++
{{anchor:attributes_clear}}
**[[:develop:api:efl:access:Object#attributes_clear|attributes_clear]]** () => //None// \\
> %%Removes all attributes in accessible object.%% //Since None//
++++ more... |
**This function does not accept any parameter.**
**This function does not return anything.**
++++
{{anchor:event_handler_add}}
**[[:develop:api:efl:access:Object#event_handler_add|event_handler_add]]** (//Event_Cb// ''in'' **cb**, //void_ptr// ''in'' **data**) => //Handler// ''static method'' ''protected'' \\
> %%Register accessibility event listener%% //Since None//
++++ more... |
^ parameters ^ type ^ description ^
| ''in'' **cb**|[[:develop:api:efl:Event_Cb|Efl.Event_Cb]] |%%Callback%% |
| ''in'' **data**|[[:develop:api:void_ptr|void_ptr]] |%%Data%% |
^ return ^ description ^
|**[[:develop:api:efl:access:event:Handler|Efl.Access.Event.Handler]]**|%%Event handler%% |
++++
{{anchor:event_handler_del}}
**[[:develop:api:efl:access:Object#event_handler_del|event_handler_del]]** (//Handler// ''in'' **handler**) => //None// ''static method'' ''protected'' \\
> %%Deregister accessibility event listener%% //Since None//
++++ more... |
^ parameters ^ type ^ description ^
| ''in'' **handler**|[[:develop:api:efl:access:event:Handler|Efl.Access.Event.Handler]] |%%Event handler%% |
**This function does not return anything.**
++++
{{anchor:event_emit}}
**[[:develop:api:efl:access:Object#event_emit|event_emit]]** (//Object// ''in'' **accessible**, //Event_Description// ''in'' **event**, //void_ptr// ''in'' **event_info**) => //None// ''static method'' ''protected'' \\
> %%Emit event%% //Since None//
++++ more... |
^ parameters ^ type ^ description ^
| ''in'' **accessible**|[[:develop:api:efl:access:Object|Efl.Access.Object]] |%%Accessibility object.%% |
| ''in'' **event**|[[:develop:api:efl:Event_Description|Efl.Event_Description]] |%%Accessibility event type.%% |
| ''in'' **event_info**|[[:develop:api:void_ptr|void_ptr]] |%%Accessibility event details.%% |
**This function does not return anything.**
++++
{{anchor:relationship_append}}
**[[:develop:api:efl:access:Object#relationship_append|relationship_append]]** (//Relation_Type// ''in'' **type**, //Object// ''in'' **relation_object**) => //bool// \\
> %%Defines the relationship between two accessible objects.%% //Since None//
++++ more... |
%%Adds a unique relationship between source object and relation_object of a given type.%%
%%Relationships can be queried by Assistive Technology clients to provide customized feedback, improving overall user experience.%%
%%Relationship_append API is asymmetric, which means that appending, for example, relation EFL_ACCESS_RELATION_TYPE_FLOWS_TO from object A to B, do NOT append relation EFL_ACCESS_RELATION_TYPE_FLOWS_FROM from object B to object A.%%
^ parameters ^ type ^ description ^
| ''in'' **type**|[[:develop:api:efl:access:Relation_Type|Efl.Access.Relation_Type]] |%%Relation type%% |
| ''in'' **relation_object**|[[:develop:api:efl:access:Object|Efl.Access.Object]] |%%Object to relate to%% |
^ return ^ description ^
|**[[:develop:api:bool|bool]]**|''true''%% if relationship was successfully appended, %%''false''%% otherwise%% |
++++
{{anchor:relationship_remove}}
**[[:develop:api:efl:access:Object#relationship_remove|relationship_remove]]** (//Relation_Type// ''in'' **type**, //Object// ''in'' **relation_object**) => //None// \\
> %%Removes the relationship between two accessible objects.%% //Since None//
++++ more... |
%%If relation_object is %%''NULL''%% function removes all relations of the given type.%%
^ parameters ^ type ^ description ^
| ''in'' **type**|[[:develop:api:efl:access:Relation_Type|Efl.Access.Relation_Type]] |%%Relation type%% |
| ''in'' **relation_object**|[[:develop:api:efl:access:Object|Efl.Access.Object]] |%%Object to remove relation from%% |
**This function does not return anything.**
++++
{{anchor:relationships_clear}}
**[[:develop:api:efl:access:Object#relationships_clear|relationships_clear]]** () => //None// \\
> %%Removes all relationships in accessible object.%% //Since None//
++++ more... |
**This function does not accept any parameter.**
**This function does not return anything.**
++++
{{anchor:destructor}}
**[[:develop:api:efl:Object#destructor|destructor]]** () => //None// //[Overridden from [[:develop:api:efl:object|Efl.Object]]]// \\
>
++++ more... |
**This function does not accept any parameter.**
**This function does not return anything.**
++++
{{anchor:invalidate}}
**[[:develop:api:efl:Object#invalidate|invalidate]]** () => //None// //[Overridden from [[:develop:api:efl:object|Efl.Object]]]// \\
>
++++ more... |
**This function does not accept any parameter.**
**This function does not return anything.**
++++
{{anchor:provider_find}}
**[[:develop:api:efl:Object#provider_find|provider_find]]** (//Class// ''in'' **klass**) => //Object// //[Overridden from [[:develop:api:efl:object|Efl.Object]]]// \\
>
++++ more... |
^ parameters ^ type ^ description ^
| ''in'' **klass**|[[:develop:api:efl:Class|Efl.Class]] |%%The class identifier to search for.%% |
^ return ^ description ^
|**[[:develop:api:efl:Object|Efl.Object]]**|%%Object from the provider list.%% |
++++
===== Inherited members =====
No extensions defined in this class.
===== Events =====
^ Local implemented ^^ event info ^
| {{anchor:event_property_changed}}''property,changed'' | %%Called when property has changed%% | [[:develop:api:string|string]] |
| {{anchor:event_children_changed}}''children,changed'' | %%Called when children have changed%% | [[:develop:api:efl:access:event:children_changed:Data|Efl.Access.Event.Children_Changed.Data]] |
| {{anchor:event_state_changed}}''state,changed'' | %%Called when state has changed%% | [[:develop:api:efl:access:event:state_changed:Data|Efl.Access.Event.State_Changed.Data]] |
| {{anchor:event_bounds_changed}}''bounds,changed'' | %%Called when boundaries have changed%% | [[:develop:api:efl:access:event:geometry_changed:Data|Efl.Access.Event.Geometry_Changed.Data]] |
| {{anchor:event_visible_data_changed}}''visible,data,changed'' | %%Called when visibility has changed%% | None |
| {{anchor:event_active_descendant_changed}}''active,descendant,changed'' | %%Called when active state of descendant has changed%% | [[:develop:api:efl:Object|Efl.Object]] |
| {{anchor:event_added}}''added'' | %%Called when item is added%% | None |
| {{anchor:event_removed}}''removed'' | %%Called when item is removed%% | None |
No events defined in this class.

30
pages/develop/api/efl/access/property/attributes.txt
View File

@ -1,30 +0,0 @@
~~Title: Efl.Access.attributes~~
===== Values =====
* **attributes** - %%List of object attributes, Must be freed by the user%%
\\ {{page>:develop:api-include:efl:access:property:attributes:description&nouser&nolink&nodate}}
===== Signature =====
<code>
@property attributes @beta {
get @protected {
values {
attributes: free(list<ptr(Efl.Access.Attribute)>, eina_list_free);
}
}
}
</code>
===== C signature =====
<code c>
Eina_List *efl_access_attributes_get(const Eo *obj);
</code>
===== Implemented by =====
* **Efl.Access.attributes**

30
pages/develop/api/efl/access/property/children.txt
View File

@ -1,30 +0,0 @@
~~Title: Efl.Access.children~~
===== Values =====
* **children** - %%List of widget's children%%
\\ {{page>:develop:api-include:efl:access:property:children:description&nouser&nolink&nodate}}
===== Signature =====
<code>
@property children @beta {
get @protected {
values {
children: free(list<free(Efl.Access, efl_del)>, eina_list_free);
}
}
}
</code>
===== C signature =====
<code c>
Eina_List *efl_access_children_get(const Eo *obj);
</code>
===== Implemented by =====
* **Efl.Access.children**

38
pages/develop/api/efl/access/property/description.txt
View File

@ -1,38 +0,0 @@
~~Title: Efl.Access.description~~
===== Description =====
%%Contextual information about object.%%
{{page>:develop:api-include:efl:access:property:description:description&nouser&nolink&nodate}}
===== Values =====
* **description** - %%Accessible contextual information%%
===== Signature =====
<code>
@property description @beta {
get {
values {
description: free(string, free);
}
}
set {
values {
description: free(string, free);
}
}
}
</code>
===== C signature =====
<code c>
const char *efl_access_description_get(const Eo *obj);
void efl_access_description_set(Eo *obj, const char *description);
</code>
===== Implemented by =====
* **Efl.Access.description**

30
pages/develop/api/efl/access/property/index_in_parent.txt
View File

@ -1,30 +0,0 @@
~~Title: Efl.Access.index_in_parent~~
===== Values =====
* **idx** - %%Index in children list%%
\\ {{page>:develop:api-include:efl:access:property:index_in_parent:description&nouser&nolink&nodate}}
===== Signature =====
<code>
@property index_in_parent @beta {
get @protected {
values {
idx: int;
}
}
}
</code>
===== C signature =====
<code c>
int efl_access_index_in_parent_get(const Eo *obj);
</code>
===== Implemented by =====
* **Efl.Access.index_in_parent**

30
pages/develop/api/efl/access/property/localized_role_name.txt
View File

@ -1,30 +0,0 @@
~~Title: Efl.Access.localized_role_name~~
===== Values =====
* **localized_name** - %%Localized accessible object role name%%
\\ {{page>:develop:api-include:efl:access:property:localized_role_name:description&nouser&nolink&nodate}}
===== Signature =====
<code>
@property localized_role_name @beta {
get @protected {
values {
localized_name: free(string, free);
}
}
}
</code>
===== C signature =====
<code c>
const char *efl_access_localized_role_name_get(const Eo *obj);
</code>
===== Implemented by =====
* **Efl.Access.localized_role_name**

38
pages/develop/api/efl/access/property/name.txt
View File

@ -1,38 +0,0 @@
~~Title: Efl.Access.name~~
===== Description =====
%%Accessible name of the object.%%
{{page>:develop:api-include:efl:access:property:name:description&nouser&nolink&nodate}}
===== Values =====
* **name** - %%Accessible name%%
===== Signature =====
<code>
@property name @beta {
get {
values {
name: free(string, free);
}
}
set {
values {
name: free(string, free);
}
}
}
</code>
===== C signature =====
<code c>
const char *efl_access_name_get(const Eo *obj);
void efl_access_name_set(Eo *obj, const char *name);
</code>
===== Implemented by =====
* **Efl.Access.name**

38
pages/develop/api/efl/access/property/parent.txt
View File

@ -1,38 +0,0 @@
~~Title: Efl.Access.parent~~
===== Description =====
%%Object's accessible parent.%%
{{page>:develop:api-include:efl:access:property:parent:description&nouser&nolink&nodate}}
===== Values =====
* **parent** - %%Accessible parent%%
===== Signature =====
<code>
@property parent @beta {
get {
values {
parent: free(Efl.Access, efl_del);
}
}
set {
values {
parent: free(Efl.Access, efl_del);
}
}
}
</code>
===== C signature =====
<code c>
Efl_Access *efl_access_parent_get(const Eo *obj);
void efl_access_parent_set(Eo *obj, Efl_Access *parent);
</code>
===== Implemented by =====
* **Efl.Access.parent**

52
pages/develop/api/efl/access/property/reading_info_type.txt
View File

@ -1,52 +0,0 @@
~~Title: Efl.Access.reading_info_type~~
===== Description =====
{{page>:develop:api-include:efl:access:property:reading_info_type:description&nouser&nolink&nodate}}
===== Values =====
* **reading_info** - %%Reading information types%%
==== Getter ====
%%Gets reading information types of an accessible object.%%
{{page>:develop:api-include:efl:access:property:reading_info_type:getter_description&nouser&nolink&nodate}}
==== Setter ====
%%Sets reading information of an accessible object.%%
{{page>:develop:api-include:efl:access:property:reading_info_type:getter_description&nouser&nolink&nodate}}
===== Signature =====
<code>
@property reading_info_type @protected {
get {
values {
reading_info: Efl.Access.Reading.Info.Type;
}
}
set {
values {
reading_info: Efl.Access.Reading.Info.Type;
}
}
}
</code>
===== C signature =====
<code c>
Efl_Access_Reading_Info_Type efl_access_reading_info_type_get(const Eo *obj);
void efl_access_reading_info_type_set(Eo *obj, Efl_Access_Reading_Info_Type reading_info);
</code>
===== Implemented by =====
* **Efl.Access.reading_info_type**

30
pages/develop/api/efl/access/property/relation_set.txt
View File

@ -1,30 +0,0 @@
~~Title: Efl.Access.relation_set~~
===== Values =====
* **relations** - %%Accessible relation set%%
\\ {{page>:develop:api-include:efl:access:property:relation_set:description&nouser&nolink&nodate}}
===== Signature =====
<code>
@property relation_set @beta {
get @protected {
values {
relations: free(Efl.Access.Relation_Set, eina_list_free);
}
}
}
</code>
===== C signature =====
<code c>
Efl_Access_Relation_Set efl_access_relation_set_get(const Eo *obj);
</code>
===== Implemented by =====
* **Efl.Access.relation_set**

38
pages/develop/api/efl/access/property/role.txt
View File

@ -1,38 +0,0 @@
~~Title: Efl.Access.role~~
===== Description =====
%%The role of the object in accessibility domain.%%
{{page>:develop:api-include:efl:access:property:role:description&nouser&nolink&nodate}}
===== Values =====
* **role** - %%Accessible role%%
===== Signature =====
<code>
@property role @beta {
get {
values {
role: Efl.Access.Role;
}
}
set {
values {
role: Efl.Access.Role;
}
}
}
</code>
===== C signature =====
<code c>
Efl_Access_Role efl_access_role_get(const Eo *obj);
void efl_access_role_set(Eo *obj, Efl_Access_Role role);
</code>
===== Implemented by =====
* **Efl.Access.role**

30
pages/develop/api/efl/access/property/role_name.txt
View File

@ -1,30 +0,0 @@
~~Title: Efl.Access.role_name~~
===== Values =====
* **role_name** - %%Accessible role name%%
\\ {{page>:develop:api-include:efl:access:property:role_name:description&nouser&nolink&nodate}}
===== Signature =====
<code>
@property role_name @beta {
get @protected {
values {
role_name: free(string, free);
}
}
}
</code>
===== C signature =====
<code c>
const char *efl_access_role_name_get(const Eo *obj);
</code>
===== Implemented by =====
* **Efl.Access.role_name**

32
pages/develop/api/efl/access/property/root.txt
View File

@ -1,32 +0,0 @@
~~Title: Efl.Access.root~~
===== Values =====
* **ret** - %%Root object%%
===== Description =====
%%Get root object of accessible object hierarchy%%
\\ {{page>:develop:api-include:efl:access:property:root:description&nouser&nolink&nodate}}
===== Signature =====
<code>
@property root @beta @class {
get {
values {
ret: free(Efl.Object, efl_del);
}
}
}
</code>
===== C signature =====
<code c>
Efl_Object *efl_access_root_get(Efl_Class *klass);
</code>
===== Implemented by =====
* **Efl.Access.root**

30
pages/develop/api/efl/access/property/state_set.txt
View File

@ -1,30 +0,0 @@
~~Title: Efl.Access.state_set~~
===== Values =====
* **states** - %%Accessible state set%%
\\ {{page>:develop:api-include:efl:access:property:state_set:description&nouser&nolink&nodate}}
===== Signature =====
<code>
@property state_set @beta {
get @protected {
values {
states: Efl.Access.State_Set;
}
}
}
</code>
===== C signature =====
<code c>
Efl_Access_State_Set efl_access_state_set_get(const Eo *obj);
</code>
===== Implemented by =====
* **Efl.Access.state_set**

44
pages/develop/api/efl/access/property/translation_domain.txt
View File

@ -1,44 +0,0 @@
~~Title: Efl.Access.translation_domain~~
===== Description =====
%%The translation domain of "name" and "description" properties.%%
%%Translation domain should be set if the application wants to support i18n for accessibily "name" and "description" properties.%%
%%When translation domain is set, values of "name" and "description" properties will be translated with the dgettext function using the current translation domain as the "domainname" parameter.%%
%%It is the application developer's responsibility to ensure that translation files are loaded and bound to the translation domain when accessibility is enabled.%%
{{page>:develop:api-include:efl:access:property:translation_domain:description&nouser&nolink&nodate}}
===== Values =====
* **domain** - %%Translation domain%%
===== Signature =====
<code>
@property translation_domain @beta {
get {
values {
domain: free(string, free);
}
}
set {
values {
domain: free(string, free);
}
}
}
</code>
===== C signature =====
<code c>
const char *efl_access_translation_domain_get(const Eo *obj);
void efl_access_translation_domain_set(Eo *obj, const char *domain);
</code>
===== Implemented by =====
* **Efl.Access.translation_domain**

38
pages/develop/api/efl/access/property/type.txt
View File

@ -1,38 +0,0 @@
~~Title: Efl.Access.type~~
===== Description =====
%%Type of accessibility object%%
{{page>:develop:api-include:efl:access:property:type:description&nouser&nolink&nodate}}
===== Values =====
* **type** - %%Object type%%
===== Signature =====
<code>
@property type @beta {
get {
values {
type: Efl.Access.Type;
}
}
set {
values {
type: Efl.Access.Type;
}
}
}
</code>
===== C signature =====
<code c>
Efl_Access_Type efl_access_type_get(const Eo *obj);
void efl_access_type_set(Eo *obj, Efl_Access_Type type);
</code>
===== Implemented by =====
* **Efl.Access.type**

38
pages/develop/api/efl/access/reading/info/type.txt
View File

@ -1,38 +0,0 @@
~~Title: Efl.Access.Reading.Info.Type~~
===== Description =====
%%The accessible Reading information type that can be read.%%
{{page>:develop:api-include:efl:access:reading:info:type:description&nouser&nolink&nodate}}
===== Fields =====
{{page>:develop:api-include:efl:access:reading:info:type:fields&nouser&nolink&nodate}}
* **name** - %%Name should be read%%
* **role** - %%Role should be read%%
* **description** - %%description should be read.%%
* **state** - %%State should be read.%%
===== Signature =====
<code>
enum Efl.Access.Reading.Info.Type {
name: 1 >> 0,
role: 1 >> 1,
description: 1 >> 2,
state: 1 >> 3
}
</code>
===== C signature =====
<code c>
typedef enum {
EFL_ACCESS_READING_INFO_TYPE_NAME = 1 /* 1 >> 0 */,
EFL_ACCESS_READING_INFO_TYPE_ROLE = 2 /* 1 >> 1 */,
EFL_ACCESS_READING_INFO_TYPE_DESCRIPTION = 4 /* 1 >> 2 */,
EFL_ACCESS_READING_INFO_TYPE_STATE = 8 /* 1 >> 3 */
} Efl_Access_Reading_Info_Type;
</code>

32
pages/develop/api/efl/access/relation.txt
View File

@ -1,32 +0,0 @@
~~Title: Efl.Access.Relation~~
===== Description =====
%%Accessibility Relation%%
{{page>:develop:api-include:efl:access:relation:description&nouser&nolink&nodate}}
===== Fields =====
{{page>:develop:api-include:efl:access:relation:fields&nouser&nolink&nodate}}
* **type** - %%Relation type%%
* **objects** - %%List with relation objects%%
===== Signature =====
<code>
struct Efl.Access.Relation {
type: Efl.Access.Relation_Type;
objects: free(list<free(Efl.Object, efl_del)>, eina_list_free);
}
</code>
===== C signature =====
<code c>
typedef struct _Efl_Access_Relation {
Efl_Access_Relation_Type type;
Eina_List *objects;
} Efl_Access_Relation;
</code>

19
pages/develop/api/efl/access/relation_set.txt
View File

@ -1,19 +0,0 @@
~~Title: Efl.Access.Relation_Set~~
===== Description =====
%%Elementary Accessibility relation set type%%
{{page>:develop:api-include:efl:access:relation_set:description&nouser&nolink&nodate}}
===== Signature =====
<code>
type @free(eina_list_free) Efl.Access.Relation_Set: free(list<ptr(Efl.Access.Relation)>, eina_list_free);
</code>
===== C signature =====
<code c>
typedef Eina_List *Efl_Access_Relation_Set;
</code>

86
pages/develop/api/efl/access/relation_type.txt
View File

@ -1,86 +0,0 @@
~~Title: Efl.Access.Relation_Type~~
===== Description =====
%%Describes the relationship between two objects.%%
{{page>:develop:api-include:efl:access:relation_type:description&nouser&nolink&nodate}}
===== Fields =====
{{page>:develop:api-include:efl:access:relation_type:fields&nouser&nolink&nodate}}
* **null** - %%No relation%%
* **label_for** - %%Label for relation%%
* **labelled_by** - %%Labelled by relation%%
* **controller_for** - %%Controller for relation%%
* **controlled_by** - %%Controlled by relation%%
* **member_of** - %%Member of relation%%
* **tooltip_for** - %%Tooltip for relation%%
* **node_child_of** - %%Node child of relation%%
* **node_parent_of** - %%Node parent of relation%%
* **extended** - %%Extended relation%%
* **flows_to** - %%Flows to relation%%
* **flows_from** - %%Flows from relation%%
* **subwindow_of** - %%Subwindow of relation%%
* **embeds** - %%Embeds relation%%
* **embedded_by** - %%Embedded by relation%%
* **popup_for** - %%Popup for relation%%
* **parent_window_of** - %%Parent window of relation%%
* **description_for** - %%Description for relation%%
* **described_by** - %%Described by relation%%
* **last_defined** - %%Last enum entry sentinel%%
===== Signature =====
<code>
enum Efl.Access.Relation_Type {
null: 0,
label_for,
labelled_by,
controller_for,
controlled_by,
member_of,
tooltip_for,
node_child_of,
node_parent_of,
extended,
flows_to,
flows_from,
subwindow_of,
embeds,
embedded_by,
popup_for,
parent_window_of,
description_for,
described_by,
last_defined
}
</code>
===== C signature =====
<code c>
typedef enum {
EFL_ACCESS_RELATION_NULL = 0,
EFL_ACCESS_RELATION_LABEL_FOR,
EFL_ACCESS_RELATION_LABELLED_BY,
EFL_ACCESS_RELATION_CONTROLLER_FOR,
EFL_ACCESS_RELATION_CONTROLLED_BY,
EFL_ACCESS_RELATION_MEMBER_OF,
EFL_ACCESS_RELATION_TOOLTIP_FOR,
EFL_ACCESS_RELATION_NODE_CHILD_OF,
EFL_ACCESS_RELATION_NODE_PARENT_OF,
EFL_ACCESS_RELATION_EXTENDED,
EFL_ACCESS_RELATION_FLOWS_TO,
EFL_ACCESS_RELATION_FLOWS_FROM,
EFL_ACCESS_RELATION_SUBWINDOW_OF,
EFL_ACCESS_RELATION_EMBEDS,
EFL_ACCESS_RELATION_EMBEDDED_BY,
EFL_ACCESS_RELATION_POPUP_FOR,
EFL_ACCESS_RELATION_PARENT_WINDOW_OF,
EFL_ACCESS_RELATION_DESCRIPTION_FOR,
EFL_ACCESS_RELATION_DESCRIBED_BY,
EFL_ACCESS_RELATION_LAST_DEFINED
} Efl_Access_Relation_Type;
</code>

338
pages/develop/api/efl/access/role.txt
View File

@ -1,338 +0,0 @@
~~Title: Efl.Access.Role~~
===== Description =====
%%Describes the role of an object visible to Accessibility Clients.%%
{{page>:develop:api-include:efl:access:role:description&nouser&nolink&nodate}}
===== Fields =====
{{page>:develop:api-include:efl:access:role:fields&nouser&nolink&nodate}}
* **invalid** - %%Role: invalid%%
* **accelerator_label** - %%Role: accelerator label%%
* **alert** - %%Role: alert%%
* **animation** - %%Role: animation%%
* **arrow** - %%Role: arrow%%
* **calendar** - %%Role: calendar%%
* **canvas** - %%Role: canvas%%
* **check_box** - %%Role: check box%%
* **check_menu_item** - %%Role: check menu item%%
* **color_chooser** - %%Role: color chooser%%
* **column_header** - %%Role: column header%%
* **combo_box** - %%Role: combo box%%
* **date_editor** - %%Role: data editor%%
* **desktop_icon** - %%Role: desktop icon%%
* **desktop_frame** - %%Role: desktop frame%%
* **dial** - %%Role: dial%%
* **dialog** - %%Role: dialog%%
* **directory_pane** - %%Role: directory pane%%
* **drawing_area** - %%Role: drawing area%%
* **file_chooser** - %%Role: file chooser%%
* **filler** - %%Role: filler%%
* **focus_traversable** - %%Role: focus traversable%%
* **font_chooser** - %%Role: font chooser%%
* **frame** - %%Role: frame%%
* **glass_pane** - %%Role: glass pane%%
* **html_container** - %%Role: HTML container%%
* **icon** - %%Role: icon%%
* **image** - %%Role: image%%
* **internal_frame** - %%Role: internal frame%%
* **label** - %%Role: label%%
* **layered_pane** - %%Role: layered pane%%
* **list** - %%Role: list%%
* **list_item** - %%Role: list item%%
* **menu** - %%Role: menu%%
* **menu_bar** - %%Role: menu bar%%
* **menu_item** - %%Role: menu item%%
* **option_pane** - %%Role: option pane%%
* **page_tab** - %%Role: page tab%%
* **page_tab_list** - %%Role: page tab list%%
* **panel** - %%Role: panel%%
* **password_text** - %%Role: password text%%
* **popup_menu** - %%Role: popup menu%%
* **progress_bar** - %%Role: progress bar%%
* **push_button** - %%Role: push button%%
* **radio_button** - %%Role: radio button%%
* **radio_menu_item** - %%Role: radio menu item%%
* **root_pane** - %%Role: root pane%%
* **row_header** - %%Role: row header%%
* **scroll_bar** - %%Role: scroll bar%%
* **scroll_pane** - %%Role: scroll pane%%
* **separator** - %%Role: separator%%
* **slider** - %%Role: slider%%
* **spin_button** - %%Role: spin button%%
* **split_pane** - %%Role: split pane%%
* **status_bar** - %%Role: status bar%%
* **table** - %%Role: table%%
* **table_cell** - %%Role: table cell%%
* **table_column_header** - %%Role: table column header%%
* **table_row_header** - %%Role: table row header%%
* **tearoff_menu_item** - %%Role: tearoff menu item%%
* **terminal** - %%Role: terminal%%
* **text** - %%Role: text%%
* **toggle_button** - %%Role: toggle button%%
* **tool_bar** - %%Role: too bar%%
* **tool_tip** - %%Role: tool tip%%
* **tree** - %%Role: tree%%
* **tree_table** - %%Role: tree table%%
* **unknown** - %%Role: unknown%%
* **viewport** - %%Role: viewport%%
* **window** - %%Role: window%%
* **extended** - %%Role: extended%%
* **header** - %%Role: header%%
* **footer** - %%Role: footer%%
* **paragraph** - %%Role: paragraph%%
* **ruler** - %%Role: ruler%%
* **application** - %%Role: application%%
* **autocomplete** - %%Role: autocomplete%%
* **editbar** - %%Role: editbar%%
* **embedded** - %%Role: embedded%%
* **entry** - %%Role: entry%%
* **chart** - %%Role: chart%%
* **caption** - %%Role: caption%%
* **document_frame** - %%Role: document frame%%
* **heading** - %%Role: heading%%
* **page** - %%Role: page%%
* **section** - %%Role: section%%
* **redundant_object** - %%Role: redundant object%%
* **form** - %%Role: form%%
* **link** - %%Role: link%%
* **input_method_window** - %%Role: input method window%%
* **table_row** - %%Role: table row%%
* **tree_item** - %%Role: table item%%
* **document_spreadsheet** - %%Role: document spreadsheet%%
* **document_presentation** - %%Role: document presentation%%
* **document_text** - %%Role: document text%%
* **document_web** - %%Role: document web%%
* **document_email** - %%Role: document email%%
* **comment** - %%Role: comment%%
* **list_box** - %%Role: list box%%
* **grouping** - %%Role: grouping%%
* **image_map** - %%Role: image map%%
* **notification** - %%Role: notification%%
* **info_bar** - %%Role: info bar%%
* **last_defined** - %%Last enum entry sentinel%%
===== Signature =====
<code>
enum Efl.Access.Role {
invalid: 0,
accelerator_label,
alert,
animation,
arrow,
calendar,
canvas,
check_box,
check_menu_item,
color_chooser,
column_header,
combo_box,
date_editor,
desktop_icon,
desktop_frame,
dial,
dialog,
directory_pane,
drawing_area,
file_chooser,
filler,
focus_traversable,
font_chooser,
frame,
glass_pane,
html_container,
icon,
image,
internal_frame,
label,
layered_pane,
list,
list_item,
menu,
menu_bar,
menu_item,
option_pane,
page_tab,
page_tab_list,
panel,
password_text,
popup_menu,
progress_bar,
push_button,
radio_button,
radio_menu_item,
root_pane,
row_header,
scroll_bar,
scroll_pane,
separator,
slider,
spin_button,
split_pane,
status_bar,
table,
table_cell,
table_column_header,
table_row_header,
tearoff_menu_item,
terminal,
text,
toggle_button,
tool_bar,
tool_tip,
tree,
tree_table,
unknown,
viewport,
window,
extended,
header,
footer,
paragraph,
ruler,
application,
autocomplete,
editbar,
embedded,
entry,
chart,
caption,
document_frame,
heading,
page,
section,
redundant_object,
form,
link,
input_method_window,
table_row,
tree_item,
document_spreadsheet,
document_presentation,
document_text,
document_web,
document_email,
comment,
list_box,
grouping,
image_map,
notification,
info_bar,
last_defined
}
</code>
===== C signature =====
<code c>
typedef enum {
EFL_ACCESS_ROLE_INVALID = 0,
EFL_ACCESS_ROLE_ACCELERATOR_LABEL,
EFL_ACCESS_ROLE_ALERT,
EFL_ACCESS_ROLE_ANIMATION,
EFL_ACCESS_ROLE_ARROW,
EFL_ACCESS_ROLE_CALENDAR,
EFL_ACCESS_ROLE_CANVAS,
EFL_ACCESS_ROLE_CHECK_BOX,
EFL_ACCESS_ROLE_CHECK_MENU_ITEM,
EFL_ACCESS_ROLE_COLOR_CHOOSER,
EFL_ACCESS_ROLE_COLUMN_HEADER,
EFL_ACCESS_ROLE_COMBO_BOX,
EFL_ACCESS_ROLE_DATE_EDITOR,
EFL_ACCESS_ROLE_DESKTOP_ICON,
EFL_ACCESS_ROLE_DESKTOP_FRAME,
EFL_ACCESS_ROLE_DIAL,
EFL_ACCESS_ROLE_DIALOG,
EFL_ACCESS_ROLE_DIRECTORY_PANE,
EFL_ACCESS_ROLE_DRAWING_AREA,
EFL_ACCESS_ROLE_FILE_CHOOSER,
EFL_ACCESS_ROLE_FILLER,
EFL_ACCESS_ROLE_FOCUS_TRAVERSABLE,
EFL_ACCESS_ROLE_FONT_CHOOSER,
EFL_ACCESS_ROLE_FRAME,
EFL_ACCESS_ROLE_GLASS_PANE,
EFL_ACCESS_ROLE_HTML_CONTAINER,
EFL_ACCESS_ROLE_ICON,
EFL_ACCESS_ROLE_IMAGE,
EFL_ACCESS_ROLE_INTERNAL_FRAME,
EFL_ACCESS_ROLE_LABEL,
EFL_ACCESS_ROLE_LAYERED_PANE,
EFL_ACCESS_ROLE_LIST,
EFL_ACCESS_ROLE_LIST_ITEM,
EFL_ACCESS_ROLE_MENU,
EFL_ACCESS_ROLE_MENU_BAR,
EFL_ACCESS_ROLE_MENU_ITEM,
EFL_ACCESS_ROLE_OPTION_PANE,
EFL_ACCESS_ROLE_PAGE_TAB,
EFL_ACCESS_ROLE_PAGE_TAB_LIST,
EFL_ACCESS_ROLE_PANEL,
EFL_ACCESS_ROLE_PASSWORD_TEXT,
EFL_ACCESS_ROLE_POPUP_MENU,
EFL_ACCESS_ROLE_PROGRESS_BAR,
EFL_ACCESS_ROLE_PUSH_BUTTON,
EFL_ACCESS_ROLE_RADIO_BUTTON,
EFL_ACCESS_ROLE_RADIO_MENU_ITEM,
EFL_ACCESS_ROLE_ROOT_PANE,
EFL_ACCESS_ROLE_ROW_HEADER,
EFL_ACCESS_ROLE_SCROLL_BAR,
EFL_ACCESS_ROLE_SCROLL_PANE,
EFL_ACCESS_ROLE_SEPARATOR,
EFL_ACCESS_ROLE_SLIDER,
EFL_ACCESS_ROLE_SPIN_BUTTON,
EFL_ACCESS_ROLE_SPLIT_PANE,
EFL_ACCESS_ROLE_STATUS_BAR,
EFL_ACCESS_ROLE_TABLE,
EFL_ACCESS_ROLE_TABLE_CELL,
EFL_ACCESS_ROLE_TABLE_COLUMN_HEADER,
EFL_ACCESS_ROLE_TABLE_ROW_HEADER,
EFL_ACCESS_ROLE_TEAROFF_MENU_ITEM,
EFL_ACCESS_ROLE_TERMINAL,
EFL_ACCESS_ROLE_TEXT,
EFL_ACCESS_ROLE_TOGGLE_BUTTON,
EFL_ACCESS_ROLE_TOOL_BAR,
EFL_ACCESS_ROLE_TOOL_TIP,
EFL_ACCESS_ROLE_TREE,
EFL_ACCESS_ROLE_TREE_TABLE,
EFL_ACCESS_ROLE_UNKNOWN,
EFL_ACCESS_ROLE_VIEWPORT,
EFL_ACCESS_ROLE_WINDOW,
EFL_ACCESS_ROLE_EXTENDED,
EFL_ACCESS_ROLE_HEADER,
EFL_ACCESS_ROLE_FOOTER,
EFL_ACCESS_ROLE_PARAGRAPH,
EFL_ACCESS_ROLE_RULER,
EFL_ACCESS_ROLE_APPLICATION,
EFL_ACCESS_ROLE_AUTOCOMPLETE,
EFL_ACCESS_ROLE_EDITBAR,
EFL_ACCESS_ROLE_EMBEDDED,
EFL_ACCESS_ROLE_ENTRY,
EFL_ACCESS_ROLE_CHART,
EFL_ACCESS_ROLE_CAPTION,
EFL_ACCESS_ROLE_DOCUMENT_FRAME,
EFL_ACCESS_ROLE_HEADING,
EFL_ACCESS_ROLE_PAGE,
EFL_ACCESS_ROLE_SECTION,
EFL_ACCESS_ROLE_REDUNDANT_OBJECT,
EFL_ACCESS_ROLE_FORM,
EFL_ACCESS_ROLE_LINK,
EFL_ACCESS_ROLE_INPUT_METHOD_WINDOW,
EFL_ACCESS_ROLE_TABLE_ROW,
EFL_ACCESS_ROLE_TREE_ITEM,
EFL_ACCESS_ROLE_DOCUMENT_SPREADSHEET,
EFL_ACCESS_ROLE_DOCUMENT_PRESENTATION,
EFL_ACCESS_ROLE_DOCUMENT_TEXT,
EFL_ACCESS_ROLE_DOCUMENT_WEB,
EFL_ACCESS_ROLE_DOCUMENT_EMAIL,
EFL_ACCESS_ROLE_COMMENT,
EFL_ACCESS_ROLE_LIST_BOX,
EFL_ACCESS_ROLE_GROUPING,
EFL_ACCESS_ROLE_IMAGE_MAP,
EFL_ACCESS_ROLE_NOTIFICATION,
EFL_ACCESS_ROLE_INFO_BAR,
EFL_ACCESS_ROLE_LAST_DEFINED
} Efl_Access_Role;
</code>

68
pages/develop/api/efl/access/selection.txt
View File

@ -1,68 +0,0 @@
~~Title: Efl.Access.Selection~~
====== Efl.Access.Selection (interface) ======
===== Description =====
%%Elementary access selection interface%%
{{page>:develop:api-include:efl:access:selection:description&nouser&nolink&nodate}}
===== Members =====
**[[:develop:api:efl:access:selection:method:all_children_select|all_children_select]]** ''protected''\\
> %%Adds selection for all children%%
<code c>
Eina_Bool efl_access_selection_all_children_select(Eo *obj);
</code>
\\
**[[:develop:api:efl:access:selection:method:child_deselect|child_deselect]]** ''protected''\\
> %%Removes selection for given child index%%
<code c>
Eina_Bool efl_access_selection_child_deselect(Eo *obj, int child_index);
</code>
\\
**[[:develop:api:efl:access:selection:method:child_select|child_select]]** ''protected''\\
> %%Adds selection for given child index%%
<code c>
Eina_Bool efl_access_selection_child_select(Eo *obj, int child_index);
</code>
\\
**[[:develop:api:efl:access:selection:method:clear|clear]]** ''protected''\\
> %%Clears the current selection%%
<code c>
Eina_Bool efl_access_selection_clear(Eo *obj);
</code>
\\
**[[:develop:api:efl:access:selection:method:is_child_selected|is_child_selected]]** ''protected''\\
> %%Determines if child specified by index is selected%%
<code c>
Eina_Bool efl_access_selection_is_child_selected(Eo *obj, int child_index);
</code>
\\
**[[:develop:api:efl:access:selection:property:selected_child|selected_child]]** //**(get)**// ''protected''\\
> %%Gets child for given child index%%
<code c>
Efl_Object *efl_access_selection_selected_child_get(const Eo *obj, int selected_child_index);
</code>
\\
**[[:develop:api:efl:access:selection:method:selected_child_deselect|selected_child_deselect]]** ''protected''\\
> %%Removes selection for given child index%%
<code c>
Eina_Bool efl_access_selection_selected_child_deselect(Eo *obj, int child_index);
</code>
\\
**[[:develop:api:efl:access:selection:property:selected_children_count|selected_children_count]]** //**(get)**// ''protected''\\
> %%Gets the number of currently selected children%%
<code c>
int efl_access_selection_selected_children_count_get(const Eo *obj);
</code>
\\
===== Events =====
**[[:develop:api:efl:access:selection:event:selection_changed|selection,changed]]**\\
> %%Called when selection has been changed.%%
<code c>
EFL_ACCESS_SELECTION_EVENT_SELECTION_CHANGED(void)
</code>
\\

39
pages/develop/api/efl/access/selection/event/selection_changed.txt
View File

@ -1,39 +0,0 @@
~~Title: Efl.Access.Selection: selection,changed~~
===== Description =====
%%Called when selection has been changed.%%
{{page>:develop:api-include:efl:access:selection:event:selection_changed:description&nouser&nolink&nodate}}
===== Signature =====
<code>
selection,changed;
</code>
===== C information =====
<code c>
EFL_ACCESS_SELECTION_EVENT_SELECTION_CHANGED(void)
</code>
===== C usage =====
<code c>
static void
on_efl_access_selection_event_selection_changed(void *data, const Efl_Event *event)
{
void info = event->info;
Eo *obj = event->object;
Data *d = data;
/* event hander code */
}
static void
setup_event_handler(Eo *obj, Data *d)
{
efl_event_callback_add(obj, EFL_ACCESS_SELECTION_EVENT_SELECTION_CHANGED, on_efl_access_selection_event_selection_changed, d);
}
</code>

24
pages/develop/api/efl/access/selection/method/all_children_select.txt
View File

@ -1,24 +0,0 @@
~~Title: Efl.Access.Selection.all_children_select~~
===== Description =====
%%Adds selection for all children%%
{{page>:develop:api-include:efl:access:selection:method:all_children_select:description&nouser&nolink&nodate}}
===== Signature =====
<code>
all_children_select @beta @protected @pure_virtual {
return: bool;
}
</code>
===== C signature =====
<code c>
Eina_Bool efl_access_selection_all_children_select(Eo *obj);
</code>
===== Implemented by =====
* **Efl.Access.Selection.all_children_select**

31
pages/develop/api/efl/access/selection/method/child_deselect.txt
View File

@ -1,31 +0,0 @@
~~Title: Efl.Access.Selection.child_deselect~~
===== Description =====
%%Removes selection for given child index%%
{{page>:develop:api-include:efl:access:selection:method:child_deselect:description&nouser&nolink&nodate}}
===== Signature =====
<code>
child_deselect @beta @protected @pure_virtual {
params {
@in child_index: int;
}
return: bool;
}
</code>
===== C signature =====
<code c>
Eina_Bool efl_access_selection_child_deselect(Eo *obj, int child_index);
</code>
===== Parameters =====
* **child_index** //(in)// - %%Index of child%%
===== Implemented by =====
* **Efl.Access.Selection.child_deselect**

31
pages/develop/api/efl/access/selection/method/child_select.txt
View File

@ -1,31 +0,0 @@
~~Title: Efl.Access.Selection.child_select~~
===== Description =====
%%Adds selection for given child index%%
{{page>:develop:api-include:efl:access:selection:method:child_select:description&nouser&nolink&nodate}}
===== Signature =====
<code>
child_select @beta @protected @pure_virtual {
params {
@in child_index: int;
}
return: bool;
}
</code>
===== C signature =====
<code c>
Eina_Bool efl_access_selection_child_select(Eo *obj, int child_index);
</code>
===== Parameters =====
* **child_index** //(in)// - %%Index of child%%
===== Implemented by =====
* **Efl.Access.Selection.child_select**

24
pages/develop/api/efl/access/selection/method/clear.txt
View File

@ -1,24 +0,0 @@
~~Title: Efl.Access.Selection.clear~~
===== Description =====
%%Clears the current selection%%
{{page>:develop:api-include:efl:access:selection:method:clear:description&nouser&nolink&nodate}}
===== Signature =====
<code>
clear @beta @protected @pure_virtual {
return: bool;
}
</code>
===== C signature =====
<code c>
Eina_Bool efl_access_selection_clear(Eo *obj);
</code>
===== Implemented by =====
* **Efl.Access.Selection.clear**

31
pages/develop/api/efl/access/selection/method/is_child_selected.txt
View File

@ -1,31 +0,0 @@
~~Title: Efl.Access.Selection.is_child_selected~~
===== Description =====
%%Determines if child specified by index is selected%%
{{page>:develop:api-include:efl:access:selection:method:is_child_selected:description&nouser&nolink&nodate}}
===== Signature =====
<code>
is_child_selected @beta @protected @pure_virtual {
params {
@in child_index: int;
}
return: bool;
}
</code>
===== C signature =====
<code c>
Eina_Bool efl_access_selection_is_child_selected(Eo *obj, int child_index);
</code>
===== Parameters =====
* **child_index** //(in)// - %%Index of child%%
===== Implemented by =====
* **Efl.Access.Selection.is_child_selected**

31
pages/develop/api/efl/access/selection/method/selected_child_deselect.txt
View File

@ -1,31 +0,0 @@
~~Title: Efl.Access.Selection.selected_child_deselect~~
===== Description =====
%%Removes selection for given child index%%
{{page>:develop:api-include:efl:access:selection:method:selected_child_deselect:description&nouser&nolink&nodate}}
===== Signature =====
<code>
selected_child_deselect @beta @protected @pure_virtual {
params {
@in child_index: int;
}
return: bool;
}
</code>
===== C signature =====
<code c>
Eina_Bool efl_access_selection_selected_child_deselect(Eo *obj, int child_index);
</code>
===== Parameters =====
* **child_index** //(in)// - %%Index of child%%
===== Implemented by =====
* **Efl.Access.Selection.selected_child_deselect**

31
pages/develop/api/efl/access/selection/property/selected_child.txt
View File

@ -1,31 +0,0 @@
~~Title: Efl.Access.Selection.selected_child~~
===== Keys =====
* **selected_child_index** - %%Index of child%%
\\ {{page>:develop:api-include:efl:access:selection:property:selected_child:description&nouser&nolink&nodate}}
===== Signature =====
<code>
@property selected_child @beta @pure_virtual {
get @protected {
keys {
selected_child_index: int;
}
return: free(Efl.Object, efl_del);
}
}
</code>
===== C signature =====
<code c>
Efl_Object *efl_access_selection_selected_child_get(const Eo *obj, int selected_child_index);
</code>
===== Implemented by =====
* **Efl.Access.Selection.selected_child**

27
pages/develop/api/efl/access/selection/property/selected_children_count.txt
View File

@ -1,27 +0,0 @@
~~Title: Efl.Access.Selection.selected_children_count~~
===== Description =====
%%Gets the number of currently selected children%%
\\ {{page>:develop:api-include:efl:access:selection:property:selected_children_count:description&nouser&nolink&nodate}}
===== Signature =====
<code>
@property selected_children_count @beta @pure_virtual {
get @protected {
return: int;
}
}
</code>
===== C signature =====
<code c>
int efl_access_selection_selected_children_count_get(const Eo *obj);
</code>
===== Implemented by =====
* **Efl.Access.Selection.selected_children_count**

19
pages/develop/api/efl/access/state_set.txt
View File

@ -1,19 +0,0 @@
~~Title: Efl.Access.State_Set~~
===== Description =====
%%Accessibility object state set.%%
{{page>:develop:api-include:efl:access:state_set:description&nouser&nolink&nodate}}
===== Signature =====
<code>
type Efl.Access.State_Set: uint64;
</code>
===== C signature =====
<code c>
typedef uint64_t Efl_Access_State_Set;
</code>

152
pages/develop/api/efl/access/state_type.txt
View File

@ -1,152 +0,0 @@
~~Title: Efl.Access.State_Type~~
===== Description =====
%%Describes the possible states for an object visible to accessibility clients.%%
{{page>:develop:api-include:efl:access:state_type:description&nouser&nolink&nodate}}
===== Fields =====
{{page>:develop:api-include:efl:access:state_type:fields&nouser&nolink&nodate}}
* **invalid** - %%State: invalid%%
* **active** - %%State: active%%
* **armed** - %%State: armed%%
* **busy** - %%State: busy%%
* **checked** - %%State: checked%%
* **collapsed** - %%State: collapsed%%
* **defunct** - %%State: defunct%%
* **editable** - %%State: editable%%
* **enabled** - %%State: enabled%%
* **expandable** - %%State: expandable%%
* **expanded** - %%State: expanded%%
* **focusable** - %%State: focusable%%
* **focused** - %%State: focused%%
* **has_tooltip** - %%State: has a tooltip%%
* **horizontal** - %%State: horizontal%%
* **iconified** - %%State: iconified%%
* **modal** - %%State: modal%%
* **multi_line** - %%State: multi line%%
* **multiselectable** - %%State: multiselectable%%
* **opaque** - %%State: opaque%%
* **pressed** - %%State: pressed%%
* **resizable** - %%State: resizable%%
* **selectable** - %%State: selectable%%
* **selected** - %%State: selected%%
* **sensitive** - %%State: sensitive%%
* **showing** - %%State: showing%%
* **single_line** - %%State: single line%%
* **stale** - %%State: stale%%
* **transient** - %%State: transient%%
* **vertical** - %%State: vertical%%
* **visible** - %%State: visible%%
* **manages_descendants** - %%State: manage descendants%%
* **indeterminate** - %%State: indeterminate%%
* **required** - %%State: required%%
* **truncated** - %%State: truncated%%
* **animated** - %%State: animated%%
* **invalid_entry** - %%State: invalid entry%%
* **supports_autocompletion** - %%State: supports autocompletion%%
* **selectable_text** - %%State: selectable text%%
* **is_default** - %%State: is default%%
* **visited** - %%State: visited%%
* **last_defined** - %%Last enum entry sentinel%%
===== Signature =====
<code>
enum Efl.Access.State_Type {
invalid: 0,
active,
armed,
busy,
checked,
collapsed,
defunct,
editable,
enabled,
expandable,
expanded,
focusable,
focused,
has_tooltip,
horizontal,
iconified,
modal,
multi_line,
multiselectable,
opaque,
pressed,
resizable,
selectable,
selected,
sensitive,
showing,
single_line,
stale,
transient,
vertical,
visible,
manages_descendants,
indeterminate,
required,
truncated,
animated,
invalid_entry,
supports_autocompletion,
selectable_text,
is_default,
visited,
last_defined
}
</code>
===== C signature =====
<code c>
typedef enum {
EFL_ACCESS_STATE_INVALID = 0,
EFL_ACCESS_STATE_ACTIVE,
EFL_ACCESS_STATE_ARMED,
EFL_ACCESS_STATE_BUSY,
EFL_ACCESS_STATE_CHECKED,
EFL_ACCESS_STATE_COLLAPSED,
EFL_ACCESS_STATE_DEFUNCT,
EFL_ACCESS_STATE_EDITABLE,
EFL_ACCESS_STATE_ENABLED,
EFL_ACCESS_STATE_EXPANDABLE,
EFL_ACCESS_STATE_EXPANDED,
EFL_ACCESS_STATE_FOCUSABLE,
EFL_ACCESS_STATE_FOCUSED,
EFL_ACCESS_STATE_HAS_TOOLTIP,
EFL_ACCESS_STATE_HORIZONTAL,
EFL_ACCESS_STATE_ICONIFIED,
EFL_ACCESS_STATE_MODAL,
EFL_ACCESS_STATE_MULTI_LINE,
EFL_ACCESS_STATE_MULTISELECTABLE,
EFL_ACCESS_STATE_OPAQUE,
EFL_ACCESS_STATE_PRESSED,
EFL_ACCESS_STATE_RESIZABLE,
EFL_ACCESS_STATE_SELECTABLE,
EFL_ACCESS_STATE_SELECTED,
EFL_ACCESS_STATE_SENSITIVE,
EFL_ACCESS_STATE_SHOWING,
EFL_ACCESS_STATE_SINGLE_LINE,
EFL_ACCESS_STATE_STALE,
EFL_ACCESS_STATE_TRANSIENT,
EFL_ACCESS_STATE_VERTICAL,
EFL_ACCESS_STATE_VISIBLE,
EFL_ACCESS_STATE_MANAGES_DESCENDANTS,
EFL_ACCESS_STATE_INDETERMINATE,
EFL_ACCESS_STATE_REQUIRED,
EFL_ACCESS_STATE_TRUNCATED,
EFL_ACCESS_STATE_ANIMATED,
EFL_ACCESS_STATE_INVALID_ENTRY,
EFL_ACCESS_STATE_SUPPORTS_AUTOCOMPLETION,
EFL_ACCESS_STATE_SELECTABLE_TEXT,
EFL_ACCESS_STATE_IS_DEFAULT,
EFL_ACCESS_STATE_VISITED,
EFL_ACCESS_STATE_LAST_DEFINED
} Efl_Access_State_Type;
</code>

143
pages/develop/api/efl/access/text.txt
View File

@ -1,143 +0,0 @@
~~Title: Efl.Access.Text~~
====== Efl.Access.Text (interface) ======
===== Description =====
%%Elementary accessible text interface%%
{{page>:develop:api-include:efl:access:text:description&nouser&nolink&nodate}}
===== Members =====
**[[:develop:api:efl:access:text:property:attribute|attribute]]** //**(get)**// ''protected''\\
> %%Indicate if a text attribute with a given name is set%%
<code c>
Eina_Bool efl_access_text_attribute_get(const Eo *obj, const char *name, int *start_offset, int *end_offset, char **value);
</code>
\\
**[[:develop:api:efl:access:text:property:attributes|attributes]]** //**(get)**// ''protected''\\
> %%Gets list of all text attributes.%%
<code c>
Eina_List *efl_access_text_attributes_get(const Eo *obj, int *start_offset, int *end_offset);
</code>
\\
**[[:develop:api:efl:access:text:property:bounded_ranges|bounded_ranges]]** //**(get)**// ''protected''\\
> %%Bounded ranges%%
<code c>
Eina_List *efl_access_text_bounded_ranges_get(const Eo *obj, Eina_Bool screen_coords, Eina_Rect rect, Efl_Access_Text_Clip_Type xclip, Efl_Access_Text_Clip_Type yclip);
</code>
\\
**[[:develop:api:efl:access:text:property:caret_offset|caret_offset]]** //**(get, set)**// ''protected''\\
> %%Caret offset property%%
<code c>
int efl_access_text_caret_offset_get(const Eo *obj);
Eina_Bool efl_access_text_caret_offset_set(Eo *obj, int offset);
</code>
\\
**[[:develop:api:efl:access:text:property:character|character]]** //**(get)**// ''protected''\\
> %%Gets single character present in accessible widget's text at given offset.%%
<code c>
Eina_Unicode efl_access_text_character_get(const Eo *obj, int offset);
</code>
\\
**[[:develop:api:efl:access:text:property:character_count|character_count]]** //**(get)**// ''protected''\\
> %%Character count%%
<code c>
int efl_access_text_character_count_get(const Eo *obj);
</code>
\\
**[[:develop:api:efl:access:text:property:character_extents|character_extents]]** //**(get)**// ''protected''\\
> %%Character extents%%
<code c>
Eina_Bool efl_access_text_character_extents_get(const Eo *obj, int offset, Eina_Bool screen_coords, Eina_Rect *rect);
</code>
\\
**[[:develop:api:efl:access:text:property:default_attributes|default_attributes]]** //**(get)**// ''protected''\\
> %%Default attributes%%
<code c>
Eina_List *efl_access_text_default_attributes_get(const Eo *obj);
</code>
\\
**[[:develop:api:efl:access:text:property:offset_at_point|offset_at_point]]** //**(get)**// ''protected''\\
> %%Offset at given point%%
<code c>
int efl_access_text_offset_at_point_get(const Eo *obj, Eina_Bool screen_coords, int x, int y);
</code>
\\
**[[:develop:api:efl:access:text:property:range_extents|range_extents]]** //**(get)**// ''protected''\\
> %%Range extents%%
<code c>
Eina_Bool efl_access_text_range_extents_get(const Eo *obj, Eina_Bool screen_coords, int start_offset, int end_offset, Eina_Rect *rect);
</code>
\\
**[[:develop:api:efl:access:text:property:selection|selection]]** //**(get, set)**// ''protected''\\
> %%Selection property%%
<code c>
void efl_access_text_selection_get(const Eo *obj, int selection_number, int *start_offset, int *end_offset);
Eina_Bool efl_access_text_selection_set(Eo *obj, int selection_number, int start_offset, int end_offset);
</code>
\\
**[[:develop:api:efl:access:text:method:selection_add|selection_add]]** ''protected''\\
> %%Add selection%%
<code c>
Eina_Bool efl_access_text_selection_add(Eo *obj, int start_offset, int end_offset);
</code>
\\
**[[:develop:api:efl:access:text:method:selection_remove|selection_remove]]** ''protected''\\
> %%Remove selection%%
<code c>
Eina_Bool efl_access_text_selection_remove(Eo *obj, int selection_number);
</code>
\\
**[[:develop:api:efl:access:text:property:selections_count|selections_count]]** //**(get)**// ''protected''\\
> %%Selection count property%%
<code c>
int efl_access_text_selections_count_get(const Eo *obj);
</code>
\\
**[[:develop:api:efl:access:text:property:string|string]]** //**(get)**// ''protected''\\
> %%Gets string, start and end offset in text according to given initial offset and granularity.%%
<code c>
char *efl_access_text_string_get(const Eo *obj, Efl_Access_Text_Granularity granularity, int *start_offset, int *end_offset);
</code>
\\
**[[:develop:api:efl:access:text:property:text|text]]** //**(get)**// ''protected''\\
> %%Gets text of accessible widget.%%
<code c>
char *efl_access_text_get(const Eo *obj, int start_offset, int end_offset);
</code>
\\
===== Events =====
**[[:develop:api:efl:access:text:event:access_text_attributes_changed|access,text,attributes,changed]]**\\
> %%Text attributes have changed%%
<code c>
EFL_ACCESS_TEXT_EVENT_ACCESS_TEXT_ATTRIBUTES_CHANGED(void)
</code>
\\ **[[:develop:api:efl:access:text:event:access_text_bounds_changed|access,text,bounds,changed]]**\\
> %%Text bounds have changed%%
<code c>
EFL_ACCESS_TEXT_EVENT_ACCESS_TEXT_BOUNDS_CHANGED(void)
</code>
\\ **[[:develop:api:efl:access:text:event:access_text_caret_moved|access,text,caret,moved]]**\\
> %%Caret moved%%
<code c>
EFL_ACCESS_TEXT_EVENT_ACCESS_TEXT_CARET_MOVED(void)
</code>
\\ **[[:develop:api:efl:access:text:event:access_text_inserted|access,text,inserted]]**\\
> %%Text was inserted%%
<code c>
EFL_ACCESS_TEXT_EVENT_ACCESS_TEXT_INSERTED(void)
</code>
\\ **[[:develop:api:efl:access:text:event:access_text_removed|access,text,removed]]**\\
> %%Text was removed%%
<code c>
EFL_ACCESS_TEXT_EVENT_ACCESS_TEXT_REMOVED(void)
</code>
\\ **[[:develop:api:efl:access:text:event:access_text_selection_changed|access,text,selection,changed]]**\\
> %%Text selection has changed%%
<code c>
EFL_ACCESS_TEXT_EVENT_ACCESS_TEXT_SELECTION_CHANGED(void)
</code>
\\

32
pages/develop/api/efl/access/text/attribute.txt
View File

@ -1,32 +0,0 @@
~~Title: Efl.Access.Text.Attribute~~
===== Description =====
%%Text attribute%%
{{page>:develop:api-include:efl:access:text:attribute:description&nouser&nolink&nodate}}
===== Fields =====
{{page>:develop:api-include:efl:access:text:attribute:fields&nouser&nolink&nodate}}
* **name** - %%Text attribute name%%
* **value** - %%Text attribute value%%
===== Signature =====
<code>
struct Efl.Access.Text.Attribute {
name: free(string, free);
value: free(string, free);
}
</code>
===== C signature =====
<code c>
typedef struct _Efl_Access_Text_Attribute {
const char *name;
const char *value;
} Efl_Access_Text_Attribute;
</code>

38
pages/develop/api/efl/access/text/change_info.txt
View File

@ -1,38 +0,0 @@
~~Title: Efl.Access.Text.Change_Info~~
===== Description =====
%%Text change information%%
{{page>:develop:api-include:efl:access:text:change_info:description&nouser&nolink&nodate}}
===== Fields =====
{{page>:develop:api-include:efl:access:text:change_info:fields&nouser&nolink&nodate}}
* **content** - %%Change content%%
* **inserted** - %%%%''true''%% if text got inserted%%
* **pos** - %%Change position%%
* **len** - %%Change length%%
===== Signature =====
<code>
struct Efl.Access.Text.Change_Info {
content: free(string, free);
inserted: bool;
pos: size;
len: size;
}
</code>
===== C signature =====
<code c>
typedef struct _Efl_Access_Text_Change_Info {
const char *content;
Eina_Bool inserted;
size_t pos;
size_t len;
} Efl_Access_Text_Change_Info;
</code>

38
pages/develop/api/efl/access/text/clip_type.txt
View File

@ -1,38 +0,0 @@
~~Title: Efl.Access.Text.Clip_Type~~
===== Description =====
%%Text clip type%%
{{page>:develop:api-include:efl:access:text:clip_type:description&nouser&nolink&nodate}}
===== Fields =====
{{page>:develop:api-include:efl:access:text:clip_type:fields&nouser&nolink&nodate}}
* **none** - %%No clip type%%
* **min** - %%Minimum clip type%%
* **max** - %%Maximum clip type%%
* **both** - %%Both clip types%%
===== Signature =====
<code>
enum Efl.Access.Text.Clip_Type {
none: 0,
min,
max,
both
}
</code>
===== C signature =====
<code c>
typedef enum {
ELM_ATSPI_TEXT_CLIP_NONE = 0,
ELM_ATSPI_TEXT_CLIP_MIN,
ELM_ATSPI_TEXT_CLIP_MAX,
ELM_ATSPI_TEXT_CLIP_BOTH
} Efl_Access_Text_Clip_Type;
</code>

39
pages/develop/api/efl/access/text/event/access_text_attributes_changed.txt
View File

@ -1,39 +0,0 @@
~~Title: Efl.Access.Text: access,text,attributes,changed~~
===== Description =====
%%Text attributes have changed%%
{{page>:develop:api-include:efl:access:text:event:access_text_attributes_changed:description&nouser&nolink&nodate}}
===== Signature =====
<code>
access,text,attributes,changed;
</code>
===== C information =====
<code c>
EFL_ACCESS_TEXT_EVENT_ACCESS_TEXT_ATTRIBUTES_CHANGED(void)
</code>
===== C usage =====
<code c>
static void
on_efl_access_text_event_access_text_attributes_changed(void *data, const Efl_Event *event)
{
void info = event->info;
Eo *obj = event->object;
Data *d = data;
/* event hander code */
}
static void
setup_event_handler(Eo *obj, Data *d)
{
efl_event_callback_add(obj, EFL_ACCESS_TEXT_EVENT_ACCESS_TEXT_ATTRIBUTES_CHANGED, on_efl_access_text_event_access_text_attributes_changed, d);
}
</code>

39
pages/develop/api/efl/access/text/event/access_text_bounds_changed.txt
View File

@ -1,39 +0,0 @@
~~Title: Efl.Access.Text: access,text,bounds,changed~~
===== Description =====
%%Text bounds have changed%%
{{page>:develop:api-include:efl:access:text:event:access_text_bounds_changed:description&nouser&nolink&nodate}}
===== Signature =====
<code>
access,text,bounds,changed;
</code>
===== C information =====
<code c>
EFL_ACCESS_TEXT_EVENT_ACCESS_TEXT_BOUNDS_CHANGED(void)
</code>
===== C usage =====
<code c>
static void
on_efl_access_text_event_access_text_bounds_changed(void *data, const Efl_Event *event)
{
void info = event->info;
Eo *obj = event->object;
Data *d = data;
/* event hander code */
}
static void
setup_event_handler(Eo *obj, Data *d)
{
efl_event_callback_add(obj, EFL_ACCESS_TEXT_EVENT_ACCESS_TEXT_BOUNDS_CHANGED, on_efl_access_text_event_access_text_bounds_changed, d);
}
</code>

39
pages/develop/api/efl/access/text/event/access_text_caret_moved.txt
View File

@ -1,39 +0,0 @@
~~Title: Efl.Access.Text: access,text,caret,moved~~
===== Description =====
%%Caret moved%%
{{page>:develop:api-include:efl:access:text:event:access_text_caret_moved:description&nouser&nolink&nodate}}
===== Signature =====
<code>
access,text,caret,moved;
</code>
===== C information =====
<code c>
EFL_ACCESS_TEXT_EVENT_ACCESS_TEXT_CARET_MOVED(void)
</code>
===== C usage =====
<code c>
static void
on_efl_access_text_event_access_text_caret_moved(void *data, const Efl_Event *event)
{
void info = event->info;
Eo *obj = event->object;
Data *d = data;
/* event hander code */
}
static void
setup_event_handler(Eo *obj, Data *d)
{
efl_event_callback_add(obj, EFL_ACCESS_TEXT_EVENT_ACCESS_TEXT_CARET_MOVED, on_efl_access_text_event_access_text_caret_moved, d);
}
</code>

39
pages/develop/api/efl/access/text/event/access_text_inserted.txt
View File

@ -1,39 +0,0 @@
~~Title: Efl.Access.Text: access,text,inserted~~
===== Description =====
%%Text was inserted%%
{{page>:develop:api-include:efl:access:text:event:access_text_inserted:description&nouser&nolink&nodate}}
===== Signature =====
<code>
access,text,inserted;
</code>
===== C information =====
<code c>
EFL_ACCESS_TEXT_EVENT_ACCESS_TEXT_INSERTED(void)
</code>
===== C usage =====
<code c>
static void
on_efl_access_text_event_access_text_inserted(void *data, const Efl_Event *event)
{
void info = event->info;
Eo *obj = event->object;
Data *d = data;
/* event hander code */
}
static void
setup_event_handler(Eo *obj, Data *d)
{
efl_event_callback_add(obj, EFL_ACCESS_TEXT_EVENT_ACCESS_TEXT_INSERTED, on_efl_access_text_event_access_text_inserted, d);
}
</code>

39
pages/develop/api/efl/access/text/event/access_text_removed.txt
View File

@ -1,39 +0,0 @@
~~Title: Efl.Access.Text: access,text,removed~~
===== Description =====
%%Text was removed%%
{{page>:develop:api-include:efl:access:text:event:access_text_removed:description&nouser&nolink&nodate}}
===== Signature =====
<code>
access,text,removed;
</code>
===== C information =====
<code c>
EFL_ACCESS_TEXT_EVENT_ACCESS_TEXT_REMOVED(void)
</code>
===== C usage =====
<code c>
static void
on_efl_access_text_event_access_text_removed(void *data, const Efl_Event *event)
{
void info = event->info;
Eo *obj = event->object;
Data *d = data;
/* event hander code */
}
static void
setup_event_handler(Eo *obj, Data *d)
{
efl_event_callback_add(obj, EFL_ACCESS_TEXT_EVENT_ACCESS_TEXT_REMOVED, on_efl_access_text_event_access_text_removed, d);
}
</code>

39
pages/develop/api/efl/access/text/event/access_text_selection_changed.txt
View File

@ -1,39 +0,0 @@
~~Title: Efl.Access.Text: access,text,selection,changed~~
===== Description =====
%%Text selection has changed%%
{{page>:develop:api-include:efl:access:text:event:access_text_selection_changed:description&nouser&nolink&nodate}}
===== Signature =====
<code>
access,text,selection,changed;
</code>
===== C information =====
<code c>
EFL_ACCESS_TEXT_EVENT_ACCESS_TEXT_SELECTION_CHANGED(void)
</code>
===== C usage =====
<code c>
static void
on_efl_access_text_event_access_text_selection_changed(void *data, const Efl_Event *event)
{
void info = event->info;
Eo *obj = event->object;
Data *d = data;
/* event hander code */
}
static void
setup_event_handler(Eo *obj, Data *d)
{
efl_event_callback_add(obj, EFL_ACCESS_TEXT_EVENT_ACCESS_TEXT_SELECTION_CHANGED, on_efl_access_text_event_access_text_selection_changed, d);
}
</code>

41
pages/develop/api/efl/access/text/granularity.txt
View File

@ -1,41 +0,0 @@
~~Title: Efl.Access.Text.Granularity~~
===== Description =====
%%Text accessibility granularity%%
{{page>:develop:api-include:efl:access:text:granularity:description&nouser&nolink&nodate}}
===== Fields =====
{{page>:develop:api-include:efl:access:text:granularity:fields&nouser&nolink&nodate}}
* **char** - %%Character granularity%%
* **word** - %%Word granularity%%
* **sentence** - %%Sentence granularity%%
* **line** - %%Line granularity%%
* **paragraph** - %%Paragraph granularity%%
===== Signature =====
<code>
enum Efl.Access.Text.Granularity {
char: 0,
word,
sentence,
line,
paragraph
}
</code>
===== C signature =====
<code c>
typedef enum {
EFL_ACCESS_TEXT_GRANULARITY_CHAR = 0,
EFL_ACCESS_TEXT_GRANULARITY_WORD,
EFL_ACCESS_TEXT_GRANULARITY_SENTENCE,
EFL_ACCESS_TEXT_GRANULARITY_LINE,
EFL_ACCESS_TEXT_GRANULARITY_PARAGRAPH
} Efl_Access_Text_Granularity;
</code>

33
pages/develop/api/efl/access/text/method/selection_add.txt
View File

@ -1,33 +0,0 @@
~~Title: Efl.Access.Text.selection_add~~
===== Description =====
%%Add selection%%
{{page>:develop:api-include:efl:access:text:method:selection_add:description&nouser&nolink&nodate}}
===== Signature =====
<code>
selection_add @beta @protected @pure_virtual {
params {
@in start_offset: int;
@in end_offset: int;
}
return: bool;
}
</code>
===== C signature =====
<code c>
Eina_Bool efl_access_text_selection_add(Eo *obj, int start_offset, int end_offset);
</code>
===== Parameters =====
* **start_offset** //(in)// - %%Start selection from this offset%%
* **end_offset** //(in)// - %%End selection at this offset%%
===== Implemented by =====
* **Efl.Access.Text.selection_add**

31
pages/develop/api/efl/access/text/method/selection_remove.txt
View File

@ -1,31 +0,0 @@
~~Title: Efl.Access.Text.selection_remove~~
===== Description =====
%%Remove selection%%
{{page>:develop:api-include:efl:access:text:method:selection_remove:description&nouser&nolink&nodate}}
===== Signature =====
<code>
selection_remove @beta @protected @pure_virtual {
params {
@in selection_number: int;
}
return: bool;
}
</code>
===== C signature =====
<code c>
Eina_Bool efl_access_text_selection_remove(Eo *obj, int selection_number);
</code>
===== Parameters =====
* **selection_number** //(in)// - %%Selection number to be removed%%
===== Implemented by =====
* **Efl.Access.Text.selection_remove**

43
pages/develop/api/efl/access/text/property/attribute.txt
View File

@ -1,43 +0,0 @@
~~Title: Efl.Access.Text.attribute~~
===== Keys =====
* **name** - %%Text attribute name%%
* **start_offset** - %%Position in text from which given attribute is set.%%
* **end_offset** - %%Position in text to which given attribute is set.%%
===== Values =====
* **value** - %%Value of text attribute. Should be free()%%
===== Description =====
%%Indicate if a text attribute with a given name is set%%
\\ {{page>:develop:api-include:efl:access:text:property:attribute:description&nouser&nolink&nodate}}
===== Signature =====
<code>
@property attribute @beta @pure_virtual {
get @protected {
keys {
name: free(string, free) @nonull;
start_offset: ptr(int) @nonull;
end_offset: ptr(int);
}
values {
value: mstring;
}
return: bool;
}
}
</code>
===== C signature =====
<code c>
Eina_Bool efl_access_text_attribute_get(const Eo *obj, const char *name, int *start_offset, int *end_offset, char **value);
</code>
===== Implemented by =====
* **Efl.Access.Text.attribute**

Some files were not shown because too many files have changed in this diff Show More