forked from enlightenment/efl
Hoversel: migrate docs.
This commit is contained in:
parent
bbb2d91891
commit
801b4d1195
|
@ -5,154 +5,85 @@ class Elm.Hoversel (Elm.Button, Evas.Selectable_Interface,
|
||||||
eo_prefix: elm_obj_hoversel;
|
eo_prefix: elm_obj_hoversel;
|
||||||
methods {
|
methods {
|
||||||
@property horizontal {
|
@property horizontal {
|
||||||
|
[[Control if the hoversel should expand horizontally.
|
||||||
|
|
||||||
|
Note: The initial button will display horizontally regradless of this setting.]]
|
||||||
set {
|
set {
|
||||||
/*@
|
|
||||||
@brief This sets the hoversel to expand horizontally.
|
|
||||||
|
|
||||||
@note The initial button will display horizontally regardless of this
|
|
||||||
setting.
|
|
||||||
|
|
||||||
@ingroup Hoversel */
|
|
||||||
}
|
}
|
||||||
get {
|
get {
|
||||||
/*@
|
|
||||||
@brief This returns whether the hoversel is set to expand horizontally.
|
|
||||||
|
|
||||||
@return If true, the hover will expand horizontally to the right.
|
|
||||||
|
|
||||||
@see elm_hoversel_horizontal_set()
|
|
||||||
|
|
||||||
@ingroup Hoversel */
|
|
||||||
}
|
}
|
||||||
values {
|
values {
|
||||||
horizontal: bool; /*@ If true, the hover will expand horizontally to the
|
horizontal: bool; [[If $true, the hover will expand horizontally to the right.]]
|
||||||
right. */
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@property hover_parent {
|
@property hover_parent {
|
||||||
set {
|
[[Control the hover parent.
|
||||||
/*@
|
|
||||||
@brief Set the Hover parent
|
|
||||||
|
|
||||||
Sets the hover parent object, the area that will be darkened when the
|
Sets the hover parent object, the area that will be darkened when the
|
||||||
hoversel is clicked. Should probably be the window that the hoversel is
|
hoversel is clicked. Should probably be the window that the hoversel is
|
||||||
in. See @ref Hover objects for more information.
|
in.]]
|
||||||
|
set {
|
||||||
@ingroup Hoversel */
|
|
||||||
}
|
}
|
||||||
get {
|
get {
|
||||||
/*@
|
|
||||||
@brief Get the Hover parent
|
|
||||||
|
|
||||||
@return The used parent
|
|
||||||
|
|
||||||
Get the hover parent object.
|
|
||||||
|
|
||||||
@see elm_hoversel_hover_parent_set()
|
|
||||||
|
|
||||||
@ingroup Hoversel */
|
|
||||||
}
|
}
|
||||||
values {
|
values {
|
||||||
parent: Evas.Object * @nullable; /*@ The parent to use */
|
parent: Evas.Object * @nullable; [[The parent to use]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@property expanded {
|
@property expanded {
|
||||||
get {
|
get {
|
||||||
/*@
|
[[Returns whether the hoversel is expanded.]]
|
||||||
@brief Returns whether the hoversel is expanded.
|
return: bool; [[$true if the hoversel is expanded or $false otherwise]]
|
||||||
|
|
||||||
@return This will return @c EINA_TRUE if the hoversel is expanded or
|
|
||||||
@c EINA_FALSE if it is not expanded.
|
|
||||||
|
|
||||||
@ingroup Hoversel */
|
|
||||||
return: bool;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@property items {
|
@property items {
|
||||||
get {
|
get {
|
||||||
/*@
|
[[Get the list of items within the given hoversel.]]
|
||||||
@brief Get the list of items within the given hoversel.
|
|
||||||
|
|
||||||
@return Returns a list of Elm.Widget_Item
|
|
||||||
|
|
||||||
@see elm_hoversel_item_add()
|
|
||||||
|
|
||||||
@ingroup Hoversel */
|
|
||||||
return: const(list<Elm.Widget_Item *>)*;
|
return: const(list<Elm.Widget_Item *>)*;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@property scroll_enabled {
|
@property scroll_enabled {
|
||||||
get {
|
[[Control wether scrolling is enabled.
|
||||||
/*@
|
|
||||||
@brief Limit the size of contents and make them scrollable.
|
|
||||||
|
|
||||||
@ingroup Hoversel */
|
This Limit the size of contents and make them scrollable.]]
|
||||||
|
get {
|
||||||
}
|
}
|
||||||
set {
|
set {
|
||||||
/*@
|
|
||||||
@brief Returns whether the contents of hoversel are scrollable or not.
|
|
||||||
|
|
||||||
@return @c EINA_TRUE scrollable. @c EINA_FALSE otherwise.
|
|
||||||
|
|
||||||
@ingroup Hoversel */
|
|
||||||
}
|
}
|
||||||
values {
|
values {
|
||||||
scroll_enabled: bool;
|
scroll_enabled: bool; [[$true if scrollable $false otherwise.]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
hover_begin {
|
hover_begin {
|
||||||
/*@
|
[[This triggers the hoversel popup from code, the same as if the user had clicked the button.]]
|
||||||
@brief This triggers the hoversel popup from code, the same as if the user
|
|
||||||
had clicked the button.
|
|
||||||
|
|
||||||
@ingroup Hoversel */
|
|
||||||
|
|
||||||
}
|
}
|
||||||
clear {
|
clear {
|
||||||
/*@
|
[[This will remove all the children items from the hoversel.
|
||||||
@brief This will remove all the children items from the hoversel.
|
|
||||||
|
|
||||||
@warning Should @b not be called while the hoversel is active; use
|
|
||||||
elm_hoversel_expanded_get() to check first.
|
|
||||||
|
|
||||||
@see elm_object_item_del()
|
|
||||||
|
|
||||||
@ingroup Hoversel */
|
|
||||||
|
|
||||||
|
Warning Should *not* be called while the hoversel is active; use
|
||||||
|
@Elm.Hoversel.expanded.get to check first.]]
|
||||||
}
|
}
|
||||||
hover_end {
|
hover_end {
|
||||||
/*@
|
[[This dismisses the hoversel popup as if the user had clicked outside the hover.]]
|
||||||
@brief This dismisses the hoversel popup as if the user had clicked
|
|
||||||
outside the hover.
|
|
||||||
|
|
||||||
@ingroup Hoversel */
|
|
||||||
|
|
||||||
}
|
}
|
||||||
item_add {
|
item_add {
|
||||||
/*@
|
[[Add an item to the hoversel button
|
||||||
@brief Add an item to the hoversel button
|
|
||||||
|
|
||||||
@return A handle to the item added.
|
|
||||||
|
|
||||||
This adds an item to the hoversel to show when it is clicked. Note: if you
|
This adds an item to the hoversel to show when it is clicked. Note: if you
|
||||||
need to use an icon from an edje file then use
|
need to use an icon from an edje file then use Elm.Hoversel_Item.icon.set
|
||||||
elm_hoversel_item_icon_set() right after this function, and set
|
right after this function, and set icon_file to $null here.]]
|
||||||
icon_file to NULL here.
|
|
||||||
|
|
||||||
|
/* FIXME: Make the hoversel_item reference in the doc a real ref. */
|
||||||
|
/* FIXME-doc
|
||||||
For more information on what @p icon_file and @p icon_type are, see the
|
For more information on what @p icon_file and @p icon_type are, see the
|
||||||
@ref Icon "icon documentation".
|
@ref Icon "icon documentation". */
|
||||||
|
return: Elm.Widget_Item *; [[A handle to the added item.]]
|
||||||
@ingroup Hoversel */
|
|
||||||
|
|
||||||
return: Elm.Widget_Item *;
|
|
||||||
params {
|
params {
|
||||||
@in label: const(char)* @optional; /*@ The text label to use for the item (NULL if not desired) */
|
@in label: const(char)* @optional; [[The text label to use for the item (NULL if not desired)]]
|
||||||
@in icon_file: const(char)* @optional; /*@ An image file path on disk to use for the icon or standard
|
@in icon_file: const(char)* @optional; [[An image file path on disk to use for the icon or standard icon name (NULL if not desired)]]
|
||||||
icon name (NULL if not desired) */
|
@in icon_type: Elm_Icon_Type; [[The icon type if relevant]]
|
||||||
@in icon_type: Elm_Icon_Type; /*@ The icon type if relevant */
|
@in func: Evas_Smart_Cb @optional; [[Convenience function to call when this item is selected. The last parameter $event_info of $func is the selected item pointer.]]
|
||||||
@in func: Evas_Smart_Cb @optional; /*@ Convenience function to call when this item is selected. The last
|
@in data: const(void)* @optional; [[Data to pass to item-related functions]]
|
||||||
parameter @p event_info of @c func is the selected item pointer. */
|
|
||||||
@in data: const(void)* @optional; /*@ Data to pass to item-related functions */
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue