forked from enlightenment/efl
doc: improve single line descriptions
Summary: this patch improves single line descriptions described on T7717 Reviewers: woohyun, Hermet, myoungwoon, cedric Reviewed By: cedric Subscribers: cedric, #reviewers, #committers Tags: #efl Differential Revision: https://phab.enlightenment.org/D9795
This commit is contained in:
parent
5f263e003e
commit
c6dd9d2a64
|
@ -1,25 +1,29 @@
|
||||||
class @beta Efl.Boolean_Model extends Efl.Composite_Model
|
class @beta Efl.Boolean_Model extends Efl.Composite_Model
|
||||||
{
|
{
|
||||||
[[Efl boolean model class]]
|
[[@Efl.Model that efficiently stores boolean properties (they can only be $true or $false).
|
||||||
|
|
||||||
|
Internally the values are stored in a compact bit buffer, taking up minimum memory.
|
||||||
|
An example usage is @Efl.Ui.Select_Model.
|
||||||
|
]]
|
||||||
methods {
|
methods {
|
||||||
boolean_add {
|
boolean_add {
|
||||||
[[Add a new named boolean property with a defined default value.]]
|
[[Adds a new named boolean property with a default value.]]
|
||||||
params {
|
params {
|
||||||
@in name: string;
|
@in name: string; [[The name of the new boolean property.]]
|
||||||
@in default_value: bool;
|
@in default_value: bool; [[Default value for new boolean property.]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
boolean_del {
|
boolean_del {
|
||||||
[[Delete an existing named boolean property]]
|
[[Deletes an existing named boolean property.]]
|
||||||
params {
|
params {
|
||||||
@in name: string;
|
@in name: string; [[Name of the property to be deleted.]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
boolean_iterator_get {
|
boolean_iterator_get {
|
||||||
[[Get an iterator that will quickly find all the index with the requested value for a specific boolean.]]
|
[[Gets an iterator that will quickly find all the indices with the requested value for a specific property.]]
|
||||||
params {
|
params {
|
||||||
@in name: string;
|
@in name: string; [[The name of the property to examine.]]
|
||||||
@in request: bool;
|
@in request: bool; [[The value to look for.]]
|
||||||
}
|
}
|
||||||
return: iterator<ptr(uint64)>; [[The iterator that is valid until any change is made on the model.]]
|
return: iterator<ptr(uint64)>; [[The iterator that is valid until any change is made on the model.]]
|
||||||
}
|
}
|
||||||
|
|
|
@ -3,19 +3,19 @@ class @beta Efl.Ui.Select_Model extends Efl.Boolean_Model
|
||||||
[[Efl ui select model class]]
|
[[Efl ui select model class]]
|
||||||
methods {
|
methods {
|
||||||
selected_get {
|
selected_get {
|
||||||
[[Get an iterator of all the selected child of this model.
|
[[Gets an iterator of all the selected child of this model.
|
||||||
]]
|
]]
|
||||||
return: iterator<uint64>; [[The iterator gives indices of selected children.
|
return: iterator<uint64>; [[The iterator gives indices of selected children.
|
||||||
It is valid until any change is made on the model.]]
|
It is valid until any change is made on the model.]]
|
||||||
}
|
}
|
||||||
unselected_get {
|
unselected_get {
|
||||||
[[Get an iterator of all the child of this model that are not selected.
|
[[Gets an iterator of all the child of this model that are not selected.
|
||||||
]]
|
]]
|
||||||
return: iterator<uint64>; [[The iterator gives indices of unselected children.
|
return: iterator<uint64>; [[The iterator gives indices of unselected children.
|
||||||
It is valid until any change is made on the model.]]
|
It is valid until any change is made on the model.]]
|
||||||
}
|
}
|
||||||
@property single_selection {
|
@property single_selection {
|
||||||
[[Define if we support only one exclusive selection at a time when set to $true.
|
[[Defines if we support only one exclusive selection at a time when set to $true.
|
||||||
|
|
||||||
If disable with $false, it will have the behavior of a multi select mode.
|
If disable with $false, it will have the behavior of a multi select mode.
|
||||||
]]
|
]]
|
||||||
|
|
Loading…
Reference in New Issue