efl/src/lib/elementary/elm_notify.eo

99 lines
3.1 KiB
Plaintext
Raw Normal View History

class Elm.Notify extends Efl.Ui.Widget implements Efl.Ui.Focus.Layer, Efl.Content, Efl.Ui.Legacy
2014-03-24 23:25:02 -07:00
{
[[Elementary notification class]]
legacy_prefix: elm_notify;
2014-03-24 23:25:02 -07:00
eo_prefix: elm_obj_notify;
event_prefix: elm_notify;
2015-05-07 09:32:53 -07:00
methods {
@property align {
2014-03-24 23:25:02 -07:00
set {
2015-07-02 06:47:56 -07:00
[[Set the alignment of the notify object
2014-03-24 23:25:02 -07:00
2015-07-02 06:47:56 -07:00
Sets the alignment in which the notify will appear in its parent.
2014-03-24 23:25:02 -07:00
2015-07-02 06:47:56 -07:00
Note: To fill the notify box in the parent area, please pass the
ELM_NOTIFY_ALIGN_FILL to horizontal and vertical.
2014-03-24 23:25:02 -07:00
2015-07-02 06:47:56 -07:00
@since 1.8
]]
2014-03-24 23:25:02 -07:00
}
get {
2015-07-02 06:47:56 -07:00
[[Get the alignment of the notify object
2014-03-24 23:25:02 -07:00
2015-07-02 06:47:56 -07:00
@since 1.8
]]
2014-03-24 23:25:02 -07:00
}
values {
2015-07-02 06:47:56 -07:00
horizontal: double; [[The horizontal alignment of the notification]]
vertical: double; [[The vertical alignment of the notification]]
2014-03-24 23:25:02 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property allow_events {
2014-03-24 23:25:02 -07:00
set {
2015-07-02 06:47:56 -07:00
[[Sets whether events should be passed to by a click outside
its area.
2014-03-24 23:25:02 -07:00
2015-07-02 06:47:56 -07:00
When true if the user clicks outside the window the events will
be caught by the others widgets, else the events are blocked.
2014-03-24 23:25:02 -07:00
2015-07-02 06:47:56 -07:00
Note: The default value is true.
]]
2014-03-24 23:25:02 -07:00
}
get {
2015-07-02 06:47:56 -07:00
[[Return true if events are allowed below the notify object.]]
2014-03-24 23:25:02 -07:00
}
values {
allow: bool; [[$true if events are allowed, $false otherwise]]
2014-03-24 23:25:02 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property timeout {
2014-03-24 23:25:02 -07:00
set {
2015-07-02 06:47:56 -07:00
[[Set the time interval after which the notify window is going to
be hidden.
2014-03-24 23:25:02 -07:00
2015-07-02 06:47:56 -07:00
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.
2014-03-24 23:25:02 -07:00
2015-07-02 06:47:56 -07:00
Note: Set a value <= 0.0 to disable a running timer.
2014-03-24 23:25:02 -07:00
2015-07-02 06:47:56 -07:00
Note: If the value > 0.0 and the notify is previously visible,
the timer will be started with this value, canceling any running
timer.
]]
2014-03-24 23:25:02 -07:00
}
get {
2015-07-02 06:47:56 -07:00
[[Return the timeout value (in seconds)]]
2014-03-24 23:25:02 -07:00
}
values {
2015-07-02 06:47:56 -07:00
timeout: double; [[The timeout in seconds]]
2014-03-24 23:25:02 -07:00
}
}
dismiss {
[[Dismiss a notify object.
@since 1.17
]]
}
2014-03-24 23:25:02 -07:00
}
implements {
class.constructor;
Efl.Object.constructor;
Efl.Gfx.Entity.visible { set; }
Efl.Gfx.Entity.position { set; }
Efl.Gfx.Entity.size { set; }
Efl.Ui.Widget.widget_parent { get; set; }
Efl.Ui.Widget.theme_apply;
Efl.Ui.Widget.widget_sub_object_del;
Efl.Content.content { get; set; }
Efl.Content.content_unset;
Efl.Part.part_get;
2014-03-24 23:25:02 -07:00
}
events {
block,clicked: void; [[Called when block was clicked]]
timeout: void; [[Called when notify timed out]]
dismissed: void; [[Called when notify was dismissed]]
2014-03-24 23:25:02 -07:00
}
}