309 lines
8.8 KiB
Cython
309 lines
8.8 KiB
Cython
# Copyright (C) 2007-2014 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/label-preview.png
|
|
|
|
Widget description
|
|
------------------
|
|
|
|
Widget to display text, with simple html-like markup.
|
|
|
|
The Label widget **doesn't** allow text to overflow its boundaries, if the
|
|
text doesn't fit the geometry of the label it will be ellipsized or be
|
|
cut. Elementary provides several styles for this widget:
|
|
|
|
- default - No animation
|
|
- marker - Centers the text in the label and makes it bold by default
|
|
- slide_long - The entire text appears from the right of the screen and
|
|
slides until it disappears in the left of the screen(reappearing on
|
|
the right again).
|
|
- slide_short - The text appears in the left of the label and slides to
|
|
the right to show the overflow. When all of the text has been shown
|
|
the position is reset.
|
|
- slide_bounce - The text appears in the left of the label and slides to
|
|
the right to show the overflow. When all of the text has been shown
|
|
the animation reverses, moving the text to the left.
|
|
|
|
Custom themes can of course invent new markup tags and style them any way
|
|
they like.
|
|
|
|
This widget emits the following signals, besides the ones sent from
|
|
:py:class:`~efl.elementary.layout_class.LayoutClass`:
|
|
|
|
- ``language,changed`` - The program's language changed.
|
|
- ``slide,end`` - The slide is end.
|
|
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _Elm_Label_Wrap_Type:
|
|
|
|
Wrap modes
|
|
==========
|
|
|
|
.. data:: ELM_WRAP_NONE
|
|
|
|
No wrap
|
|
|
|
.. data:: ELM_WRAP_CHAR
|
|
|
|
Wrap between characters
|
|
|
|
.. data:: ELM_WRAP_WORD
|
|
|
|
Wrap in allowed wrapping points (as defined in the unicode standard)
|
|
|
|
.. data:: ELM_WRAP_MIXED
|
|
|
|
Word wrap, and if that fails, char wrap.
|
|
|
|
|
|
.. _Elm_Label_Slide_Mode:
|
|
|
|
Slide modes
|
|
===========
|
|
|
|
.. data:: ELM_LABEL_SLIDE_MODE_NONE
|
|
|
|
The label will never slide.
|
|
|
|
.. data:: ELM_LABEL_SLIDE_MODE_AUTO
|
|
|
|
The label slide if the content is bigger than it's container.
|
|
|
|
.. data:: ELM_LABEL_SLIDE_MODE_ALWAYS
|
|
|
|
The label will always slide.
|
|
|
|
"""
|
|
|
|
from efl.eo cimport _object_mapping_register
|
|
from efl.evas cimport Object as evasObject
|
|
from layout_class cimport LayoutClass
|
|
from efl.utils.deprecated cimport DEPRECATED
|
|
|
|
cimport enums
|
|
|
|
ELM_WRAP_NONE = enums.ELM_WRAP_NONE
|
|
ELM_WRAP_CHAR = enums.ELM_WRAP_CHAR
|
|
ELM_WRAP_WORD = enums.ELM_WRAP_WORD
|
|
ELM_WRAP_MIXED = enums.ELM_WRAP_MIXED
|
|
|
|
ELM_LABEL_SLIDE_MODE_NONE = enums.ELM_LABEL_SLIDE_MODE_NONE
|
|
ELM_LABEL_SLIDE_MODE_AUTO = enums.ELM_LABEL_SLIDE_MODE_AUTO
|
|
ELM_LABEL_SLIDE_MODE_ALWAYS = enums.ELM_LABEL_SLIDE_MODE_ALWAYS
|
|
|
|
|
|
cdef class Label(LayoutClass):
|
|
|
|
"""This is the class that actually implements the widget."""
|
|
|
|
def __init__(self, evasObject parent, *args, **kwargs):
|
|
self._set_obj(elm_label_add(parent.obj))
|
|
self._set_properties_from_keyword_args(kwargs)
|
|
|
|
property line_wrap:
|
|
"""The wrapping behavior of the label
|
|
|
|
By default no wrapping is done.
|
|
|
|
:type: :ref:`Elm_Label_Wrap_Type`
|
|
|
|
"""
|
|
def __get__(self):
|
|
return elm_label_line_wrap_get(self.obj)
|
|
|
|
def __set__(self, wrap):
|
|
elm_label_line_wrap_set(self.obj, wrap)
|
|
|
|
def line_wrap_set(self, Elm_Wrap_Type wrap):
|
|
elm_label_line_wrap_set(self.obj, wrap)
|
|
def line_wrap_get(self):
|
|
return elm_label_line_wrap_get(self.obj)
|
|
|
|
property wrap_width:
|
|
"""Wrap width of the label
|
|
|
|
This is the maximum width size hint of the label.
|
|
|
|
.. warning:: This is only relevant if the label is inside a container.
|
|
|
|
:type: int
|
|
|
|
"""
|
|
def __get__(self):
|
|
return elm_label_wrap_width_get(self.obj)
|
|
|
|
def __set__(self, w):
|
|
elm_label_wrap_width_set(self.obj, w)
|
|
|
|
def wrap_width_set(self, int w):
|
|
elm_label_wrap_width_set(self.obj, w)
|
|
def wrap_width_get(self):
|
|
return elm_label_wrap_width_get(self.obj)
|
|
|
|
property ellipsis:
|
|
"""The ellipsis behavior of the label
|
|
|
|
If set to True and the text doesn't fit in the label an
|
|
ellipsis("...") will be shown at the end of the widget.
|
|
|
|
.. warning:: This doesn't work with slide(:py:attr:`slide`) or if the
|
|
chosen wrap method was ELM_WRAP_WORD.
|
|
|
|
:type: bool
|
|
|
|
"""
|
|
def __get__(self):
|
|
return elm_label_ellipsis_get(self.obj)
|
|
|
|
def __set__(self, ellipsis):
|
|
elm_label_ellipsis_set(self.obj, ellipsis)
|
|
|
|
def ellipsis_set(self, bint ellipsis):
|
|
elm_label_ellipsis_set(self.obj, ellipsis)
|
|
def ellipsis_get(self):
|
|
return elm_label_ellipsis_get(self.obj)
|
|
|
|
property slide:
|
|
"""
|
|
|
|
.. deprecated:: 1.8
|
|
Use :py:attr:`slide_mode` instead.
|
|
|
|
"""
|
|
def __get__(self):
|
|
return self.slide_get()
|
|
|
|
def __set__(self, slide):
|
|
self.slide_set(ELM_LABEL_SLIDE_MODE_ALWAYS if slide else ELM_LABEL_SLIDE_MODE_NONE)
|
|
|
|
@DEPRECATED("1.8", "Use :py:attr:`slide_mode` instead.")
|
|
def slide_set(self, bint slide):
|
|
elm_label_slide_mode_set(self.obj,
|
|
ELM_LABEL_SLIDE_MODE_ALWAYS if slide else ELM_LABEL_SLIDE_MODE_NONE)
|
|
@DEPRECATED("1.8", "Use :py:attr:`slide_mode` instead.")
|
|
def slide_get(self):
|
|
return bool(elm_label_slide_mode_get(self.obj))
|
|
|
|
property slide_duration:
|
|
"""The duration time in moving text from slide begin position to
|
|
slide end position
|
|
|
|
:type: float
|
|
|
|
.. note:: If you set the speed of the slide using :py:attr:`slide_speed`
|
|
you cannot get the correct duration using this function until
|
|
the label is actually rendered and resized.
|
|
|
|
"""
|
|
def __get__(self):
|
|
return elm_label_slide_duration_get(self.obj)
|
|
|
|
def __set__(self, duration):
|
|
elm_label_slide_duration_set(self.obj, duration)
|
|
|
|
def slide_duration_set(self, duration):
|
|
elm_label_slide_duration_set(self.obj, duration)
|
|
def slide_duration_get(self):
|
|
return elm_label_slide_duration_get(self.obj)
|
|
|
|
property slide_speed:
|
|
"""The speed of the slide animation in px per seconds
|
|
|
|
:type: float
|
|
|
|
.. note:: If you set the duration of the slide using :py:attr:`slide_duration`
|
|
you cannot get the correct speed using this function until
|
|
the label is actually rendered and resized.
|
|
|
|
.. versionadded:: 1.9
|
|
|
|
"""
|
|
def __get__(self):
|
|
return elm_label_slide_speed_get(self.obj)
|
|
|
|
def __set__(self, speed):
|
|
elm_label_slide_speed_set(self.obj, speed)
|
|
|
|
def slide_speed_set(self, speed):
|
|
elm_label_slide_speed_set(self.obj, speed)
|
|
def slide_speed_get(self):
|
|
return elm_label_slide_speed_get(self.obj)
|
|
|
|
# TODO: What the heck does this do?
|
|
# property slide_area_limit:
|
|
# """
|
|
# Slide only if the
|
|
|
|
# :type: bool
|
|
|
|
# .. versionadded:: 1.8
|
|
|
|
# """
|
|
# def __set__(self, bint limit):
|
|
# elm_label_slide_area_limit_set(self.obj, limit)
|
|
|
|
property slide_mode:
|
|
"""Change the slide mode of the label widget.
|
|
|
|
By default, slide mode is none.
|
|
|
|
:type: :ref:`Elm_Label_Slide_Mode`
|
|
|
|
.. versionadded:: 1.8
|
|
|
|
"""
|
|
def __get__(self):
|
|
return elm_label_slide_mode_get(self.obj)
|
|
|
|
def __set__(self, mode):
|
|
elm_label_slide_mode_set(self.obj, mode)
|
|
|
|
def slide_mode_set(self, mode):
|
|
elm_label_slide_mode_set(self.obj, mode)
|
|
def slide_mode_get(self):
|
|
return elm_label_slide_mode_get(self.obj)
|
|
|
|
def slide_go(self):
|
|
"""Start the slide effect.
|
|
|
|
.. versionadded:: 1.8
|
|
|
|
"""
|
|
elm_label_slide_go(self.obj)
|
|
|
|
def callback_language_changed_add(self, func, *args, **kwargs):
|
|
"""The program's language changed."""
|
|
self._callback_add("language,changed", func, *args, **kwargs)
|
|
|
|
def callback_language_changed_del(self, func):
|
|
self._callback_del("language,changed", func)
|
|
|
|
def callback_slide_end_add(self, func, *args, **kwargs):
|
|
"""A slide effect has ended."""
|
|
self._callback_add("slide,end", func, *args, **kwargs)
|
|
|
|
def callback_slide_end_del(self, func):
|
|
self._callback_del("slide,end", func)
|
|
|
|
_object_mapping_register("Elm_Label", Label)
|