241 lines
7.3 KiB
Cython
241 lines
7.3 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/dayselector-preview.png
|
|
|
|
Widget description
|
|
------------------
|
|
|
|
Dayselector displays all seven days of the week and allows the user to
|
|
select multiple days.
|
|
|
|
The selection can be toggle by just clicking on the day.
|
|
|
|
Dayselector also provides the functionality to check whether a day is
|
|
selected or not.
|
|
|
|
First day of the week is taken from config settings by default. It can be
|
|
altered by using the API :py:attr:`~Dayselector.week_start` API.
|
|
|
|
APIs are provided for setting the duration of weekend
|
|
:py:attr:`~Dayselector.weekend_start` and :py:attr:`~Dayselector.weekend_length`
|
|
does this job.
|
|
|
|
Two styles of weekdays and weekends are supported in Dayselector.
|
|
Application can emit signals on individual check objects for setting the
|
|
weekday, weekend styles.
|
|
|
|
Once the weekend start day or weekend length changes, all the weekday &
|
|
weekend styles will be reset to default style. It's the application's
|
|
responsibility to set the styles again by sending corresponding signals.
|
|
|
|
"day0" indicates Sunday, "day1" indicates Monday etc. continues and so,
|
|
"day6" indicates the Saturday part name.
|
|
|
|
Application can change individual day display string by using the API
|
|
:py:meth:`~efl.elementary.object.Object.part_text_set`.
|
|
|
|
:py:meth:`~efl.elementary.object.Object.part_content_set` API sets the
|
|
individual day object only if the passed one is a Check widget.
|
|
|
|
Check object representing a day can be set/get by the application by using
|
|
the elm_object_part_content_set/get APIs thus providing a way to handle
|
|
the different check styles for individual days.
|
|
|
|
This widget emits the following signals, besides the ones sent from
|
|
:py:class:`~efl.elementary.layout_class.LayoutClass`:
|
|
|
|
- ``dayselector,changed`` - when the user changes the state of a day.
|
|
- ``language,changed`` - the program's language changed
|
|
|
|
Available styles for dayselector are:
|
|
|
|
- ``default``
|
|
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _Elm_Dayselector_Day:
|
|
|
|
Dayselector days
|
|
================
|
|
|
|
.. data:: ELM_DAYSELECTOR_SUN
|
|
|
|
Sunday
|
|
|
|
.. data:: ELM_DAYSELECTOR_MON
|
|
|
|
Monday
|
|
|
|
.. data:: ELM_DAYSELECTOR_TUE
|
|
|
|
Tuesday
|
|
|
|
.. data:: ELM_DAYSELECTOR_WED
|
|
|
|
Wednesday
|
|
|
|
.. data:: ELM_DAYSELECTOR_THU
|
|
|
|
Thursday
|
|
|
|
.. data:: ELM_DAYSELECTOR_FRI
|
|
|
|
Friday
|
|
|
|
.. data:: ELM_DAYSELECTOR_SAT
|
|
|
|
Saturday
|
|
|
|
"""
|
|
|
|
from efl.eo cimport _object_mapping_register
|
|
from efl.evas cimport Object as evasObject
|
|
from efl.utils.conversions cimport python_list_strings_to_array_of_strings, \
|
|
eina_list_strings_to_python_list
|
|
from layout_class cimport LayoutClass
|
|
|
|
cimport enums
|
|
|
|
ELM_DAYSELECTOR_SUN = enums.ELM_DAYSELECTOR_SUN
|
|
ELM_DAYSELECTOR_MON = enums.ELM_DAYSELECTOR_MON
|
|
ELM_DAYSELECTOR_TUE = enums.ELM_DAYSELECTOR_TUE
|
|
ELM_DAYSELECTOR_WED = enums.ELM_DAYSELECTOR_WED
|
|
ELM_DAYSELECTOR_THU = enums.ELM_DAYSELECTOR_THU
|
|
ELM_DAYSELECTOR_FRI = enums.ELM_DAYSELECTOR_FRI
|
|
ELM_DAYSELECTOR_SAT = enums.ELM_DAYSELECTOR_SAT
|
|
ELM_DAYSELECTOR_MAX = enums.ELM_DAYSELECTOR_MAX
|
|
|
|
cdef class Dayselector(LayoutClass):
|
|
|
|
"""This is the class that actually implements the widget."""
|
|
|
|
def __init__(self, evasObject parent, *args, **kwargs):
|
|
self._set_obj(elm_dayselector_add(parent.obj))
|
|
self._set_properties_from_keyword_args(kwargs)
|
|
|
|
def day_selected_set(self, day, selected):
|
|
"""Set the state of given Dayselector_Day.
|
|
|
|
:param day: The day that the user want to set state.
|
|
:type day: :ref:`Elm_Dayselector_Day`
|
|
:param selected: state of the day. ``True`` is selected.
|
|
:type selected: bool
|
|
|
|
"""
|
|
elm_dayselector_day_selected_set(self.obj, day, selected)
|
|
|
|
def day_selected_get(self, day):
|
|
"""Get the state of given Dayselector_Day.
|
|
|
|
:param day: The day that the user want to know state.
|
|
:type day: :ref:`Elm_Dayselector_Day`
|
|
:return: ``True``, if the Day is selected
|
|
:rtype: bool
|
|
|
|
"""
|
|
return bool(elm_dayselector_day_selected_get(self.obj, day))
|
|
|
|
property week_start:
|
|
"""The starting day of Dayselector.
|
|
|
|
:type: :ref:`Elm_Dayselector_Day`
|
|
|
|
"""
|
|
def __get__(self):
|
|
return elm_dayselector_week_start_get(self.obj)
|
|
def __set__(self, day):
|
|
elm_dayselector_week_start_set(self.obj, day)
|
|
|
|
property weekend_start:
|
|
"""The weekend starting day of Dayselector.
|
|
|
|
:type: :ref:`Elm_Dayselector_Day`
|
|
|
|
"""
|
|
def __get__(self):
|
|
return elm_dayselector_weekend_start_get(self.obj)
|
|
def __set__(self, day):
|
|
elm_dayselector_weekend_start_set(self.obj, day)
|
|
|
|
property weekend_length:
|
|
"""The weekend length of Dayselector.
|
|
|
|
:type: int
|
|
|
|
"""
|
|
def __get__(self):
|
|
return elm_dayselector_weekend_length_get(self.obj)
|
|
def __set__(self, length):
|
|
elm_dayselector_weekend_length_set(self.obj, length)
|
|
|
|
property weekdays_names:
|
|
"""
|
|
|
|
Set weekdays names to be displayed by the Dayselector.
|
|
|
|
:param weekdays: List of seven strings to be used as weekday names.
|
|
|
|
.. warning:: It must have 7 elements, or it will access invalid memory.
|
|
|
|
By default or if set to None, weekdays abbreviations get from system are
|
|
displayed: E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
|
|
|
|
The first string should be related to Sunday, the second to Monday...
|
|
|
|
The usage should be like this::
|
|
|
|
dayselector.weekdays_names = ["Sunday", "Monday", "Tuesday",
|
|
"Wednesday", "Thursday", "Friday", "Saturday"]
|
|
|
|
:see: :py:attr:`weekend_start`
|
|
|
|
.. versionadded:: 1.8
|
|
|
|
"""
|
|
def __set__(self, list weekdays):
|
|
# TODO: Add checks for list validity (len == 7 etc.)
|
|
elm_dayselector_weekdays_names_set(self.obj,
|
|
python_list_strings_to_array_of_strings(weekdays))
|
|
|
|
def __get__(self):
|
|
return eina_list_strings_to_python_list(
|
|
elm_dayselector_weekdays_names_get(self.obj)
|
|
)
|
|
|
|
def callback_dayselector_changed_add(self, func, *args, **kwargs):
|
|
"""when the user changes the state of a day."""
|
|
self._callback_add("dayselector,changed", func, *args, **kwargs)
|
|
|
|
def callback_dayselector_changed_del(self, func):
|
|
self._callback_del("dayselector,changed", func)
|
|
|
|
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)
|
|
|
|
|
|
_object_mapping_register("Elm_Dayselector", Dayselector)
|