python-efl/efl/elementary/frame.pyx

133 lines
3.7 KiB
Cython

# 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 <http://www.gnu.org/licenses/>.
"""
.. image:: /images/frame-preview.png
Widget description
------------------
Frame is a widget that holds some content and has a title.
The default look is a frame with a title, but Frame supports multiple
styles:
- default
- pad_small
- pad_medium
- pad_large
- pad_huge
- outdent_top
- outdent_bottom
Of all this styles only default shows the title.
This widget emits the following signals, besides the ones sent from
:py:class:`~efl.elementary.layout_class.LayoutClass`:
- ``"clicked"`` - The user has clicked the frame's label
Default content parts of the frame widget that you can use for are:
- "default" - A content of the frame
Default text parts of the frame widget that you can use for are:
- "default" - Label of the frame
"""
from cpython cimport PyUnicode_AsUTF8String
from efl.eo cimport _object_mapping_register
from efl.utils.conversions cimport _ctouni
from efl.evas cimport Object as evasObject
from layout_class cimport LayoutClass
cdef class Frame(LayoutClass):
"""This is the class that actually implements the widget."""
def __init__(self, evasObject parent, *args, **kwargs):
self._set_obj(elm_frame_add(parent.obj))
self._set_properties_from_keyword_args(kwargs)
property autocollapse:
"""Autocollapsing of a frame
When this is True, clicking a frame's label will collapse the frame
vertically, shrinking it to the height of the label. By default,
this is DISABLED.
:type: bool
"""
def __get__(self):
return elm_frame_autocollapse_get(self.obj)
def __set__(self, autocollapse):
elm_frame_autocollapse_set(self.obj, autocollapse)
def autocollapse_set(self, autocollapse):
elm_frame_autocollapse_set(self.obj, autocollapse)
def autocollapse_get(self):
return elm_frame_autocollapse_get(self.obj)
property collapse:
"""The collapse state of a frame, bypassing animations
:type: bool
"""
def __get__(self):
return elm_frame_collapse_get(self.obj)
def __set__(self, autocollapse):
elm_frame_collapse_set(self.obj, autocollapse)
def collapse_set(self, autocollapse):
elm_frame_collapse_set(self.obj, autocollapse)
def collapse_get(self):
return elm_frame_collapse_get(self.obj)
def collapse_go(self, collapse):
"""collapse_go(bool collapse)
Manually collapse a frame with animations
Use this to toggle the collapsed state of a frame, triggering
animations.
:param collapse: True to collapse, False to expand
:type collapse: bool
"""
elm_frame_collapse_go(self.obj, collapse)
def callback_clicked_add(self, func, *args, **kwargs):
"""The user has clicked the frame's label."""
self._callback_add("clicked", func, *args, **kwargs)
def callback_clicked_del(self, func):
self._callback_del("clicked", func)
_object_mapping_register("Elm_Frame", Frame)