• Python EFL - 1.23
  • python docs
  • other docs
  • EFL

Navigation

  • index
  • modules |
  • next |
  • previous |
  • Home |
  • What is elementary? »

Logo

Table Of Contents

  • Popup
    • Widget description
    • Emitted signals
    • Layout content parts
    • Layout text parts
    • Enumerations
      • Popup orientation types
    • Inheritance diagram

Previous topic

Plug

Next topic

Progressbar

Quick search

Popup¶

../_images/popup-preview.png

Widget 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 None.

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.

Figure:

|---------------------|    |---------------------|    |---------------------|
|     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.

Emitted signals¶

  • timeout - when ever popup is closed as a result of timeout.
  • block,clicked - when ever user taps on Blocked Event area.
  • item,focused - the popup item has received focus. (since 1.10)
  • item,unfocused - the popup item has lost focus. (since 1.10)
  • dismissed - the popup has been dismissed. (since 1.17)

Layout content parts¶

  • 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 - Item’s icon

Layout text parts¶

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

Enumerations¶

Popup orientation types¶

efl.elementary.ELM_POPUP_ORIENT_TOP¶

Popup should appear in the top of parent, default

efl.elementary.ELM_POPUP_ORIENT_CENTER¶

Popup should appear in the center of parent

efl.elementary.ELM_POPUP_ORIENT_BOTTOM¶

Popup should appear in the bottom of parent

efl.elementary.ELM_POPUP_ORIENT_LEFT¶

Popup should appear in the left of parent

efl.elementary.ELM_POPUP_ORIENT_RIGHT¶

Popup should appear in the right of parent

efl.elementary.ELM_POPUP_ORIENT_TOP_LEFT¶

Popup should appear in the top left of parent

efl.elementary.ELM_POPUP_ORIENT_TOP_RIGHT¶

Popup should appear in the top right of parent

efl.elementary.ELM_POPUP_ORIENT_BOTTOM_LEFT¶

Popup should appear in the bottom left of parent

efl.elementary.ELM_POPUP_ORIENT_BOTTOM_RIGHT¶

Popup should appear in the bottom right of parent

Inheritance diagram¶

class efl.elementary.Popup(Object parent, *args, **kwargs)¶

Bases: efl.elementary.__init__.LayoutClass

Changed in version 1.8: Inherits from LayoutClass.

Parameters:
  • parent (efl.evas.Object) – The parent object
  • **kwargs – All the remaining keyword arguments are interpreted as properties of the instance
align¶

The alignment of the popup object.

The alignment in which the popup will appear inside its parent.

Type:2 doubles tuple: (horiz, vert)

New in version 1.18.

allow_events¶

Whether events should be passed to by a click outside.

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

Note

The default value is False.

Type:bool
callback_block_clicked_add¶

When the user taps on Blocked Event area.

callback_block_clicked_del¶
callback_dismissed_add¶

When popup is closed as a result of a dismiss.

New in version 1.17.

callback_dismissed_del¶
callback_item_focused_add¶

When the popup item has received focus.

New in version 1.10.

callback_item_focused_del¶
callback_item_unfocused_add¶

When the popup item has lost focus.

New in version 1.10.

callback_item_unfocused_del¶
callback_timeout_add¶

When popup is closed as a result of timeout.

callback_timeout_del¶
content_text_wrap_type¶

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

Type:Wrap mode
dismiss¶

Dismiss a popup object.

New in version 1.17.

item_append¶

Add a new item to a Popup object

Both an item list and a content cannot be set at the same time! Once you add an item, the previous content will be removed.

Parameters:
  • label (string) – The Label of the new item
  • icon (Object) – Icon to be set on new item
  • func (function) – Convenience function called when item selected
Returns:

A handle to the item added or None on errors.

Return type:

PopupItem

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.

orient¶

Sets the orientation of the popup in the parent region

Sets the position in which popup will appear in its parent

Type:Popup orientation types
scrollable¶

The scrollable state of popup content area

Normally content area does not contain scroller.

Type:bool

New in version 1.18.

timeout¶

A timeout to hide popup automatically

Setting this 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.

Note

If the value > 0.0 and the popup is previously visible, the timer will be started with this value, canceling any running timer.

Type:float
class efl.elementary.PopupItem(Object popup, label=None, Object icon=None, func=None, cb_data=None, *args, **kwargs)¶

Bases: efl.elementary.__init__.ObjectItem

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
append_to¶

Navigation

  • index
  • modules |
  • next |
  • previous |
  • Home |
  • What is elementary? »
© Copyright 2008-2019, Simon Busch, Gustavo Sverzut Barbieri, Ulisses Furquim, ProFUSION embedded systems, Boris Faure, Fabiano Fidencio, Davide Andreoli, Kai Huuhko.
Created using Sphinx 1.7.6.