summaryrefslogtreecommitdiff
path: root/doc/elementary/ctxpopup.rst
blob: a9dc880d07d3981cd8330f2a40b5ef57b9e78ffa (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
.. currentmodule:: efl.elementary

Ctxpopup
########

.. image:: /images/ctxpopup-preview.png


Widget description
==================

A ctxpopup is a widget that, when shown, pops up a list of items. It
automatically chooses an area inside its parent object's view to
optimally fit into it. In the default theme, it will also point an arrow
to it's top left position at the time one shows it. Ctxpopup items have
a label and/or an icon. It is intended for a small number of items
(hence the use of list, not genlist).

.. note::

    Ctxpopup is a specialization of :py:class:`~efl.elementary.hover.Hover`.

Emitted signals
===============

- ``dismissed`` - This is called when 1. the outside of ctxpopup was clicked
  or 2. its parent area is changed or 3. the language is changed and also when
  4. the parent object is resized due to the window rotation. Then ctxpopup is
  dismissed.
- ``language,changed`` - This is called when the program's language is
  changed.
- ``focused`` - When the ctxpopup has received focus. (since 1.8)
- ``unfocused`` - When the ctxpopup has lost focus. (since 1.8)

Layout content parts
====================

- ``default`` - A content of the ctxpopup
- ``icon`` - An icon in the title area

Layout text parts
=================

- ``default`` - Title label in the title area


Enumerations
============

.. _Elm_Ctxpopup_Direction:

Ctxpopup arrow directions
-------------------------

.. data:: ELM_CTXPOPUP_DIRECTION_DOWN

    Arrow is pointing down

.. data:: ELM_CTXPOPUP_DIRECTION_RIGHT

    Arrow is pointing right

.. data:: ELM_CTXPOPUP_DIRECTION_LEFT

    Arrow is pointing left

.. data:: ELM_CTXPOPUP_DIRECTION_UP

    Arrow is pointing up

.. data:: ELM_CTXPOPUP_DIRECTION_UNKNOWN

    Arrow direction is unknown


Inheritance diagram
===================

.. inheritance-diagram::
    Ctxpopup
    CtxpopupItem
    :parts: 2


.. autoclass:: Ctxpopup
.. autoclass:: CtxpopupItem