NorwayFun
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

popup: convert docs

This commit is contained in:
Daniel Kolesa 2015-08-07 14:24:37 +01:00
parent 5c32c34045
commit 7493310eb5
1 changed files with 56 additions and 99 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

155
legacy/elementary/src/lib/elm_popup.eo
View File

@ -29,153 +29,110 @@ class Elm.Popup (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
methods {
@property align {
set {
/*@
@brief Set the alignment of the popup object
Sets the alignment in which the popup will appear in its parent.
[[Set the alignment of the popup object.
@see elm_popup_align_get()
Sets the alignment in which the popup will appear in its parent.
@since 1.9
@ingroup Popup */
@since 1.9
]]
}
get {
/*@
@brief Get the alignment of the popup object
@see elm_popup_align_set()
[[Get the alignment of the popup object.
@since 1.9
@ingroup Popup */
@since 1.9
]]
}
values {
horizontal: double; /*@ The horizontal alignment of the popup */
vertical: double; /*@ The vertical alignment of the popup */
horizontal: double; [[The horizontal alignment of the popup.]]
vertical: double; [[The vertical alignment of the popup.]]
}
}
@property allow_events {
set {
/*@
@brief Sets whether events should be passed to by a click outside.
[[Sets whether events should be passed to by a click outside.
Enabling allow event will remove the Blocked event area and events will
pass to the lower layer objects otherwise they are blocked.
Enabling allow event will remove the Blocked event area and
events will pass to the lower layer objects otherwise they
are blocked.
@ingroup Popup
@see elm_popup_allow_events_get()
@note The default value is false. */
Note: The default value is $false.
]]
}
get {
/*@
@brief Returns value indicating whether allow event is enabled or not
@return $false if Blocked event area is present else $true
@ingroup Popup
@see elm_popup_allow_events_set()
@note By default the Blocked event area is present */
[[Returns value indicating whether allow event is enabled or not.]]
}
values {
allow: bool; /*@ $true Events are passed to lower objects, else not */
allow: bool; [[If $true, events are passed to lower objects.]]
}
}
@property content_text_wrap_type {
set {
/*@
@brief Sets the wrapping type of content text packed in content
[[Control the wrapping type of content text packed in content
area of popup object.
@ingroup Popup
@see elm_popup_content_text_wrap_type_get() */
}
get {
/*@
@brief Returns the wrapping type of content text packed in content area of
popup object.
@return wrap type of the content text
@ingroup Popup
@see elm_popup_content_text_wrap_type_set */
}
]]
set {}
get {}
values {
wrap: Elm.Wrap.Type; /*@ wrapping type of type Elm_Wrap_Type */
wrap: Elm.Wrap.Type; [[Wrapping type of type Elm_Wrap_Type.]]
}
}
@property orient {
set {
/*@
@brief Sets the orientation of the popup in the parent region
[[Sets the orientation of the popup in the parent region.
Sets the position in which popup will appear in its parent. By default,
#ELM_POPUP_ORIENT_CENTER is set.
@ingroup Popup
@see @ref Elm_Popup_Orient for possible values. */
Sets the position in which popup will appear in its parent.
By default, #ELM_POPUP_ORIENT_CENTER is set.
]]
}
get {
/*@
@brief Returns the orientation of Popup
@return the orientation of the popup
@ingroup Popup
@see elm_popup_orient_set()
@see Elm_Popup_Orient */
[[Returns the orientation of the popup.]]
}
values {
orient: Elm.Popup.Orient; /*@ the orientation of the popup */
orient: Elm.Popup.Orient; [[The orientation of the popup.]]
}
}
@property timeout {
set {
/*@
@brief Sets a timeout to hide popup automatically
[[Sets a timeout to hide popup automatically
This function sets a timeout and starts the timer controlling when the
popup is hidden. Since calling evas_object_show() on a popup restarts
the timer controlling when it is hidden, setting this before the
popup is shown will in effect mean starting the timer when the popup is
shown. Smart signal "timeout" is called afterwards which can be handled
if needed.
This function sets a timeout and starts the timer controlling
when the popup is hidden. Since calling \@ref evas_object_show
on a popup restarts the timer controlling when it is hidden,
setting this before the popup is shown will in effect mean
starting the timer when the popup is shown. Smart signal
"timeout" is called afterwards which can be handled
if needed.
@note Set a value <= 0.0 to disable a running timer.
Note: Set a value <= 0.0 to disable a running timer.
@note If the value > 0.0 and the popup is previously visible, the
timer will be started with this value, canceling any running timer.
@ingroup Popup */
Note: If the value > 0.0 and the popup is previously visible,
the timer will be started with this value, canceling any
running timer.
]]
}
get {
/*@
@brief Returns the timeout value set to the popup (in seconds)
@return the timeout value
@ingroup Popup
@see elm_popup_timeout_set() */
[[Returns the timeout value set to the popup (in seconds).]]
}
values {
timeout: double; /*@ The timeout in seconds */
timeout: double; [[The timeout in seconds.]]
}
}
item_append {
/*@
@brief Add a new item to a Popup object
[[Add a new item to a Popup object
Both an item list and a content could not be set at the same time!
once you add an item, the previous content will be removed.
Both an item list and a content could not be set at the same time!
once you add an item, the previous content will be removed.
@return A handle to the item added or $NULL, on errors
@ingroup Popup
@warning When the first item is appended to popup object, any previous content
of the content area is deleted. At a time, only one of content, content-text
and item(s) can be there in a popup content area. */
return: Elm.Widget_Item *;
Warning: When the first item is appended to popup object, any
previous content of the content area is deleted. At a time,
only one of content, content-text and item(s) can be there
in a popup content area.
]]
return: Elm.Widget_Item *; [[A handle to the item added or $null on errors.]]
params {
@in label: const(char)*; /*@ The Label of the new item */
@in icon: Evas.Object * @optional; /*@ Icon to be set on new item */
@in func: Evas_Smart_Cb @optional; /*@ Convenience function called when item selected */
@in data: const(void)* @optional; /*@ Data passed to $func above */
@in label: const(char)*; [[The Label of the new item.]]
@in icon: Evas.Object * @optional; [[Icon to be set on new item.]]
@in func: Evas_Smart_Cb @optional; [[Convenience function called when item selected.]]
@in data: const(void)* @optional; [[Data passed to $func above.]]
}
}
}