forked from enlightenment/efl
44 lines
1.5 KiB
Plaintext
44 lines
1.5 KiB
Plaintext
interface Efl.Pack extends Efl.Container
|
|
{
|
|
[[Common interface for objects (containers) with multiple contents
|
|
(sub-objects) which can be added and removed at runtime.
|
|
]]
|
|
methods
|
|
{
|
|
pack_clear {
|
|
[[Removes all packed sub-objects and unreferences them.]]
|
|
return: bool; [[$true on success, $false otherwise.]]
|
|
}
|
|
unpack_all {
|
|
[[Removes all packed sub-objects without unreferencing them.
|
|
|
|
Use with caution.
|
|
]]
|
|
return: bool; [[$true on success, $false otherwise.]]
|
|
}
|
|
unpack {
|
|
[[Removes an existing sub-object from the container without deleting it.]]
|
|
params {
|
|
subobj: Efl.Gfx.Entity; [[The sub-object to unpack.]]
|
|
}
|
|
return: bool; [[$false if $subobj wasn't in the container or couldn't be removed.]]
|
|
}
|
|
pack {
|
|
[[Adds a sub-object to this container.
|
|
|
|
Depending on the container this will either fill in the default
|
|
spot, replacing any already existing element or append to the end
|
|
of the container if there is no default part.
|
|
|
|
When this container is deleted, it will request deletion of the
|
|
given $subobj. Use @.unpack to remove $subobj from this container
|
|
without deleting it.
|
|
]]
|
|
params {
|
|
subobj: Efl.Gfx.Entity; [[The object to pack.]]
|
|
}
|
|
return: bool; [[$false if $subobj could not be packed.]]
|
|
}
|
|
}
|
|
}
|