# Copyright (C) 2007-2013 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 .
from cpython cimport PyUnicode_AsUTF8String, Py_DECREF, Py_INCREF
from libc.stdint cimport uintptr_t
from efl.eo cimport _object_mapping_register, object_from_instance, PY_REFCOUNT
from efl.utils.conversions cimport _ctouni
from efl.utils.deprecated cimport DEPRECATED
from efl.evas cimport Object as evasObject
from efl.eina cimport EINA_LOG_DOM_DBG, EINA_LOG_DOM_INFO, EINA_LOG_DOM_WARN, \
EINA_LOG_DOM_ERR, EINA_LOG_DOM_CRIT
from efl.elementary.general cimport PY_EFL_ELM_LOG_DOMAIN
include "tooltips.pxi"
# cdef void _tooltip_item_data_del_cb(void *data, Evas_Object *o, void *event_info) with gil:
# Py_DECREF(data)
from efl.utils.conversions cimport python_list_objects_to_eina_list, \
eina_list_objects_to_python_list
from object cimport Object
import traceback
cdef Elm_Object_Item * _object_item_from_python(ObjectItem item) except NULL:
if item is None or item.item is NULL:
raise TypeError("Invalid item!")
return item.item
cdef _object_item_to_python(Elm_Object_Item *it):
cdef:
void *data
ObjectItem item
if it == NULL:
return None
data = elm_object_item_data_get(it)
if data == NULL:
# Create a dummy object item.
EINA_LOG_DOM_WARN(PY_EFL_ELM_LOG_DOMAIN,
"Creating an incomplete ObjectItem.", NULL)
item = ObjectItem.__new__(ObjectItem)
item._set_obj(it)
else:
item = data
return item
cdef _object_item_list_to_python(const_Eina_List *lst):
cdef Elm_Object_Item *it
ret = []
while lst:
it = lst.data
lst = lst.next
o = _object_item_to_python(it)
if o is not None:
ret.append(o)
return ret
cdef void _object_item_del_cb(void *data, Evas_Object *o, void *event_info) with gil:
cdef ObjectItem d
if data != NULL:
d = data
d.item = NULL
Py_DECREF(d)
cdef void _object_item_callback(void *data, Evas_Object *obj, void *event_info) with gil:
# This should be used with old style items
cdef ObjectItem item = data
try:
o = object_from_instance(obj)
item.cb_func(o, item, *item.args, **item.kwargs)
except:
traceback.print_exc()
cdef void _object_item_callback2(void *data, Evas_Object *obj, void *event_info) with gil:
# This should be used with new style items
cdef ObjectItem item = data
try:
o = object_from_instance(obj)
item.cb_func(o, item, item.cb_data)
except:
traceback.print_exc()
cdef class ObjectItem(object):
"""
A generic item for the widgets.
.. py:attribute:: data
:type: dict
A dictionary object that holds user data.
"""
# Notes to bindings' developers:
# ==============================
#
# After calling _set_obj, Elm_Object_Item's "data" contains the python item
# instance pointer, and the attribute "item", that you see below, contains
# a pointer to Elm_Object_Item.
#
def __cinit__(self):
self.data = dict()
def __dealloc__(self):
if self.item != NULL:
elm_object_item_del_cb_set(self.item, NULL)
elm_object_item_del(self.item)
self.item = NULL
def __init__(self, *args, **kwargs):
if type(self) is ObjectItem:
raise TypeError("Must not instantiate ObjectItem, but subclasses")
cdef int _set_obj(self, Elm_Object_Item *item) except 0:
assert self.item == NULL, "Object must be clean"
self.item = item
elm_object_item_data_set(item, self)
elm_object_item_del_cb_set(item, _object_item_del_cb)
Py_INCREF(self)
return 1
def __repr__(self):
return ("<%s object (ObjectItem) at %#x (obj=%#x, refcount=%d, widget=%s)>") % (
type(self).__name__,
self,
self.item,
PY_REFCOUNT(self),
repr(object_from_instance(elm_object_item_widget_get(self.item)))
)
cdef int _set_properties_from_keyword_args(self, dict kwargs) except 0:
if not kwargs:
return 1
cdef list cls_list = dir(self)
for k, v in kwargs.items():
assert k in cls_list, "%s has no attribute with the name %s." % (self, k)
setattr(self, k, v)
return 1
@DEPRECATED("1.8", "Use the data attribute (dict) instead.")
def data_get(self):
"""data_get() -> tuple"""
return (self.args, self.kwargs)
@DEPRECATED("1.8", "Use the data attribute (dict) instead.")
def data_set(self, *args, **kwargs):
"""data_set(self, *args **kwargs)"""
self.args = args
self.kwargs = kwargs
property widget:
"""Get the widget object's handle which contains a given item
.. note:: This returns the widget object itself that an item belongs to.
.. note:: Every elm_object_item supports this API
:type: :py:class:`~efl.elementary.object.Object`
"""
def __get__(self):
return object_from_instance(elm_object_item_widget_get(self.item))
def widget_get(self):
return object_from_instance(elm_object_item_widget_get(self.item))
def part_content_set(self, part, Object content not None):
"""part_content_set(unicode part, Object content)
Set a content of an object item
This sets a new object to an item as a content object. If any object
was already set as a content object in the same part, previous
object will be deleted automatically.
.. note:: Elementary object items may have many contents
:param part: The content part name to set (None for the default
content)
:param content: The new content of the object item
"""
if isinstance(part, unicode): part = PyUnicode_AsUTF8String(part)
elm_object_item_part_content_set(self.item,
part if part is not None else NULL, content.obj)
def part_content_get(self, part):
"""part_content_get(unicode part) -> Object
Get a content of an object item
.. note:: Elementary object items may have many contents
:param part: The content part name to unset (None for the default
content)
:type part: string
:return: content of the object item or None for any error
:rtype: :py:class:`~efl.evas.Object`
"""
if isinstance(part, unicode): part = PyUnicode_AsUTF8String(part)
return object_from_instance(elm_object_item_part_content_get(self.item,
part if part is not None else NULL))
def part_content_unset(self, part):
"""part_content_unset(unicode part)
Unset a content of an object item
.. note:: Elementary object items may have many contents
:param part: The content part name to unset (None for the default
content)
:type part: string
"""
if isinstance(part, unicode): part = PyUnicode_AsUTF8String(part)
return object_from_instance(elm_object_item_part_content_unset(self.item,
part if part is not None else NULL))
property content:
"""The default content part of this ObjectItem."""
def __set__(self, evasObject content not None):
elm_object_item_content_set(self.item, content.obj)
def __get__(self):
return object_from_instance(elm_object_item_content_get(self.item))
def __del__(self):
elm_object_item_content_unset(self.item)
def content_set(self, Object content not None):
elm_object_item_content_set(self.item, content.obj)
def content_get(self):
return object_from_instance(elm_object_item_content_get(self.item))
def content_unset(self):
return object_from_instance(elm_object_item_content_unset(self.item))
def part_text_set(self, part, text):
"""part_text_set(unicode part, unicode text)
Sets the text of a given part of this object.
.. seealso:: :py:attr:`text` and :py:func:`part_text_get()`
:param part: part name to set the text.
:type part: string
:param text: text to set.
:type text: string
"""
if isinstance(part, unicode): part = PyUnicode_AsUTF8String(part)
if isinstance(text, unicode): text = PyUnicode_AsUTF8String(text)
elm_object_item_part_text_set(self.item,
part if part is not None else NULL,
text if text is not None else NULL)
def part_text_get(self, part):
"""part_text_set(unicode part) -> unicode text
Gets the text of a given part of this object.
.. seealso:: text_get() and :py:func:`part_text_set()`
:param part: part name to get the text.
:type part: string
:return: the text of a part or None if nothing was set.
:rtype: string
"""
if isinstance(part, unicode): part = PyUnicode_AsUTF8String(part)
return _ctouni(elm_object_item_part_text_get(self.item,
part if part is not None else NULL))
def domain_translatable_part_text_set(self, part = None, domain = None, text = None):
"""domain_translatable_part_text_set(part = None, domain = None, text = None)
Set the text for an object item's part, marking it as translatable.
The string to set as ``text`` must be the original one. Do not pass the
return of ``gettext()`` here. Elementary will translate the string
internally and set it on the object item using
elm_object_item_part_text_set(), also storing the original string so that it
can be automatically translated when the language is changed with
elm_language_set(). The ``domain`` will be stored along to find the
translation in the correct catalog. It can be None, in which case it will use
whatever domain was set by the application with ``textdomain()``. This is
useful in case you are building a library on top of Elementary that will have
its own translatable strings, that should not be mixed with those of programs
using the library.
:param part: The name of the part to set
:param domain: The translation domain to use
:param text: The original, non-translated text to set
.. versionadded:: 1.8
"""
if isinstance(part, unicode): part = PyUnicode_AsUTF8String(part)
if isinstance(domain, unicode): domain = PyUnicode_AsUTF8String(domain)
if isinstance(text, unicode): text = PyUnicode_AsUTF8String(text)
elm_object_item_domain_translatable_part_text_set(self.item,
part if part is not None else NULL,
domain if domain is not None else NULL,
text if text is not None else NULL)
def translatable_part_text_get(self, part = None):
"""translatable_part_text_get(part = None)
Gets the original string set as translatable for an object item.
When setting translated strings, the function elm_object_item_part_text_get()
will return the translation returned by ``gettext()``. To get the original
string use this function.
:param part: The name of the part that was set
:return: The original, untranslated string
.. versionadded:: 1.8
"""
if isinstance(part, unicode): part = PyUnicode_AsUTF8String(part)
return _ctouni(elm_object_item_translatable_part_text_get(self.item,
part if part is not None else NULL))
def domain_part_text_translatable_set(self, part not None, domain not None, bint translatable):
"""domain_part_text_translatable_set(self, part, domain, bool translatable)
Mark the part text to be translatable or not.
Once you mark the part text to be translatable, the text will be translated
internally regardless of :py:func:`part_text_set` and
:py:func:`domain_translatable_part_text_set`. In other case, if you set the
Elementary policy that all text will be translatable in default, you can set
the part text to not be translated by calling this API.
:param part: The part name of the translatable text
:param domain: The translation domain to use
:param translatable: ``True``, the part text will be translated
internally. ``False``, otherwise.
:see: :py:func:`domain_translatable_part_text_set`
:see: :py:func:`part_text_set`
:see: :py:func:`efl.elementary.general.policy_set`
.. versionadded:: 1.8
"""
if isinstance(part, unicode): part = PyUnicode_AsUTF8String(part)
if isinstance(domain, unicode): domain = PyUnicode_AsUTF8String(domain)
elm_object_item_domain_part_text_translatable_set(self.item,
part,
domain,
translatable)
property text:
"""The main text for this object.
:type: string
"""
def __get__(self):
return _ctouni(elm_object_item_text_get(self.item))
def __set__(self, text):
if isinstance(text, unicode): text = PyUnicode_AsUTF8String(text)
elm_object_item_text_set(self.item,
text if text is not None else NULL)
def text_set(self, text):
if isinstance(text, unicode): text = PyUnicode_AsUTF8String(text)
elm_object_item_text_set(self.item,
text if text is not None else NULL)
def text_get(self):
return _ctouni(elm_object_item_text_get(self.item))
# TODO: accessibility
# property access_info:
# """Set the text to read out when in accessibility mode
# :type: string
# """
# def __set__(self, txt):
# if isinstance(txt, unicode): txt = PyUnicode_AsUTF8String(txt)
# elm_object_item_access_info_set(self.item,
# txt if txt is not None else NULL)
# def access_info_set(self, txt):
# if isinstance(txt, unicode): txt = PyUnicode_AsUTF8String(txt)
# elm_object_item_access_info_set(self.item,
# txt if txt is not None else NULL)
def signal_emit(self, emission, source):
"""signal_emit(unicode emission, unicode source)
Send a signal to the edje object of the widget item.
This function sends a signal to the edje object of the obj item. An
edje program can respond to a signal by specifying matching
'signal' and 'source' fields.
:param emission: The signal's name.
:type emission: string
:param source: The signal's source.
:type source: string
"""
if isinstance(emission, unicode): emission = PyUnicode_AsUTF8String(emission)
if isinstance(source, unicode): source = PyUnicode_AsUTF8String(source)
elm_object_item_signal_emit(self.item,
emission if emission is not None else NULL,
source if source is not None else NULL)
property disabled:
"""The disabled state of an widget item.
Elementary object item can be **disabled**, in which state they won't
receive input and, in general, will be themed differently from their
normal state, usually greyed out. Useful for contexts where you
don't want your users to interact with some of the parts of you
interface.
:type: bool
"""
def __get__(self):
return bool(elm_object_item_disabled_get(self.item))
def __set__(self, disabled):
elm_object_item_disabled_set(self.item, disabled)
def disabled_set(self, disabled):
elm_object_item_disabled_set(self.item, disabled)
def disabled_get(self):
return bool(elm_object_item_disabled_get(self.item))
# TODO: ?
#def delete_cb_set(self, del_cb):
#elm_object_item_del_cb_set(self.item, del_cb)
def delete(self):
"""delete()
Delete this ObjectItem.
"""
if self.item == NULL:
raise ValueError("Object already deleted")
elm_object_item_del(self.item)
Py_DECREF(self)
def tooltip_text_set(self, text):
"""tooltip_text_set(unicode text)
Set the text to be shown in the tooltip object
Setup the text as tooltip object. The object can have only one
tooltip, so any previous tooltip data is removed. Internally, this
method calls :py:func:`tooltip_content_cb_set`
"""
if isinstance(text, unicode): text = PyUnicode_AsUTF8String(text)
elm_object_item_tooltip_text_set(self.item,
text if text is not None else NULL)
property tooltip_window_mode:
# TODO: document this
def __set__(self, disable):
if not elm_object_item_tooltip_window_mode_set(self.item, disable):
raise RuntimeWarning("Could not set tooltip_window_mode.")
def __get__(self):
return bool(elm_object_item_tooltip_window_mode_get(self.item))
def tooltip_window_mode_set(self, disable):
if not elm_object_item_tooltip_window_mode_set(self.item, disable):
raise RuntimeWarning("Could not set tooltip_window_mode.")
def tooltip_window_mode_get(self):
return bool(elm_object_item_tooltip_window_mode_get(self.item))
def tooltip_content_cb_set(self, func, *args, **kargs):
"""tooltip_content_cb_set(func, *args, **kargs)
Set the content to be shown in the tooltip object
Setup the tooltip to object. The object can have only one tooltip,
so any previews tooltip data is removed. ``func(owner, tooltip,
args, kargs)`` will be called every time that need show the tooltip
and it should return a valid Evas_Object. This object is then
managed fully by tooltip system and is deleted when the tooltip is
gone.
:param func: Function to be create tooltip content, called when
need show tooltip.
:type func: function
"""
if not callable(func):
raise TypeError("func must be callable")
cdef void *cbdata
data = (func, args, kargs)
# FIXME: refleak
Py_INCREF(data)
cbdata = data
elm_object_item_tooltip_content_cb_set(self.item, _tooltip_item_content_create,
cbdata, _tooltip_item_data_del_cb)
def tooltip_unset(self):
"""tooltip_unset()
Unset tooltip from object
Remove tooltip from object. If used the :py:func:`tooltip_text_set`
the internal copy of label will be removed correctly. If used
:py:func:`tooltip_content_cb_set`, the data will be unreferred but
no freed.
"""
elm_object_item_tooltip_unset(self.item)
property tooltip_style:
"""The style for this object tooltip.
.. note:: before you set a style you should define a tooltip
with :py:func:`tooltip_content_cb_set()`
or :py:func:`tooltip_text_set()`
"""
def __set__(self, style):
if isinstance(style, unicode): style = PyUnicode_AsUTF8String(style)
elm_object_item_tooltip_style_set(self.item,
style if style is not None else NULL)
def __get__(self):
return _ctouni(elm_object_item_tooltip_style_get(self.item))
def __del__(self):
self.tooltip_style_set(None)
def tooltip_style_set(self, style=None):
if isinstance(style, unicode): style = PyUnicode_AsUTF8String(style)
elm_object_item_tooltip_style_set(self.item,
style if style is not None else NULL)
def tooltip_style_get(self):
return _ctouni(elm_object_item_tooltip_style_get(self.item))
property cursor:
"""The cursor that will be displayed when mouse is over the object.
The object can have only one cursor set to it, so if this function
is called twice for an object, the previous set will be unset.
"""
def __set__(self, cursor):
if isinstance(cursor, unicode): cursor = PyUnicode_AsUTF8String(cursor)
elm_object_item_cursor_set(self.item,
cursor if cursor is not None else NULL)
def __get__(self):
return _ctouni(elm_object_item_cursor_get(self.item))
def __del__(self):
elm_object_item_cursor_unset(self.item)
def cursor_set(self, cursor):
if isinstance(cursor, unicode): cursor = PyUnicode_AsUTF8String(cursor)
elm_object_item_cursor_set(self.item,
cursor if cursor is not None else NULL)
def cursor_get(self):
return _ctouni(elm_object_item_cursor_get(self.item))
def cursor_unset(self):
elm_object_item_cursor_unset(self.item)
property cursor_style:
"""The style for this object cursor.
.. note:: before you set a style you should define a cursor
with :py:attr:`cursor`
"""
def __set__(self, style):
if isinstance(style, unicode): style = PyUnicode_AsUTF8String(style)
elm_object_item_cursor_style_set(self.item,
style if style is not None else NULL)
def __get__(self):
return _ctouni(elm_object_item_cursor_style_get(self.item))
def __del__(self):
elm_object_item_cursor_style_set(self.item, NULL)
def cursor_style_set(self, style=None):
if isinstance(style, unicode): style = PyUnicode_AsUTF8String(style)
elm_object_item_cursor_style_set(self.item,
style if style is not None else NULL)
def cursor_style_get(self):
return _ctouni(elm_object_item_cursor_style_get(self.item))
property cursor_engine_only:
"""cursor_engine_only_set(engine_only)
Sets cursor engine only usage for this object.
.. note:: before you set a style you should define a cursor
with :py:attr:`cursor`
"""
def __set__(self, engine_only):
elm_object_item_cursor_engine_only_set(self.item, bool(engine_only))
def __get__(self):
return elm_object_item_cursor_engine_only_get(self.item)
def cursor_engine_only_set(self, engine_only):
elm_object_item_cursor_engine_only_set(self.item, bool(engine_only))
def cursor_engine_only_get(self):
return elm_object_item_cursor_engine_only_get(self.item)
# TODO: Accessibility
# def access_unregister(self):
# """Unregister accessible object of the object item.
# :since: 1.9
# """
# elm_object_item_access_unregister(self.item)
# property access_object:
# """Get an accessible object of the object item.
# :since: 1.9
# :return: Accessible object of the object item or NULL for any error
# """
# def __get__(self):
# return object_from_instance(elm_object_item_access_object_get(self.item))
# property access_order:
# """Access highlight order
# :since: 1.9
# :type: list of Objects
# """
# def __set__(self, list value):
# elm_object_item_access_order_set(self.item,
# python_list_objects_to_eina_list(value))
# def __get__(self):
# eina_list_objects_to_python_list(elm_object_item_access_order_get(self.item))
# def __del__(self):
# elm_object_item_access_order_unset(self.item)