This widget is an enhancement of Notify. More...

Enumerations

enum  Elm_Popup_Orient {
  ELM_POPUP_ORIENT_TOP = 0,
  ELM_POPUP_ORIENT_CENTER,
  ELM_POPUP_ORIENT_BOTTOM,
  ELM_POPUP_ORIENT_LEFT,
  ELM_POPUP_ORIENT_RIGHT,
  ELM_POPUP_ORIENT_TOP_LEFT,
  ELM_POPUP_ORIENT_TOP_RIGHT,
  ELM_POPUP_ORIENT_BOTTOM_LEFT,
  ELM_POPUP_ORIENT_BOTTOM_RIGHT,
  ELM_POPUP_ORIENT_LAST
}
 Possible orient values for popup. More...

Functions

Evas_Object * elm_popup_add (Evas_Object *parent)
 Adds a new Popup to the parent.
Elm_Object_Itemelm_popup_item_append (Evas_Object *obj, const char *label, Evas_Object *icon, Evas_Smart_Cb func, const void *data)
 Add a new item to a Popup object.
void elm_popup_content_text_wrap_type_set (Evas_Object *obj, Elm_Wrap_Type wrap)
 Sets the wrapping type of content text packed in content area of popup object.
Elm_Wrap_Type elm_popup_content_text_wrap_type_get (const Evas_Object *obj)
 Returns the wrapping type of content text packed in content area of popup object.
void elm_popup_orient_set (Evas_Object *obj, Elm_Popup_Orient orient)
 Sets the orientation of the popup in the parent region.
Elm_Popup_Orient elm_popup_orient_get (const Evas_Object *obj)
 Returns the orientation of Popup.
void elm_popup_timeout_set (Evas_Object *obj, double timeout)
 Sets a timeout to hide popup automatically.
double elm_popup_timeout_get (const Evas_Object *obj)
 Returns the timeout value set to the popup (in seconds)
void elm_popup_allow_events_set (Evas_Object *obj, Eina_Bool allow)
 Sets whether events should be passed to by a click outside.
Eina_Bool elm_popup_allow_events_get (const Evas_Object *obj)
 Returns value indicating whether allow event is enabled or not.

Detailed Description

This widget is an enhancement of Notify.

In addition to Content area, there are two optional sections namely Title area and Action area.

Popup Widget displays its content with a particular orientation in the parent area. This orientation can be one among top, center, bottom, left, top-left, top-right, bottom-left and bottom-right. Content part of Popup can be an Evas Object set by application or it can be Text set by application or set of items containing an icon and/or text. The content/item-list can be removed using elm_object_content_set with second parameter passed as NULL.

Following figures shows the textual layouts of popup in which Title Area and Action area area are optional ones. Action area can have up to 3 buttons handled using elm_object common APIs mentioned below. If user wants to have more than 3 buttons then these buttons can be put inside the items of a list as content. User needs to handle the clicked signal of these action buttons if required. No event is processed by the widget automatically when clicked on these action buttons.

  |---------------------|    |---------------------|    |---------------------|
 |     Title Area      |    |     Title Area      |    |     Title Area      |
 |Icon|    Text        |    |Icon|    Text        |    |Icon|    Text        |
 |---------------------|    |---------------------|    |---------------------|
 |       Item 1        |    |                     |    |                     |
 |---------------------|    |                     |    |                     |
 |       Item 2        |    |                     |    |    Description      |
 |---------------------|    |       Content       |    |                     |
 |       Item 3        |    |                     |    |                     |
 |---------------------|    |                     |    |                     |
 |         .           |    |---------------------|    |---------------------|
 |         .           |    |     Action Area     |    |     Action Area     |
 |         .           |    | Btn1  |Btn2|. |Btn3 |    | Btn1  |Btn2|  |Btn3 |
 |---------------------|    |---------------------|    |---------------------|
 |       Item N        |     Content Based Layout     Description based Layout
 |---------------------|
 |     Action Area     |
 | Btn1  |Btn2|. |Btn3 |
 |---------------------|
    Item Based Layout
 

Timeout can be set on expiry of which popup instance hides and sends a smart signal "timeout" to the user. The visible region of popup is surrounded by a translucent region called Blocked Event area. By clicking on Blocked Event area, the signal "block,clicked" is sent to the application. This block event area can be avoided by using API elm_popup_allow_events_set. When gets hidden, popup does not get destroyed automatically, application should destroy the popup instance after use. To control the maximum height of the internal scroller for item, we use the height of the action area which is passed by theme based on the number of buttons currently set to popup.

Signals that you can add callbacks for are:

  • "timeout" - whenever popup is closed as a result of timeout.
  • "block,clicked" - whenever user taps on Blocked Event area.

Styles available for Popup

  • "default"

Default contents parts of the popup widget that you can use for are:

  • "default" - The content of the popup
  • "title,icon" - Title area's icon
  • "button1" - 1st button of the action area
  • "button2" - 2nd button of the action area
  • "button3" - 3rd button of the action area

Default text parts of the popup widget that you can use for are:

  • "title,text" - This operates on Title area's label
  • "default" - content-text set in the content area of the widget

Default contents parts of the popup items that you can use for are:

  • "default" -Item's icon

Default text parts of the popup items that you can use for are:

  • "default" - Item's label

Supported elm_object common APIs.

Supported elm_object_item common APIs.

Here are some sample code to illustrate Popup usage:


Enumeration Type Documentation

Possible orient values for popup.

These values should be used in conjunction to elm_popup_orient_set() to set the position in which the popup should appear(relative to its parent) and in conjunction with elm_popup_orient_get() to know where the popup is appearing.

Enumerator:
ELM_POPUP_ORIENT_TOP 

Popup should appear in the top of parent, default.

ELM_POPUP_ORIENT_CENTER 

Popup should appear in the center of parent.

ELM_POPUP_ORIENT_BOTTOM 

Popup should appear in the bottom of parent.

ELM_POPUP_ORIENT_LEFT 

Popup should appear in the left of parent.

ELM_POPUP_ORIENT_RIGHT 

Popup should appear in the right of parent.

ELM_POPUP_ORIENT_TOP_LEFT 

Popup should appear in the top left of parent.

ELM_POPUP_ORIENT_TOP_RIGHT 

Popup should appear in the top right of parent.

ELM_POPUP_ORIENT_BOTTOM_LEFT 

Popup should appear in the bottom left of parent.

ELM_POPUP_ORIENT_BOTTOM_RIGHT 

Notify should appear in the bottom right of parent.

ELM_POPUP_ORIENT_LAST 

Sentinel value, don't use.


Function Documentation

Evas_Object* elm_popup_add ( Evas_Object *  parent)

Adds a new Popup to the parent.

Parameters:
parentThe parent object
Returns:
The new object or NULL if it cannot be created

References elm_layout_add(), elm_layout_theme_set(), elm_notify_add(), elm_notify_allow_events_set(), ELM_NOTIFY_ORIENT_CENTER, elm_notify_orient_set(), elm_notify_parent_set(), elm_object_signal_callback_add(), elm_object_style_set(), and ELM_WRAP_MIXED.

Eina_Bool elm_popup_allow_events_get ( const Evas_Object *  obj)

Returns value indicating whether allow event is enabled or not.

Parameters:
objThe popup object
Returns:
EINA_FALSE if Blocked event area is present else EINA_TRUE
See also:
elm_popup_allow_events_set()
Note:
By default the Blocked event area is present

References elm_notify_allow_events_get().

void elm_popup_allow_events_set ( Evas_Object *  obj,
Eina_Bool  allow 
)

Sets whether events should be passed to by a click outside.

Parameters:
objThe popup object
allowEINA_TRUE Events are passed to lower objects, else not

Enabling allow event will remove the Blocked event area and events will pass to the lower layer objects otherwise they are blocked.

See also:
elm_popup_allow_events_get()
Note:
The default value is EINA_FALSE.

References elm_notify_allow_events_set().

Elm_Wrap_Type elm_popup_content_text_wrap_type_get ( const Evas_Object *  obj)

Returns the wrapping type of content text packed in content area of popup object.

Parameters:
objThe Popup object
Returns:
wrap type of the content text
See also:
elm_popup_content_text_wrap_type_set
void elm_popup_content_text_wrap_type_set ( Evas_Object *  obj,
Elm_Wrap_Type  wrap 
)

Sets the wrapping type of content text packed in content area of popup object.

Parameters:
objThe Popup object
wrapwrapping type of type Elm_Wrap_Type
See also:
elm_popup_content_text_wrap_type_get()

References elm_label_line_wrap_set(), elm_object_part_content_get(), and ELM_WRAP_NONE.

Elm_Object_Item* elm_popup_item_append ( Evas_Object *  obj,
const char *  label,
Evas_Object *  icon,
Evas_Smart_Cb  func,
const void *  data 
)

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.

Parameters:
objpopup object
iconIcon to be set on new item
labelThe Label of the new item
funcConvenience function called when item selected
dataData passed to func above
Returns:
A handle to the item added or NULL, on errors
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.

References elm_box_pack_end(), and elm_object_part_content_get().

Elm_Popup_Orient elm_popup_orient_get ( const Evas_Object *  obj)

Returns the orientation of Popup.

Parameters:
objThe popup object
Returns:
the orientation of the popup
See also:
elm_popup_orient_set()
Elm_Popup_Orient

References elm_notify_orient_get(), and ELM_POPUP_ORIENT_LAST.

void elm_popup_orient_set ( Evas_Object *  obj,
Elm_Popup_Orient  orient 
)

Sets the orientation of the popup in the parent region.

Parameters:
objThe popup object
orientthe orientation of the popup

Sets the position in which popup will appear in its parent

See also:
Elm_Popup_Orient for possible values.

References elm_notify_orient_set(), and ELM_POPUP_ORIENT_LAST.

double elm_popup_timeout_get ( const Evas_Object *  obj)

Returns the timeout value set to the popup (in seconds)

Parameters:
objThe popup object
Returns:
the timeout value
See also:
elm_popup_timeout_set()

References elm_notify_timeout_get().

void elm_popup_timeout_set ( Evas_Object *  obj,
double  timeout 
)

Sets a timeout to hide popup automatically.

Parameters:
objThe popup object
timeoutThe timeout in seconds

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.

Note:
Set a value <= 0.0 to disable a running timer.
If the value > 0.0 and the popup is previously visible, the timer will be started with this value, canceling any running timer.

References elm_notify_timeout_set().