2015-07-08 02:31:12 -07:00
|
|
|
enum Elm.Hover.Axis
|
|
|
|
{
|
2015-07-08 07:49:38 -07:00
|
|
|
[[The orientation axis for the hover object]]
|
2015-07-08 02:31:12 -07:00
|
|
|
none, [[ELM_HOVER_AXIS_NONE -- no preferred orientation.]]
|
|
|
|
horizontal, [[ELM_HOVER_AXIS_HORIZONTAL -- horizontal.]]
|
|
|
|
vertical, [[ELM_HOVER_AXIS_VERTICAL -- vertical.]]
|
|
|
|
both [[ELM_HOVER_AXIS_BOTH -- both.]]
|
|
|
|
}
|
|
|
|
|
2018-01-23 22:50:58 -08:00
|
|
|
class Elm.Hover (Efl.Ui.Layout, Efl.Ui.Focus.Layer, Efl.Ui.Clickable,
|
|
|
|
Efl.Access.Widget.Action, Efl.Ui.Legacy)
|
2014-03-17 07:48:52 -07:00
|
|
|
{
|
2016-11-24 05:51:47 -08:00
|
|
|
[[Elementary hover class]]
|
2016-05-12 09:06:04 -07:00
|
|
|
legacy_prefix: elm_hover;
|
2014-03-17 07:48:52 -07:00
|
|
|
eo_prefix: elm_obj_hover;
|
2016-05-17 09:14:47 -07:00
|
|
|
event_prefix: elm_hover;
|
2015-05-07 09:32:53 -07:00
|
|
|
methods {
|
|
|
|
@property target {
|
2014-03-17 07:48:52 -07:00
|
|
|
set {
|
2015-08-05 03:31:06 -07:00
|
|
|
[[Sets the target object for the hover.
|
2014-03-17 07:48:52 -07:00
|
|
|
|
2015-08-05 03:31:06 -07:00
|
|
|
This function will cause the hover to be centered on the
|
|
|
|
target object.
|
|
|
|
]]
|
2014-03-17 07:48:52 -07:00
|
|
|
}
|
|
|
|
get {
|
2015-08-05 03:31:06 -07:00
|
|
|
[[Get the target object for the hover.]]
|
2014-03-17 07:48:52 -07:00
|
|
|
}
|
|
|
|
values {
|
2016-06-20 21:26:15 -07:00
|
|
|
target: Efl.Canvas.Object; [[The target object.]]
|
2014-03-17 07:48:52 -07:00
|
|
|
}
|
|
|
|
}
|
2014-07-22 09:13:52 -07:00
|
|
|
best_content_location_get @const {
|
2015-08-05 03:31:06 -07:00
|
|
|
[[Returns the best swallow location for content in the hover.
|
2014-03-17 07:48:52 -07:00
|
|
|
|
2015-08-05 03:31:06 -07:00
|
|
|
Best is defined here as the location at which there is the most
|
|
|
|
available space.
|
2014-03-17 07:48:52 -07:00
|
|
|
|
2015-08-05 03:31:06 -07:00
|
|
|
$pref_axis may be either #ELM_HOVER_AXIS_NONE (for no preferred
|
|
|
|
orientation), #ELM_HOVER_AXIS_HORIZONTAL, #ELM_HOVER_AXIS_VERTICAL
|
|
|
|
or #ELM_HOVER_AXIS_BOTH.
|
2014-03-17 07:48:52 -07:00
|
|
|
|
2015-08-05 03:31:06 -07:00
|
|
|
If #ELM_HOVER_AXIS_HORIZONTAL is chosen the returned position
|
|
|
|
will necessarily be along the horizontal axis("left" or "right").
|
|
|
|
If #ELM_HOVER_AXIS_VERTICAL is chosen the returned position will
|
|
|
|
necessarily be along the vertical axis("top" or "bottom").
|
|
|
|
Choosing #ELM_HOVER_AXIS_BOTH or #ELM_HOVER_AXIS_NONE has the
|
|
|
|
same effect and the returned position may be in either axis.
|
2014-03-17 07:48:52 -07:00
|
|
|
|
2015-08-05 03:31:06 -07:00
|
|
|
See also \@ref elm_object_part_content_set.
|
|
|
|
]]
|
2016-11-24 05:51:47 -08:00
|
|
|
return: string; [[Swallow location]]
|
2014-03-17 07:48:52 -07:00
|
|
|
params {
|
2015-08-05 03:31:06 -07:00
|
|
|
@in pref_axis: Elm.Hover.Axis; [[The preferred orientation axis
|
|
|
|
for the hover object to use]]
|
2014-03-17 07:48:52 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
dismiss {
|
2015-08-05 03:31:06 -07:00
|
|
|
[[Dismiss a hover object]]
|
2014-03-17 07:48:52 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
implements {
|
2014-06-20 02:47:39 -07:00
|
|
|
class.constructor;
|
2016-08-10 07:23:04 -07:00
|
|
|
Efl.Object.constructor;
|
2016-12-27 10:15:41 -08:00
|
|
|
Efl.Gfx.visible { set; }
|
|
|
|
Efl.Gfx.position { set; }
|
|
|
|
Efl.Gfx.size { set; }
|
2018-01-07 20:55:35 -08:00
|
|
|
Efl.Ui.Widget.theme_apply;
|
|
|
|
Efl.Ui.Widget.widget_sub_object_add;
|
|
|
|
Efl.Ui.Widget.widget_parent { get; set; }
|
|
|
|
Efl.Ui.Widget.widget_sub_object_del;
|
2017-11-15 18:31:26 -08:00
|
|
|
Efl.Access.Widget.Action.elm_actions { get; }
|
2017-11-23 23:50:01 -08:00
|
|
|
Efl.Access.state_set { get; }
|
2016-05-24 04:40:18 -07:00
|
|
|
Efl.Part.part;
|
2014-03-17 07:48:52 -07:00
|
|
|
}
|
|
|
|
events {
|
2016-11-24 05:51:47 -08:00
|
|
|
smart,changed; [[Called when hover changed]]
|
|
|
|
dismissed; [[Called when hover was dismissed]]
|
2014-03-17 07:48:52 -07:00
|
|
|
}
|
|
|
|
}
|