summaryrefslogtreecommitdiff
path: root/efl/elementary/systray.pyx
blob: be57906a28d7605cfec619e8272c1043672ae458 (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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
# Copyright (C) 2007-2015 various contributors (see AUTHORS)
#
# This file is part of Python-EFL.
#
# Python-EFL is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 3 of the License, or (at your option) any later version.
#
# Python-EFL is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this Python-EFL.  If not, see <http://www.gnu.org/licenses/>.

"""
:mod:`systray` Module
##########################

.. versionadded:: 1.14


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

.. _Elm_Systray_Category:

Category of the Status Notifier Item.
-------------------------------------

.. data:: ELM_SYSTRAY_CATEGORY_APP_STATUS

    Indicators of application status

.. data:: ELM_SYSTRAY_CATEGORY_COMMUNICATIONS

    Communications apps

.. data:: ELM_SYSTRAY_CATEGORY_SYS_SERVICES

    System Service apps

.. data:: ELM_SYSTRAY_CATEGORY_HARDWARE

    Hardware indicators

.. data:: ELM_SYSTRAY_CATEGORY_OTHER

    Undefined category


.. _Elm_Systray_Status:

Application status information.
-------------------------------

.. data:: ELM_SYSTRAY_STATUS_PASSIVE

    Passive (normal)

.. data:: ELM_SYSTRAY_STATUS_ACTIVE

    Active

.. data:: ELM_SYSTRAY_STATUS_ATTENTION

    Needs Attention

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

.. inheritance-diagram:: efl.elementary.systray
    :parts: 2

"""

from cpython cimport PyUnicode_AsUTF8String, Py_INCREF

from efl.c_eo cimport eo_do, eo_do_ret, eo_add, Eo as cEo
from efl.eo cimport Eo, object_from_instance
from efl.ecore cimport Event, EventHandler, _event_mapping_register
from efl.utils.conversions cimport _ctouni


cdef class Systray(Eo):

    """

    This is the class that actually implements the widget.

    """

    def __init__(self, Eo parent not None, *args, **kwargs):
        self._set_obj(eo_add(elm_systray_class_get(), parent.obj))
        self._set_properties_from_keyword_args(kwargs)

    property id:
        """The id of the Status Notifier Item.

        :type: string

        """
        def __set__(self, value):
            if isinstance(value, unicode): value = PyUnicode_AsUTF8String(value)
            eo_do(self.obj, elm_obj_systray_id_set(
                <const char *>value if value is not None else NULL
                )
            )

        def __get__(self):
            cdef const char *value = ""
            eo_do_ret(self.obj, value, elm_obj_systray_id_get())
            return _ctouni(value)

    def id_set(self, value):
        if isinstance(value, unicode): value = PyUnicode_AsUTF8String(value)
        eo_do(self.obj, elm_obj_systray_id_set(
            <const char *>value if value is not None else NULL
            )
        )

    def id_get(self):
        cdef const char *value = ""
        eo_do_ret(self.obj, value, elm_obj_systray_id_get())
        return _ctouni(value)

    property category:
        """

        The category of the Status Notifier Item.

        :type: :ref:`Elm_Systray_Category`

        """
        def __set__(self, Elm_Systray_Category value):
            eo_do(self.obj, elm_obj_systray_category_set(value))

        def __get__(self):
            cdef Elm_Systray_Category value = ELM_SYSTRAY_CATEGORY_APP_STATUS
            eo_do_ret(self.obj, value, elm_obj_systray_category_get())
            return <Elm_Systray_Category>value

    def category_set(self, Elm_Systray_Category value):
        eo_do(self.obj, elm_obj_systray_category_set(value))

    def category_get(self):
        cdef Elm_Systray_Category value = ELM_SYSTRAY_CATEGORY_APP_STATUS
        eo_do_ret(self.obj, value, elm_obj_systray_category_get())
        return value

    property icon_theme_path:
        """The path to the theme where the icons can be found.

        Set this value to "" to use the default path.

        :type: string
        """
        def __set__(self, value):
            if isinstance(value, unicode): value = PyUnicode_AsUTF8String(value)
            eo_do(self.obj, elm_obj_systray_icon_theme_path_set(
                <const char *>value if value is not None else NULL
                )
            )

        def __get__(self):
            cdef const char *value = ""
            eo_do_ret(self.obj, value, elm_obj_systray_icon_theme_path_get())
            return _ctouni(value)

    def icon_theme_path_set(self, value):
        if isinstance(value, unicode): value = PyUnicode_AsUTF8String(value)
        eo_do(self.obj, elm_obj_systray_icon_theme_path_set(
            <const char *>value if value is not None else NULL
            )
        )

    def icon_theme_path_get(self):
        cdef const char *value = ""
        eo_do_ret(self.obj, value, elm_obj_systray_icon_theme_path_get())
        return _ctouni(value)

    property menu:
        """The D-Bus Menu to be shown when the Status Notifier Item is activated by the user.

        :type: :class:`~efl.elementary.menu.Menu`
        """
        def __set__(self, Eo value):
            eo_do(self.obj, elm_obj_systray_menu_set(value.obj))

        def __get__(self):
            cdef cEo *value = NULL
            eo_do_ret(self.obj, value, elm_obj_systray_menu_get())
            return object_from_instance(value)

    def menu_set(self, Eo value):
        eo_do(self.obj, elm_obj_systray_menu_set(value.obj))

    def menu_get(self):
        cdef cEo *value = NULL
        eo_do_ret(self.obj, value, elm_obj_systray_menu_get())
        return object_from_instance(value)

    property att_icon_name:
        """The name of the attention icon to be used by the Status Notifier Item.

        :type: string
        """
        def __set__(self, value):
            if isinstance(value, unicode): value = PyUnicode_AsUTF8String(value)
            eo_do(self.obj, elm_obj_systray_att_icon_name_set(
                <const char *>value if value is not None else NULL
                )
            )

        def __get__(self):
            cdef const char *value = ""
            eo_do_ret(self.obj, value, elm_obj_systray_att_icon_name_get())
            return _ctouni(value)

    def att_icon_name_set(self, value):
        if isinstance(value, unicode): value = PyUnicode_AsUTF8String(value)
        eo_do(self.obj, elm_obj_systray_att_icon_name_set(
            <const char *>value if value is not None else NULL
            )
        )

    def att_icon_name_get(self):
        cdef const char *value = ""
        eo_do_ret(self.obj, value, elm_obj_systray_att_icon_name_get())
        return _ctouni(value)

    property status:
        """The status of the Status Notifier Item.

        :type: :ref:`Elm_Systray_Status`
        """
        def __set__(self, Elm_Systray_Status value):
            eo_do(self.obj, elm_obj_systray_status_set(value))

        def __get__(self):
            cdef Elm_Systray_Status value = ELM_SYSTRAY_STATUS_PASSIVE
            eo_do_ret(self.obj, value, elm_obj_systray_status_get())
            return value

    def status_set(self, Elm_Systray_Status value):
        eo_do(self.obj, elm_obj_systray_status_set(value))

    def status_get(self):
        cdef Elm_Systray_Status value = ELM_SYSTRAY_STATUS_PASSIVE
        eo_do_ret(self.obj, value, elm_obj_systray_status_get())
        return value

    property icon_name:
        """The name of the icon to be used by the Status Notifier Item.

        :type: string
        """
        def __set__(self, value):
            if isinstance(value, unicode): value = PyUnicode_AsUTF8String(value)
            eo_do(self.obj, elm_obj_systray_icon_name_set(
                <const char *>value if value is not None else NULL
                )
            )

        def __get__(self):
            cdef const char *value = ""
            eo_do_ret(self.obj, value, elm_obj_systray_icon_name_get())
            return _ctouni(value)

    def icon_name_set(self, value):
        if isinstance(value, unicode): value = PyUnicode_AsUTF8String(value)
        eo_do(self.obj, elm_obj_systray_icon_name_set(
            <const char *>value if value is not None else NULL
            )
        )

    def icon_name_get(self):
        cdef const char *value = ""
        eo_do_ret(self.obj, value, elm_obj_systray_icon_name_get())
        return _ctouni(value)

    property title:
        """The title of the Status Notifier Item.

        :type: string
        """
        def __set__(self, value):
            if isinstance(value, unicode): value = PyUnicode_AsUTF8String(value)
            eo_do(self.obj, elm_obj_systray_title_set(
                <const char *>value if value is not None else NULL
                )
            )

        def __get__(self):
            cdef const char *value = ""
            eo_do_ret(self.obj, value, elm_obj_systray_title_get())
            return _ctouni(value)

    def title_set(self, value):
        if isinstance(value, unicode): value = PyUnicode_AsUTF8String(value)
        eo_do(self.obj, elm_obj_systray_title_set(
            <const char *>value if value is not None else NULL
            )
        )

    def title_get(self):
        cdef const char *value = ""
        eo_do_ret(self.obj, value, elm_obj_systray_title_get())
        return _ctouni(value)

    def register(self):
        """Register this Status Notifier Item in the System Tray Watcher.

        This function should only be called after the event
        ``ELM_EVENT_SYSTRAY_READY``, for which you can set a callback with
        :func:`on_systray_ready`, is emitted.

        """
        cdef Eina_Bool value = 0
        eo_do_ret(self.obj, value, elm_obj_systray_register())
        return value


def on_systray_ready(func, *args, **kwargs):
    """Use this to set a handler for the systray ready event."""
    return EventHandler(ELM_EVENT_SYSTRAY_READY, func, *args, **kwargs)