305 lines
10 KiB
Plaintext
305 lines
10 KiB
Plaintext
import eina_types;
|
|
|
|
struct Eo.Event_Description {
|
|
[[This struct holds the description of a specific event.]]
|
|
name: const(char) *; [[name of the event.]]
|
|
unfreezable: bool; [[Eina_True if the event cannot be frozen.]]
|
|
legacy_is: bool; [[Internal use: if is a legacy event.]]
|
|
}
|
|
|
|
struct Eo.Event {
|
|
[[Parameter passed in event callbacks holding extra event parameters]]
|
|
obj: Eo.Base *; [[The object the event was called on.]]
|
|
desc: const(Eo.Event_Description) *; [[The event description.]]
|
|
info: void *; [[Extra event information passed by the event caller.]]
|
|
}
|
|
|
|
type Eo.Event_Cb: __builtin_event_cb; [[An event callback prototype.
|
|
return $EO_CALLBACK_STOP to stop calling additional callbacks for the event, $EO_CALLBACK_CONTINUE to continue.]]
|
|
|
|
|
|
struct Eo.Callback_Array_Item {
|
|
[[An item in an array of callback desc/func.
|
|
|
|
See also \@ref eo_event_callback_array_add.
|
|
]]
|
|
desc: const(Eo.Event_Description) *; [[The event description.]]
|
|
func: Eo.Event_Cb; [[The callback function.]]
|
|
}
|
|
|
|
struct Eo.Dbg_Info {
|
|
[[The structure for the debug info used by Eo.]]
|
|
name: Eina.Stringshare *; [[The name of the part (stringshare).]]
|
|
value: generic_value; [[The value.]]
|
|
}
|
|
|
|
|
|
type Eo.Callback_Priority: short; [[Callback priority value. Range is -32k - 32k.
|
|
The lower the number, the higher the priority.
|
|
|
|
See \@ref EO_CALLBACK_PRIORITY_AFTER,
|
|
\@ref EO_CALLBACK_PRIORITY_BEFORE
|
|
\@ref EO_CALLBACK_PRIORITY_DEFAULT
|
|
]]
|
|
|
|
abstract Eo.Base ()
|
|
{
|
|
eo_prefix: eo;
|
|
legacy_prefix: null;
|
|
|
|
methods {
|
|
@property parent {
|
|
set {
|
|
[[Set the parent of an object.
|
|
|
|
Parents keep references to their children so in order to
|
|
delete objects that have parents you need to set parent to
|
|
NULL or use eo_del() that does that for you (and also unrefs
|
|
the object).
|
|
]]
|
|
}
|
|
get {
|
|
[[Get the parent of an object]]
|
|
}
|
|
values {
|
|
parent: Eo.Base*; [[the new parent]]
|
|
}
|
|
}
|
|
@property event_global_freeze_count @class {
|
|
get {
|
|
[[Return freeze events of object.
|
|
|
|
Return event freeze count.
|
|
]]
|
|
}
|
|
values {
|
|
fcount: int; [[The event freeze count of the object]]
|
|
}
|
|
}
|
|
@property event_freeze_count {
|
|
get {
|
|
[[Return freeze events of object.
|
|
|
|
Return event freeze count.
|
|
]]
|
|
}
|
|
values {
|
|
fcount: int; [[The event freeze count of the object]]
|
|
}
|
|
}
|
|
@property finalized {
|
|
[[True if the object is already finalized, false otherwise.]]
|
|
get {
|
|
}
|
|
values {
|
|
finalized: bool;
|
|
}
|
|
}
|
|
constructor {
|
|
[[Call the object's constructor.
|
|
|
|
Should not be used with #eo_do. Only use it with #eo_do_super.
|
|
]]
|
|
return: Eo.Base *; [[The new object created, can be NULL if aborting]]
|
|
}
|
|
destructor {
|
|
[[Call the object's destructor.
|
|
|
|
Should not be used with #eo_do. Only use it with #eo_do_super.
|
|
]]
|
|
}
|
|
finalize {
|
|
[[Called at the end of #eo_add. Should not be called, just overridden.]]
|
|
return: Eo.Base *; [[The new object created, can be NULL if aborting]]
|
|
}
|
|
wref_add {
|
|
[[Add a new weak reference to obj.
|
|
|
|
This function registers the object handle pointed by wref to
|
|
obj so when obj is deleted it'll be updated to NULL. This
|
|
functions should be used when you want to keep track of an
|
|
object in a safe way, but you don't want to prevent it from
|
|
being freed.
|
|
]]
|
|
params {
|
|
@out wref: Eo.Base *;
|
|
}
|
|
}
|
|
wref_del {
|
|
[[Delete the weak reference passed.]]
|
|
params {
|
|
@in wref: Eo.Base **;
|
|
}
|
|
}
|
|
key_data_set {
|
|
[[Set generic data to object.
|
|
|
|
The user is in change to free the data.
|
|
]]
|
|
params {
|
|
@in key: const(char)*; [[the key associated with the data]]
|
|
@in data: const(void)*; [[the data to set]]
|
|
}
|
|
}
|
|
key_data_get @const {
|
|
[[Get generic data from object.]]
|
|
params {
|
|
@in key: const(char)*; [[the key associated with the data]]
|
|
}
|
|
return: void *; [[the data for the key]]
|
|
}
|
|
key_data_del {
|
|
[[Del generic data from object.]]
|
|
params {
|
|
@in key: const(char)*; [[the key associated with the data]]
|
|
}
|
|
}
|
|
event_thaw {
|
|
[[thaw events of object.
|
|
|
|
Lets event callbacks be called for the object.
|
|
]]
|
|
}
|
|
event_freeze {
|
|
[[freeze events of object.
|
|
|
|
Prevents event callbacks from being called for the object.
|
|
]]
|
|
}
|
|
event_global_thaw @class {
|
|
[[thaw events of object.
|
|
|
|
Lets event callbacks be called for the object.
|
|
]]
|
|
}
|
|
event_global_freeze @class {
|
|
[[freeze events of object.
|
|
|
|
Prevents event callbacks from being called for the object.
|
|
]]
|
|
}
|
|
event_callback_priority_add {
|
|
[[Add a callback for an event with a specific priority.
|
|
|
|
callbacks of the same priority are called in reverse order of
|
|
creation.
|
|
]]
|
|
return: bool; [[Return true when the callback has been successfully added.]]
|
|
params {
|
|
@in desc: const(Eo.Event_Description)*; [[The description of the event to listen to]]
|
|
@in priority: Eo.Callback_Priority; [[The priority of the callback]]
|
|
@in cb: Eo.Event_Cb; [[the callback to call]]
|
|
@in data: const(void)*; [[additional data to pass to the callback]]
|
|
}
|
|
}
|
|
event_callback_del {
|
|
[[Del a callback with a specific data associated to it for an event.]]
|
|
return: bool; [[Return true when the callback has been successfully removed.]]
|
|
params {
|
|
@in desc: const(Eo.Event_Description)*; [[The description of the event to listen to]]
|
|
@in func: Eo.Event_Cb; [[the callback to delete]]
|
|
@in user_data: const(void)*; [[The data to compare]]
|
|
}
|
|
}
|
|
event_callback_array_priority_add {
|
|
[[Add a callback array for an event with a specific priority.
|
|
|
|
callbacks of the same priority are called in reverse order of
|
|
creation.
|
|
]]
|
|
return: bool; [[Return true when the callback has been successfully added.]]
|
|
params {
|
|
@in array: const(Eo.Callback_Array_Item)*; [[an #Eo_Callback_Array_Item of events to listen to]]
|
|
@in priority: Eo.Callback_Priority; [[The priority of the callback]]
|
|
@in data: const(void)*; [[additional data to pass to the callback]]
|
|
}
|
|
}
|
|
event_callback_array_del {
|
|
[[Del a callback array with a specific data associated to it for an
|
|
event.
|
|
]]
|
|
return: bool; [[Return true when the callback has been successfully removed.]]
|
|
params {
|
|
@in array: const(Eo.Callback_Array_Item)*; [[an #Eo_Callback_Array_Item of events to listen to]]
|
|
@in user_data: const(void)*; [[The data to compare]]
|
|
}
|
|
}
|
|
event_callback_call {
|
|
[[Call the callbacks for an event of an object.]]
|
|
params {
|
|
@in desc: const(Eo.Event_Description)*; [[The description of the event to call]]
|
|
@in event_info: void *; [[Extra event info to pass to the callbacks]]
|
|
}
|
|
return: bool; [[$true if one of the callbacks aborted the call,
|
|
$false otherwise
|
|
]]
|
|
}
|
|
event_callback_forwarder_add {
|
|
[[Add an event callback forwarder for an event and an object.]]
|
|
params {
|
|
@in desc: const(Eo.Event_Description)*; [[The description of the event to listen to]]
|
|
@in new_obj: Eo.Base *; [[The object to emit events from]]
|
|
}
|
|
}
|
|
event_callback_forwarder_del {
|
|
[[Remove an event callback forwarder for an event and an object.]]
|
|
params {
|
|
@in desc: const(Eo.Event_Description)*; [[The description of the event to listen to]]
|
|
@in new_obj: Eo.Base *; [[The object to emit events from]]
|
|
}
|
|
}
|
|
dbg_info_get {
|
|
[[Get dbg information from the object.]]
|
|
params {
|
|
@in root_node: Eo.Dbg_Info*; [[node of the tree]]
|
|
}
|
|
}
|
|
children_iterator_new {
|
|
[[Get an iterator on all childrens]]
|
|
return: free(own(iterator<Eo.Base *> *), eina_iterator_free) @warn_unused;
|
|
}
|
|
composite_attach @beta {
|
|
[[Make an object a composite object of another.
|
|
|
|
The class of comp_obj must be part of the extensions of the class of the parent.
|
|
It is not possible to attach more then 1 composite of the same class.
|
|
This functions also sets the parent of comp_obj to parent.
|
|
|
|
See @.composite_detach, @.composite_part_is.
|
|
]]
|
|
params {
|
|
@in comp_obj: Eo.Base *; [[the object that will be used to composite the parent.]]
|
|
}
|
|
return: bool; [[$true if successful. $false otherwise.]]
|
|
}
|
|
composite_detach @beta {
|
|
[[Detach a composite object from another object.
|
|
|
|
This functions also sets the parent of comp_obj to $null.
|
|
|
|
See @.composite_attach, @.composite_part_is.
|
|
]]
|
|
params {
|
|
@in comp_obj: Eo.Base *; [[the object that will be removed from the parent.]]
|
|
}
|
|
return: bool; [[$true if successful. $false otherwise.]]
|
|
}
|
|
composite_part_is @beta {
|
|
[[Check if an object is part of a composite object.
|
|
|
|
See @.composite_attach, @.composite_part_is.
|
|
]]
|
|
return: bool; [[$true if it is. $false otherwise.]]
|
|
}
|
|
}
|
|
implements {
|
|
class.constructor;
|
|
class.destructor;
|
|
}
|
|
events {
|
|
callback,add @hot; [[A callback was added.]]
|
|
callback,del @hot; [[A callback was deleted.]]
|
|
del @hot; [[Obj is being deleted.]]
|
|
}
|
|
}
|