python-efl/efl/elementary/multibuttonentry.pyx

# 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 2.1 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/>.

"""

Widget description
------------------

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


A Multibuttonentry is a widget to allow a user enter text and manage
it as a number of buttons. Each text button is inserted by pressing the
"return" key. If there is no space in the current row, a new button is
added to the next row. When a text button is pressed, it will become
focused. Backspace removes the focus. When the Multibuttonentry loses
focus items longer than one line are shrunk to one line.

Typical use case of multibuttonentry is, composing emails/messages to a
group of addresses, each of which is an item that can be clicked for
further actions.

Default text parts of the multibuttonentry widget that you can use for are:
    - "default" - A label of the multibuttonentry

Default text parts of the multibuttonentry items that you can use for are:
    - "default" - A label of the multibuttonentry item

"""

include "widget_header.pxi"

from object cimport Object
import traceback
from object_item cimport    _object_item_callback, \
                            _object_item_to_python, \
                            _object_item_list_to_python

cdef Eina_Bool _multibuttonentry_filter_callback(Evas_Object *obj, const_char *item_label, void *item_data, void *data) with gil:
    try:
        (mbe, callback, a, ka) = <object>data
        ret = callback(mbe, _ctouni(item_label), *a, **ka)
        if isinstance(ret, str):
            # TODO this is BROKEN! the doc say should work, but it's a const char*  :/
            # free(<void*>item_label)
            # item_label = strdup(ret)
            return 1
        elif ret:
            return 1
        else:
            return 0
    except Exception, e:
        traceback.print_exc()

cdef enum Elm_MultiButtonEntry_Item_Insert_Kind:
    ELM_MULTIBUTTONENTRY_INSERT_APPEND
    ELM_MULTIBUTTONENTRY_INSERT_PREPEND
    ELM_MULTIBUTTONENTRY_INSERT_BEFORE
    ELM_MULTIBUTTONENTRY_INSERT_AFTER

cdef class MultiButtonEntryItem(ObjectItem):

    """An item for the MultiButtonEntry widget."""

    def __init__(self, kind, evasObject mbe, label,
                       MultiButtonEntryItem before_after = None,
                       callback = None, *args, **kargs):
        # TODO: fix this horrible API
        cdef Evas_Smart_Cb cb = NULL

        if callback:
            if not callable(callback):
                raise TypeError("callback is not callable")
            cb = _object_item_callback

        self.params = (callback, args, kargs)
        if isinstance(label, unicode): label = PyUnicode_AsUTF8String(label)
        if kind == ELM_MULTIBUTTONENTRY_INSERT_PREPEND:
            item = elm_multibuttonentry_item_prepend(mbe.obj,
                <const_char *>label if label is not None else NULL,
                cb, <void*>self)
        elif kind == ELM_MULTIBUTTONENTRY_INSERT_APPEND:
            item = elm_multibuttonentry_item_append(mbe.obj,
                <const_char *>label if label is not None else NULL,
                cb, <void*>self)
        elif kind == ELM_MULTIBUTTONENTRY_INSERT_BEFORE:
            item = elm_multibuttonentry_item_insert_before(mbe.obj,
                before_after.item,
                <const_char *>label if label is not None else NULL,
                cb, <void*>self)
        elif kind == ELM_MULTIBUTTONENTRY_INSERT_AFTER:
            item = elm_multibuttonentry_item_insert_after(mbe.obj,
                before_after.item,
                <const_char *>label if label is not None else NULL,
                cb, <void*>self)

        if item != NULL:
            self._set_obj(item)
        else:
            Py_DECREF(self)

    def __str__(self):
        return ("%s(label=%r, callback=%r, args=%r, kargs=%s)") % \
            (self.__class__.__name__, self.text_get(), self.params[0], self.params[1], self.params[2])

    def __repr__(self):
        return ("%s(%#x, refcount=%d, Elm_Object_Item=%#x, "
                "label=%r, callback=%r, args=%r, kargs=%s)") % \
            (self.__class__.__name__, <unsigned long><void *>self,
             PY_REFCOUNT(self), <unsigned long><void *>self.item,
             self.text_get(), self.params[0], self.params[1], self.params[2])

    property selected:
        def __get__(self):
            return bool(elm_multibuttonentry_item_selected_get(self.item))

        def __set__(self, selected):
            elm_multibuttonentry_item_selected_set(self.item, bool(selected))

    def selected_set(self, selected):
        elm_multibuttonentry_item_selected_set(self.item, bool(selected))
    def selected_get(self):
        return bool(elm_multibuttonentry_item_selected_get(self.item))

    property prev:
        def __get__(self):
            return _object_item_to_python(elm_multibuttonentry_item_prev_get(self.item))

    def prev_get(self):
        return _object_item_to_python(elm_multibuttonentry_item_prev_get(self.item))

    property next:
        def __get__(self):
            return _object_item_to_python(elm_multibuttonentry_item_next_get(self.item))

    def next_get(self):
        return _object_item_to_python(elm_multibuttonentry_item_next_get(self.item))

cdef class MultiButtonEntry(Object):

    """

    This is the class that actually implement the widget.

    """

    def __init__(self, evasObject parent):
        self._set_obj(elm_multibuttonentry_add(parent.obj))

    property entry:
        """The Entry object child of the multibuttonentry.

        :type: Entry

        """
        def __get__(self):
            return object_from_instance(elm_multibuttonentry_entry_get(self.obj))

    def entry_get(self):
        return object_from_instance(elm_multibuttonentry_entry_get(self.obj))

    property expanded:
        """The expanded state of the multibuttonentry.

        :type: bool

        """
        def __get__(self):
            return bool(elm_multibuttonentry_expanded_get(self.obj))

        def __set__(self, enabled):
            elm_multibuttonentry_expanded_set(self.obj, bool(enabled))

    def expanded_set(self, enabled):
        elm_multibuttonentry_expanded_set(self.obj, bool(enabled))
    def expanded_get(self):
        return bool(elm_multibuttonentry_expanded_get(self.obj))

    def item_prepend(self, label, func = None, *args, **kwargs):
        return MultiButtonEntryItem(ELM_MULTIBUTTONENTRY_INSERT_PREPEND,
                                    self, label, None, func, *args, **kwargs)

    def item_append(self, label, func = None, *args, **kwargs):
        return MultiButtonEntryItem(ELM_MULTIBUTTONENTRY_INSERT_APPEND,
                                    self, label, None, func, *args, **kwargs)

    def item_insert_before(self, MultiButtonEntryItem before, label, func = None, *args, **kwargs):
        return MultiButtonEntryItem(ELM_MULTIBUTTONENTRY_INSERT_BEFORE,
                                    self, label, before, func, *args, **kwargs)

    def item_insert_after(self, MultiButtonEntryItem after, label, func = None, *args, **kwargs):
        return MultiButtonEntryItem(ELM_MULTIBUTTONENTRY_INSERT_AFTER,
                                    self, label, after, func, *args, **kwargs)

    property items:
        def __get__(self):
            return _object_item_list_to_python(elm_multibuttonentry_items_get(self.obj))

    def items_get(self):
        return _object_item_list_to_python(elm_multibuttonentry_items_get(self.obj))

    property first_item:
        def __get__(self):
            return _object_item_to_python(elm_multibuttonentry_first_item_get(self.obj))

    def first_item_get(self):
        return _object_item_to_python(elm_multibuttonentry_first_item_get(self.obj))

    property last_item:
        def __get__(self):
            return _object_item_to_python(elm_multibuttonentry_last_item_get(self.obj))

    def last_item_get(self):
        return _object_item_to_python(elm_multibuttonentry_last_item_get(self.obj))

    property selected_item:
        def __get__(self):
            return _object_item_to_python(elm_multibuttonentry_selected_item_get(self.obj))

    def selected_item_get(self):
        return _object_item_to_python(elm_multibuttonentry_selected_item_get(self.obj))

    def clear(self):
        elm_multibuttonentry_clear(self.obj)

    def filter_append(self, func, *args, **kwargs):
        cbdata = (self, func, args, kwargs)
        elm_multibuttonentry_item_filter_append(self.obj,
                            _multibuttonentry_filter_callback, <void *>cbdata)
        Py_INCREF(cbdata)

    def filter_prepend(self, func, *args, **kwargs):
        cbdata = (self, func, args, kwargs)
        elm_multibuttonentry_item_filter_prepend(self.obj,
                            _multibuttonentry_filter_callback, <void *>cbdata)
        Py_INCREF(cbdata)

    def filter_remove(self, func, *args, **kwargs):
        #TODO
        pass

    property editable:
        """Whether the multibuttonentry is to be editable or not.

        :type: bool

        """
        def __set__(self, value):
            self.editable_set(value)

        def __get__(self):
            return self.editable_get()

    cpdef editable_set(self, bint editable):
        elm_multibuttonentry_editable_set(self.obj, editable)

    cpdef bint editable_get(self):
        return elm_multibuttonentry_editable_get(self.obj)

    def callback_item_selected_add(self, func, *args, **kwargs):
        self._callback_add("item,selected", func, *args, **kwargs)

    def callback_item_selected_del(self, func):
        self._callback_del("item,selected", func)

    def callback_item_added_add(self, func, *args, **kwargs):
        self._callback_add("item,added", func, *args, **kwargs)

    def callback_item_added_del(self, func):
        self._callback_del("item,added", func)

    def callback_item_deleted_add(self, func, *args, **kwargs):
        self._callback_add("item,deleted", func, *args, **kwargs)

    def callback_item_deleted_del(self, func):
        self._callback_del("item,deleted", func)

    def callback_item_clicked_add(self, func, *args, **kwargs):
        self._callback_add("item,clicked", func, *args, **kwargs)

    def callback_item_clicked_del(self, func):
        self._callback_del("item,clicked", func)

    def callback_clicked_add(self, func, *args, **kwargs):
        self._callback_add("clicked", func, *args, **kwargs)

    def callback_clicked_del(self, func):
        self._callback_del("clicked", func)

    def callback_focused_add(self, func, *args, **kwargs):
        self._callback_add("focused", func, *args, **kwargs)

    def callback_focused_del(self, func):
        self._callback_del("focused", func)

    def callback_unfocused_add(self, func, *args, **kwargs):
        self._callback_add("unfocused", func, *args, **kwargs)

    def callback_unfocused_del(self, func):
        self._callback_del("unfocused", func)

    def callback_expanded_add(self, func, *args, **kwargs):
        self._callback_add("expanded", func, *args, **kwargs)

    def callback_expanded_del(self, func):
        self._callback_del("expanded", func)

    def callback_contracted_add(self, func, *args, **kwargs):
        self._callback_add("contracted", func, *args, **kwargs)

    def callback_contracted_del(self, func):
        self._callback_del("contracted", func)

    def callback_expand_state_changed_add(self, func, *args, **kwargs):
        self._callback_add("expand,state,changed", func, *args, **kwargs)

    def callback_expand_state_changed_del(self, func):
        self._callback_del("expand,state,changed", func)


_object_mapping_register("elm_multibuttonentry", MultiButtonEntry)