forked from enlightenment/efl
efl_ui_factory: improve docs
Summary: and remove TAAABS Depends on D10038 Reviewers: segfaultxavi Reviewed By: segfaultxavi Subscribers: cedric, #reviewers, #committers Tags: #efl Differential Revision: https://phab.enlightenment.org/D10042
This commit is contained in:
parent
47ab7e1b83
commit
4672598b03
|
@ -6,7 +6,12 @@ struct @beta Efl.Ui.Factory_Item_Created_Event {
|
||||||
|
|
||||||
interface @beta Efl.Ui.Factory extends Efl.Ui.Property_Bind, Efl.Ui.Factory_Bind
|
interface @beta Efl.Ui.Factory extends Efl.Ui.Property_Bind, Efl.Ui.Factory_Bind
|
||||||
{
|
{
|
||||||
[[Efl UI factory interface]]
|
[[Interface for factory-pattern object creation.
|
||||||
|
|
||||||
|
This object represents a Factory in the factory pattern. Objects should be created via the method
|
||||||
|
@Efl.Ui.View_Factory.create_with_event, which will in turn call the necessary APIs from this interface.
|
||||||
|
Objects created this way should be removed using @.release.
|
||||||
|
]]
|
||||||
methods {
|
methods {
|
||||||
create @protected {
|
create @protected {
|
||||||
[[Create a UI object from the necessary properties in the specified model.
|
[[Create a UI object from the necessary properties in the specified model.
|
||||||
|
@ -16,14 +21,14 @@ interface @beta Efl.Ui.Factory extends Efl.Ui.Property_Bind, Efl.Ui.Factory_Bind
|
||||||
params {
|
params {
|
||||||
models: iterator<Efl.Model>; [[Efl iterator providing the model to be associated to the new item.
|
models: iterator<Efl.Model>; [[Efl iterator providing the model to be associated to the new item.
|
||||||
It should remain valid until the end of the function call.]]
|
It should remain valid until the end of the function call.]]
|
||||||
parent: Efl.Gfx.Entity; [[Efl canvas]]
|
parent: Efl.Gfx.Entity; [[Efl canvas.]]
|
||||||
}
|
}
|
||||||
return: future<Efl.Gfx.Entity>; [[Created UI object]]
|
return: future<Efl.Gfx.Entity>; [[Created UI object.]]
|
||||||
}
|
}
|
||||||
release {
|
release {
|
||||||
[[Release a UI object and disconnect from models.]]
|
[[Release a UI object and disconnect from models.]]
|
||||||
params {
|
params {
|
||||||
ui_view: Efl.Gfx.Entity; [[Efl canvas]]
|
ui_view: Efl.Gfx.Entity; [[Object to remove.]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
building @const {
|
building @const {
|
||||||
|
|
Loading…
Reference in New Issue