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

notify: convert docs

This commit is contained in:
Daniel Kolesa 2015-07-02 14:47:56 +01:00
parent b1fba116aa
commit 6afd71a33f
1 changed files with 33 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
legacy/elementary/src/lib/elm_notify.eo
View File

@ -4,82 +4,68 @@ class Elm.Notify (Elm.Container)
methods {
@property align {
set {
/*@
@brief Set the alignment of the notify object
[[Set the alignment of the notify object
Sets the alignment in which the notify will appear in its parent.
Sets the alignment in which the notify will appear in its parent.
@note To fill the notify box in the parent area, please pass the
#ELM_NOTIFY_ALIGN_FILL to @p horizontal, @p vertical.
Note: To fill the notify box in the parent area, please pass the
ELM_NOTIFY_ALIGN_FILL to horizontal and vertical.
@since 1.8
@ingroup Notify */
@since 1.8
]]
}
get {
/*@
@brief Get the alignment of the notify object
@see elm_notify_align_set()
[[Get the alignment of the notify object
@since 1.8
@ingroup Notify */
@since 1.8
]]
}
values {
horizontal: double; /*@ The horizontal alignment of the notification */
vertical: double; /*@ The vertical alignment of the notification */
horizontal: double; [[The horizontal alignment of the notification]]
vertical: double; [[The vertical alignment of the notification]]
}
}
@property allow_events {
set {
/*@
@brief Sets whether events should be passed to by a click outside
its area.
[[Sets whether events should be passed to by a click outside
its area.
When true if the user clicks outside the window the events will be caught
by the others widgets, else the events are blocked.
When true if the user clicks outside the window the events will
be caught by the others widgets, else the events are blocked.
@note The default value is EINA_TRUE.
@ingroup Notify */
Note: The default value is true.
]]
}
get {
/*@
@brief Return true if events are allowed below the notify object
@see elm_notify_allow_events_set()
@ingroup Notify */
[[Return true if events are allowed below the notify object.]]
}
values {
allow: bool; /*@ EINA_TRUE If events are allowed, otherwise not */
allow: bool; [[true if events are allowed, otherwise false]]
}
}
@property timeout {
set {
/*@
@brief Set the time interval after which the notify window is going to be
hidden.
[[Set the time interval after which the notify window is going to
be hidden.
This function sets a timeout and starts the timer controlling when the
notify is hidden. Since calling evas_object_show() on a notify restarts
the timer controlling when the notify is hidden, setting this before the
notify is shown will in effect mean starting the timer when the notify is
shown.
This function sets a timeout and starts the timer controlling
when the notify is hidden. Since calling evas_object_show() on
a notify restarts the timer controlling when the notify is
hidden, setting this before the notify is shown will in effect
mean starting the timer when the notify is shown.
@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 notify is previously visible, the
timer will be started with this value, canceling any running timer.
@ingroup Notify */
Note: If the value > 0.0 and the notify is previously visible,
the timer will be started with this value, canceling any running
timer.
]]
}
get {
/*@
@brief Return the timeout value (in seconds)
@see elm_notify_timeout_set()
@ingroup Notify */
[[Return the timeout value (in seconds)]]
}
values {
timeout: double; /*@ The timeout in seconds */
timeout: double; [[The timeout in seconds]]
}
}
}