Enumerations

enum  Elm_Hover_Axis {
  ELM_HOVER_AXIS_NONE,
  ELM_HOVER_AXIS_HORIZONTAL,
  ELM_HOVER_AXIS_VERTICAL,
  ELM_HOVER_AXIS_BOTH
}
 The orientation axis for the hover object. More...

Functions

Evas_Object * elm_hover_add (Evas_Object *parent)
 Adds a hover object to parent.
void elm_hover_target_set (Evas_Object *obj, Evas_Object *target)
 Sets the target object for the hover.
Evas_Object * elm_hover_target_get (const Evas_Object *obj)
 Gets the target object for the hover.
void elm_hover_parent_set (Evas_Object *obj, Evas_Object *parent)
 Sets the parent object for the hover.
Evas_Object * elm_hover_parent_get (const Evas_Object *obj)
 Gets the parent object for the hover.
const char * elm_hover_best_content_location_get (const Evas_Object *obj, Elm_Hover_Axis pref_axis)
 Returns the best swallow location for content in the hover.
void elm_hover_dismiss (Evas_Object *obj)
 Dismiss a hover object.

Detailed Description

hover_inheritance_tree.png
preview-00.png

A Hover object will hover over its parent object at the target location. Anything in the background will be given a darker coloring to indicate that the hover object is on top (at the default theme). When the hover is clicked it is dismissed(hidden), if the contents of the hover are clicked that doesn't cause the hover to be dismissed.

A Hover object has two parents. One parent that owns it during creation and the other parent being the one over which the hover object spans.

Note:
The hover object will take up the entire space of target object.

Elementary has the following styles for the hover widget:

  • default
  • popout
  • menu
  • hoversel_vertical

This widget inherits from the Layout one, so that all the functions acting on it also work for hover objects.

This widget emits the following signals, besides the ones sent from Layout:

  • "clicked" - the user clicked the empty space in the hover to dismiss
  • "smart,changed" - a content object placed under the "smart" policy was replaced to a new slot direction.

Default content parts of the hover widget that you can use for are:

  • "left"
  • "top-left"
  • "top"
  • "top-right"
  • "right"
  • "bottom-right"
  • "bottom"
  • "bottom-left"
  • "middle"
  • "smart"
Note:
These content parts indicates the direction that the content will be displayed

All directions may have contents at the same time, except for "smart". This is a special placement hint and its use case depends of the calculations coming from elm_hover_best_content_location_get(). Its use is for cases when one desires only one hover content, but with a dynamic special placement within the hover area. The content's geometry, whenever it changes, will be used to decide on a best location, not extrapolating the hover's parent object view to show it in (still being the hover's target determinant of its medium part -- move and resize it to simulate finger sizes, for example). If one of the directions other than "smart" are used, a previously content set using it will be deleted, and vice-versa.

Supported elm_object common APIs.

See Hover example for more information.


Enumeration Type Documentation

The orientation axis for the hover object.

Enumerator:
ELM_HOVER_AXIS_NONE 

ELM_HOVER_AXIS_NONE -- no preferred orientation.

ELM_HOVER_AXIS_HORIZONTAL 

ELM_HOVER_AXIS_HORIZONTAL -- horizontal.

ELM_HOVER_AXIS_VERTICAL 

ELM_HOVER_AXIS_VERTICAL -- vertical.

ELM_HOVER_AXIS_BOTH 

ELM_HOVER_AXIS_BOTH -- both.


Function Documentation

Evas_Object* elm_hover_add ( Evas_Object *  parent)

Adds a hover object to parent.

Parameters:
parentThe parent object
Returns:
The hover object or NULL if one could not be created
const char* elm_hover_best_content_location_get ( const Evas_Object *  obj,
Elm_Hover_Axis  pref_axis 
)

Returns the best swallow location for content in the hover.

Parameters:
objThe hover object
pref_axisThe preferred orientation axis for the hover object to use
Returns:
The edje location to place content into the hover or NULL, on errors.

Best is defined here as the location at which there is the most available space.

pref_axis may be one of

  • ELM_HOVER_AXIS_NONE -- no preferred orientation
  • ELM_HOVER_AXIS_HORIZONTAL -- horizontal
  • ELM_HOVER_AXIS_VERTICAL -- vertical
  • ELM_HOVER_AXIS_BOTH -- both

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.

See also:
elm_object_part_content_set()

References ELM_HOVER_AXIS_HORIZONTAL, and ELM_HOVER_AXIS_VERTICAL.

void elm_hover_dismiss ( Evas_Object *  obj)

Dismiss a hover object.

Parameters:
objThe hover object Use this function to simulate clicking outside the hover to dismiss it. In this way, the hover will be hidden and the "clicked" signal will be emitted.

References elm_layout_signal_emit().

Evas_Object* elm_hover_parent_get ( const Evas_Object *  obj)

Gets the parent object for the hover.

Parameters:
objThe hover object
Returns:
The parent object to locate the hover over.
See also:
elm_hover_parent_set()
void elm_hover_parent_set ( Evas_Object *  obj,
Evas_Object *  parent 
)

Sets the parent object for the hover.

Parameters:
objThe hover object
parentThe object to locate the hover over.

This function will cause the hover to take up the entire space that the parent object fills.

References elm_layout_sizing_eval().

Referenced by elm_menu_parent_set().

Evas_Object* elm_hover_target_get ( const Evas_Object *  obj)

Gets the target object for the hover.

Parameters:
objThe hover object
Returns:
The target object for the hover.
See also:
elm_hover_target_set()
void elm_hover_target_set ( Evas_Object *  obj,
Evas_Object *  target 
)

Sets the target object for the hover.

Parameters:
objThe hover object
targetThe object to center the hover onto.

This function will cause the hover to be centered on the target object.

References elm_layout_sizing_eval().