642 lines
22 KiB
Cython
642 lines
22 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/>.
|
||
#
|
||
|
||
"""
|
||
|
||
Widget description
|
||
------------------
|
||
|
||
Datetime widget is used to display and input date & time values.
|
||
|
||
This widget displays date and time as per the **system's locale** settings
|
||
(Date includes Day, Month & Year along with the defined separators and Time
|
||
includes Hour, Minute & AM/PM fields). Separator for AM/PM field is ignored.
|
||
|
||
The corresponding Month, AM/PM strings are displayed according to the
|
||
system’s language settings.
|
||
|
||
Datetime format is a combination of LIBC standard characters like "%%d %%b
|
||
%%Y %%I : %%M %%p" which, as a whole represents both Date as well as Time
|
||
format.
|
||
|
||
Elm_datetime supports only the following sub set of libc date format specifiers:
|
||
|
||
**%%Y**
|
||
The year as a decimal number including the century (example: 2011).
|
||
|
||
**%%y**
|
||
The year as a decimal number without a century (range 00 to 99)
|
||
|
||
**%%m**
|
||
The month as a decimal number (range 01 to 12).
|
||
|
||
**%%b**
|
||
The abbreviated month name according to the current locale.
|
||
|
||
**%%B**
|
||
The full month name according to the current locale.
|
||
|
||
**%%h**
|
||
The abbreviated month name according to the current locale(same as %%b).
|
||
|
||
**%%d**
|
||
The day of the month as a decimal number (range 01 to 31).
|
||
|
||
**%%e**
|
||
The day of the month as a decimal number (range 1 to 31). single
|
||
digits are preceded by a blank.
|
||
|
||
**%%I**
|
||
The hour as a decimal number using a 12-hour clock (range 01 to 12).
|
||
|
||
**%%H**
|
||
The hour as a decimal number using a 24-hour clock (range 00 to 23).
|
||
|
||
**%%k**
|
||
The hour (24-hour clock) as a decimal number (range 0 to 23). single
|
||
digits are preceded by a blank.
|
||
|
||
**%%l**
|
||
The hour (12-hour clock) as a decimal number (range 1 to 12); single
|
||
digits are preceded by a blank.
|
||
|
||
**%%M**
|
||
The minute as a decimal number (range 00 to 59).
|
||
|
||
**%%p**
|
||
Either 'AM' or 'PM' according to the given time value, or the
|
||
corresponding strings for the current locale. Noon is treated as 'PM'
|
||
and midnight as 'AM'
|
||
|
||
**%%P**
|
||
Like %p but in lower case: 'am' or 'pm' or a corresponding string for
|
||
the current locale.
|
||
|
||
**%%c**
|
||
The preferred date and time representation for the current locale.
|
||
|
||
**%%x**
|
||
The preferred date representation for the current locale without the time.
|
||
|
||
**%%X**
|
||
The preferred time representation for the current locale without the date.
|
||
|
||
**%%r**
|
||
The complete calendar time using the AM/PM format of the current locale.
|
||
|
||
**%%R**
|
||
The hour and minute in decimal numbers using the format %H:%M.
|
||
|
||
**%%T**
|
||
The time of day in decimal numbers using the format %H:%M:%S.
|
||
|
||
**%%D**
|
||
The date using the format %%m/%%d/%%y.
|
||
|
||
**%%F**
|
||
The date using the format %%Y-%%m-%%d.
|
||
|
||
(For more reference on the available **LIBC date format specifiers**,
|
||
please visit the link:
|
||
http://www.gnu.org/s/hello/manual/libc.html#Formatting-Calendar-Time )
|
||
|
||
Datetime widget can provide Unicode **separators** in between its fields
|
||
except for AM/PM field. A separator can be any **Unicode character**
|
||
other than the LIBC standard date format specifiers.
|
||
|
||
Example: In the format::
|
||
|
||
%%b %%d **,** %%y %%H **:** %%M
|
||
|
||
comma(,) is separator for date field %%d and colon(:) is separator for
|
||
hour field %%H.
|
||
|
||
The default format is a predefined one, based on the system Locale.
|
||
|
||
Hour format 12hr(1-12) or 24hr(0-23) display can be selected by setting
|
||
the corresponding user format.
|
||
|
||
Datetime supports six fields: Year, Month, Date, Hour, Minute, AM/PM.
|
||
Depending on the Datetime module that is loaded, the user can see
|
||
different UI to select the individual field values.
|
||
|
||
The individual fields of Datetime can be arranged in any order according
|
||
to the format set by application.
|
||
|
||
There is a provision to set the visibility of a particular field as TRUE/
|
||
FALSE so that **only time/ only date / only required fields** will be
|
||
displayed.
|
||
|
||
Each field is having a default minimum and maximum values just like the
|
||
daily calendar information. These min/max values can be modified as per
|
||
the application usage.
|
||
|
||
User can enter the values only in between the range of maximum and
|
||
minimum. Apart from these APIs, there is a provision to display only a
|
||
limited set of values out of the possible values. APIs to select the
|
||
individual field limits are intended for this purpose.
|
||
|
||
The whole widget is left aligned and its size grows horizontally
|
||
depending on the current format and each field's visible/disabled state.
|
||
|
||
Datetime individual field selection is implemented in a modular style.
|
||
Module can be implemented as a Ctxpopup based selection or an ISE based
|
||
selection or even a spinner like selection etc.
|
||
|
||
Datetime Module design
|
||
======================
|
||
|
||
The following functions are expected to be implemented in a Datetime module:
|
||
|
||
**Field creation**::
|
||
|
||
__________ __________
|
||
| |----- obj_hook() ---------------------->>>| |
|
||
| |<<<----------------returns Mod_data ------| |
|
||
| Datetime |_______ | |
|
||
| widget | |Assign module call backs | Module |
|
||
| base |<<<____| | |
|
||
| | | |
|
||
| |----- field_create() ------------------>>>| |
|
||
|__________|<<<----------------returns field_obj -----|__________|
|
||
|
||
**Field value setting**::
|
||
|
||
__________ __________
|
||
| | | |
|
||
| Datetime |<<<----------elm_datetime_value_set()---| |
|
||
| widget | | Module |
|
||
| base |----display_field_value()------------>>>| |
|
||
|__________| |__________|
|
||
|
||
**del_hook**::
|
||
|
||
__________ __________
|
||
| | | |
|
||
| Datetime |----obj_unhook()-------------------->>>>| |
|
||
| widget | | Module |
|
||
| base | <<<-----frees mod_data---------| |
|
||
|__________| |__________|
|
||
|
||
Any module can use the following shared functions that are implemented in
|
||
elm_datetime.c :
|
||
|
||
**field_format_get()** - gives the field format.
|
||
|
||
**field_limit_get()** - gives the field minimum, maximum limits.
|
||
|
||
To enable a module, set the ELM_MODULES environment variable as shown:
|
||
|
||
**export ELM_MODULES="datetime_input_ctxpopup>datetime/api"**
|
||
|
||
This widget emits the following signals, besides the ones sent from
|
||
:py:class:`~efl.elementary.layout_class.LayoutClass`:
|
||
|
||
- ``changed`` - whenever Datetime field value is changed, this
|
||
signal is sent.
|
||
- ``language,changed`` - whenever system locale changes, this
|
||
signal is sent.
|
||
- ``focused`` - When the datetime has received focus. (since 1.8)
|
||
- ``unfocused`` - When the datetime has lost focus. (since 1.8)
|
||
|
||
|
||
Enumerations
|
||
------------
|
||
|
||
.. _Elm_Datetime_Field_Type:
|
||
|
||
Datetime fields
|
||
===============
|
||
|
||
.. data:: ELM_DATETIME_YEAR
|
||
|
||
Year
|
||
|
||
.. data:: ELM_DATETIME_MONTH
|
||
|
||
Month
|
||
|
||
.. data:: ELM_DATETIME_DATE
|
||
|
||
Date
|
||
|
||
.. data:: ELM_DATETIME_HOUR
|
||
|
||
Hour
|
||
|
||
.. data:: ELM_DATETIME_MINUTE
|
||
|
||
Minute
|
||
|
||
.. data:: ELM_DATETIME_AMPM
|
||
|
||
Am/Pm
|
||
|
||
"""
|
||
|
||
from cpython cimport PyUnicode_AsUTF8String
|
||
|
||
from efl.eo cimport _object_mapping_register
|
||
from efl.utils.conversions cimport _ctouni
|
||
from efl.utils.deprecated cimport DEPRECATED
|
||
from efl.evas cimport Object as evasObject
|
||
from object cimport Object
|
||
|
||
from datetime import datetime
|
||
|
||
cimport enums
|
||
|
||
ELM_DATETIME_YEAR = enums.ELM_DATETIME_YEAR
|
||
ELM_DATETIME_MONTH = enums.ELM_DATETIME_MONTH
|
||
ELM_DATETIME_DATE = enums.ELM_DATETIME_DATE
|
||
ELM_DATETIME_HOUR = enums.ELM_DATETIME_HOUR
|
||
ELM_DATETIME_MINUTE = enums.ELM_DATETIME_MINUTE
|
||
ELM_DATETIME_AMPM = enums.ELM_DATETIME_AMPM
|
||
|
||
cdef class Datetime(Object):
|
||
|
||
"""This is the class that actually implements the widget."""
|
||
|
||
def __init__(self, evasObject parent, *args, **kwargs):
|
||
self._set_obj(elm_datetime_add(parent.obj))
|
||
self._set_properties_from_keyword_args(kwargs)
|
||
|
||
property format:
|
||
"""The datetime format. Format is a combination of allowed Libc date format
|
||
specifiers like: "%b %d, %Y %I : %M %p".
|
||
|
||
Maximum allowed format length is 64 chars.
|
||
|
||
Format can include separators for each individual datetime field except
|
||
for AM/PM field.
|
||
|
||
Each separator can be a maximum of 6 UTF-8 bytes.
|
||
Space is also taken as a separator.
|
||
|
||
Following are the allowed set of format specifiers for each datetime field.
|
||
|
||
**%%Y**
|
||
The year as a decimal number including the century.
|
||
|
||
**%%y**
|
||
The year as a decimal number without a century (range 00 to 99).
|
||
|
||
**%%m**
|
||
The month as a decimal number (range 01 to 12).
|
||
|
||
**%%b**
|
||
The abbreviated month name according to the current locale.
|
||
|
||
**%%B**
|
||
The full month name according to the current locale.
|
||
|
||
**%%h**
|
||
The abbreviated month name according to the current locale(same as %%b).
|
||
|
||
**%%d**
|
||
The day of the month as a decimal number (range 01 to 31).
|
||
|
||
**%%e**
|
||
The day of the month as a decimal number (range 1 to 31). single
|
||
digits are preceded by a blank.
|
||
|
||
**%%I**
|
||
The hour as a decimal number using a 12-hour clock (range 01 to 12).
|
||
|
||
**%%H**
|
||
The hour as a decimal number using a 24-hour clock (range 00 to 23).
|
||
|
||
**%%k**
|
||
The hour (24-hour clock) as a decimal number (range 0 to 23). single
|
||
digits are preceded by a blank.
|
||
|
||
**%%l**
|
||
The hour (12-hour clock) as a decimal number (range 1 to 12); single
|
||
digits are preceded by a blank.
|
||
|
||
**%%M**
|
||
The minute as a decimal number (range 00 to 59).
|
||
|
||
**%%p**
|
||
Either 'AM' or 'PM' according to the given time value, or the
|
||
corresponding strings for the current locale. Noon is treated as 'PM'
|
||
and midnight as 'AM'.
|
||
|
||
**%%P**
|
||
Like %p but in lower case: 'am' or 'pm' or a corresponding string for
|
||
the current locale.
|
||
|
||
**%%c**
|
||
The preferred date and time representation for the current locale.
|
||
|
||
**%%x**
|
||
The preferred date representation for the current locale without the time.
|
||
|
||
**%%X**
|
||
The preferred time representation for the current locale without the date.
|
||
|
||
**%%r**
|
||
The complete calendar time using the AM/PM format of the current locale.
|
||
|
||
**%%R**
|
||
The hour and minute in decimal numbers using the format %H:%M.
|
||
|
||
**%%T**
|
||
The time of day in decimal numbers using the format %H:%M:%S.
|
||
|
||
**%%D**
|
||
The date using the format %%m/%%d/%%y.
|
||
|
||
**%%F**
|
||
The date using the format %%Y-%%m-%%d.
|
||
|
||
These specifiers can be arranged in any order and the widget will display the
|
||
fields accordingly.
|
||
|
||
Default format is taken as per the system locale settings.
|
||
|
||
:type: string
|
||
|
||
"""
|
||
def __get__(self):
|
||
return _ctouni(elm_datetime_format_get(self.obj))
|
||
def __set__(self, fmt):
|
||
if isinstance(fmt, unicode): fmt = PyUnicode_AsUTF8String(fmt)
|
||
elm_datetime_format_set(self.obj,
|
||
<const char *>fmt if fmt is not None else NULL)
|
||
|
||
property value_max:
|
||
"""The upper boundary of a field.
|
||
|
||
Year: years since 1900. Negative value represents year below 1900 (year
|
||
value -30 represents 1870). Year default range is from 70 to 137.
|
||
|
||
Month: default value range is from 0 to 11.
|
||
|
||
Date: default value range is from 1 to 31 according to the month value.
|
||
|
||
Hour: default value will be in terms of 24 hr format (0~23)
|
||
|
||
Minute: default value range is from 0 to 59.
|
||
|
||
:raise RuntimeError: when the max value could not be set.
|
||
|
||
:type: datetime.datetime
|
||
|
||
.. versionchanged:: 1.8
|
||
Returns None when the max value cannot be fetched, raise
|
||
RuntimeError when setting the max value failed.
|
||
|
||
"""
|
||
def __get__(self):
|
||
cdef tm time
|
||
if not elm_datetime_value_max_get(self.obj, &time):
|
||
return None
|
||
ret = datetime( time.tm_year + 1900,
|
||
time.tm_mon + 1,
|
||
time.tm_mday,
|
||
time.tm_hour,
|
||
time.tm_min,
|
||
time.tm_sec)
|
||
return ret
|
||
|
||
def __set__(self, newtime):
|
||
cdef tm time
|
||
tmtup = newtime.timetuple()
|
||
time.tm_sec = tmtup.tm_sec
|
||
time.tm_min = tmtup.tm_min
|
||
time.tm_hour = tmtup.tm_hour
|
||
time.tm_mday = tmtup.tm_mday
|
||
time.tm_mon = tmtup.tm_mon - 1
|
||
time.tm_year = tmtup.tm_year - 1900
|
||
time.tm_wday = tmtup.tm_wday
|
||
time.tm_yday = tmtup.tm_yday
|
||
time.tm_isdst = tmtup.tm_isdst
|
||
if not elm_datetime_value_max_set(self.obj, &time):
|
||
raise RuntimeError
|
||
|
||
property value_min:
|
||
"""The lower boundary of a field.
|
||
|
||
Year: years since 1900. Negative value represents year below 1900 (year
|
||
value -30 represents 1870). Year default range is from 70 to 137.
|
||
|
||
Month: default value range is from 0 to 11.
|
||
|
||
Date: default value range is from 1 to 31 according to the month value.
|
||
|
||
Hour: default value will be in terms of 24 hr format (0~23)
|
||
|
||
Minute: default value range is from 0 to 59.
|
||
|
||
:raise RuntimeError: when the min value could not be set.
|
||
|
||
:type: datetime.datetime
|
||
|
||
.. versionchanged:: 1.8
|
||
Returns None when the min value cannot be fetched, raise
|
||
RuntimeError when setting the min value failed.
|
||
|
||
"""
|
||
def __get__(self):
|
||
cdef tm time
|
||
if not elm_datetime_value_min_get(self.obj, &time):
|
||
return None
|
||
ret = datetime( time.tm_year + 1900,
|
||
time.tm_mon + 1,
|
||
time.tm_mday,
|
||
time.tm_hour,
|
||
time.tm_min,
|
||
time.tm_sec)
|
||
return ret
|
||
|
||
def __set__(self, newtime):
|
||
cdef tm time
|
||
tmtup = newtime.timetuple()
|
||
time.tm_sec = tmtup.tm_sec
|
||
time.tm_min = tmtup.tm_min
|
||
time.tm_hour = tmtup.tm_hour
|
||
time.tm_mday = tmtup.tm_mday
|
||
time.tm_mon = tmtup.tm_mon - 1
|
||
time.tm_year = tmtup.tm_year - 1900
|
||
time.tm_wday = tmtup.tm_wday
|
||
time.tm_yday = tmtup.tm_yday
|
||
time.tm_isdst = tmtup.tm_isdst
|
||
if not elm_datetime_value_min_set(self.obj, &time):
|
||
raise RuntimeError
|
||
|
||
def field_limit_get(self, Elm_Datetime_Field_Type fieldtype):
|
||
"""Get the field limits of a field.
|
||
|
||
Limits can be set to individual fields, independently, except for AM/PM field.
|
||
Any field can display the values only in between these Minimum and Maximum limits unless
|
||
the corresponding time value is restricted from MinTime to MaxTime.
|
||
That is, Min/ Max field limits always works under the limitations of MinTime/ MaxTime.
|
||
|
||
There is no provision to set the limits of AM/PM field.
|
||
|
||
:param fieldtype: Type of the field. ELM_DATETIME_YEAR etc.
|
||
|
||
"""
|
||
cdef int min, max
|
||
elm_datetime_field_limit_get(self.obj, fieldtype, &min, &max)
|
||
return min, max
|
||
|
||
def field_limit_set(self, Elm_Datetime_Field_Type fieldtype, int min, int max):
|
||
"""Set the field limits of a field.
|
||
|
||
Limits can be set to individual fields, independently, except for AM/PM field.
|
||
Any field can display the values only in between these Minimum and Maximum limits unless
|
||
the corresponding time value is restricted from MinTime to MaxTime.
|
||
That is, Min/ Max field limits always works under the limitations of MinTime/ MaxTime.
|
||
|
||
There is no provision to set the limits of AM/PM field.
|
||
|
||
:param Elm_Datetime_Field_Type fieldtype: Type of the field. ELM_DATETIME_YEAR etc.
|
||
:param int min: Reference to field's minimum value
|
||
:param int max: Reference to field's maximum value
|
||
|
||
"""
|
||
elm_datetime_field_limit_set(self.obj, fieldtype, min, max)
|
||
|
||
property value:
|
||
"""The current value of a field.
|
||
|
||
Year: years since 1900. Negative value represents year below 1900 (year
|
||
value -30 represents 1870). Year default range is from 70 to 137.
|
||
|
||
Month: default value range is from 0 to 11.
|
||
|
||
Date: default value range is from 1 to 31 according to the month value.
|
||
|
||
Hour: default value will be in terms of 24 hr format (0~23)
|
||
|
||
Minute: default value range is from 0 to 59.
|
||
|
||
:raise RuntimeError: when the value could not be set.
|
||
|
||
:type: datetime.datetime
|
||
|
||
.. versionchanged:: 1.8
|
||
Returns None when the value cannot be fetched, raise RuntimeError
|
||
when setting the value failed.
|
||
|
||
"""
|
||
def __get__(self):
|
||
cdef tm time
|
||
if not elm_datetime_value_get(self.obj, &time):
|
||
return None
|
||
ret = datetime( time.tm_year + 1900,
|
||
time.tm_mon + 1,
|
||
time.tm_mday,
|
||
time.tm_hour,
|
||
time.tm_min,
|
||
time.tm_sec)
|
||
return ret
|
||
|
||
def __set__(self, newtime):
|
||
cdef tm time
|
||
tmtup = newtime.timetuple()
|
||
time.tm_sec = tmtup.tm_sec
|
||
time.tm_min = tmtup.tm_min
|
||
time.tm_hour = tmtup.tm_hour
|
||
time.tm_mday = tmtup.tm_mday
|
||
time.tm_mon = tmtup.tm_mon - 1
|
||
time.tm_year = tmtup.tm_year - 1900
|
||
time.tm_wday = tmtup.tm_wday
|
||
time.tm_yday = tmtup.tm_yday
|
||
time.tm_isdst = tmtup.tm_isdst
|
||
if not elm_datetime_value_set(self.obj, &time):
|
||
raise RuntimeError
|
||
|
||
def field_visible_get(self, fieldtype):
|
||
"""Whether a field can be visible/not
|
||
|
||
.. seealso:: :py:meth:`field_visible_set`
|
||
|
||
:param fieldtype: Type of the field. ELM_DATETIME_YEAR etc
|
||
:type fieldtype: :ref:`Elm_Datetime_Field_Type`
|
||
:return: ``True``, if field can be visible. ``False`` otherwise.
|
||
:rtype: bool
|
||
|
||
"""
|
||
return bool(elm_datetime_field_visible_get(self.obj, fieldtype))
|
||
|
||
def field_visible_set(self, fieldtype, visible):
|
||
"""Set a field to be visible or not.
|
||
|
||
Setting this API True does not ensure that the field is visible,
|
||
apart from this, the field's format must be present in Datetime
|
||
overall format. If a field's visibility is set to False then it
|
||
won't appear even though its format is present in overall format. So
|
||
if and only if this API is set true and the corresponding field's
|
||
format is present in Datetime format, the field is visible.
|
||
|
||
By default the field visibility is set to True.
|
||
|
||
.. seealso:: :py:meth:`field_visible_get`
|
||
|
||
:param fieldtype: Type of the field. ELM_DATETIME_YEAR etc.
|
||
:type fieldtype: :ref:`Elm_Datetime_Field_Type`
|
||
:param visible: ``True`` field can be visible, ``False`` otherwise.
|
||
:type visible: bool
|
||
|
||
"""
|
||
elm_datetime_field_visible_set(self.obj, fieldtype, visible)
|
||
|
||
def callback_changed_add(self, func, *args, **kwargs):
|
||
"""Whenever Datetime field value is changed, this signal is sent."""
|
||
self._callback_add("changed", func, *args, **kwargs)
|
||
|
||
def callback_changed_del(self, func):
|
||
self._callback_del("changed", func)
|
||
|
||
@DEPRECATED("1.10", "Use callback_language_changed_add instead.")
|
||
def callback_languge_changed_add(self, func, *args, **kwargs):
|
||
"""Whenever system locale changes, this signal is sent."""
|
||
self._callback_add("language,changed", func, *args, **kwargs)
|
||
|
||
def callback_language_changed_add(self, func, *args, **kwargs):
|
||
"""Whenever system locale changes, this signal is sent."""
|
||
self._callback_add("language,changed", func, *args, **kwargs)
|
||
|
||
def callback_language_changed_del(self, func):
|
||
self._callback_del("language,changed", func)
|
||
|
||
def callback_focused_add(self, func, *args, **kwargs):
|
||
"""When the datetime has received focus.
|
||
|
||
.. versionadded:: 1.8
|
||
"""
|
||
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):
|
||
"""When the datetime has lost focus.
|
||
|
||
.. versionadded:: 1.8
|
||
"""
|
||
self._callback_add("unfocused", func, *args, **kwargs)
|
||
|
||
def callback_unfocused_del(self, func):
|
||
self._callback_del("unfocused", func)
|
||
|
||
_object_mapping_register("Elm_Datetime", Datetime)
|