Elm_Dayselector(3)

NAME
Elm_Dayselector - Dayselector

 - Dayselector widget:

SYNOPSIS

  Macros
#define ELM_DAYSELECTOR_CLASS elm_dayselector_class_get()
Elementary dayselector class.

  Enumerations
enum Elm_Dayselector_Day { ELM_DAYSELECTOR_SUN = 0, ELM_DAYSELECTOR_MON, ELM_DAYSELECTOR_TUE, ELM_DAYSELECTOR_WED, ELM_DAYSELECTOR_THU, ELM_DAYSELECTOR_FRI, ELM_DAYSELECTOR_SAT, ELM_DAYSELECTOR_MAX, ELM_DAYSELECTOR_SUN = 0, ELM_DAYSELECTOR_MON, ELM_DAYSELECTOR_TUE, ELM_DAYSELECTOR_WED, ELM_DAYSELECTOR_THU, ELM_DAYSELECTOR_FRI, ELM_DAYSELECTOR_SAT, ELM_DAYSELECTOR_MAX }
Identifies the day of the week.
enum Elm_Dayselector_Day { ELM_DAYSELECTOR_SUN = 0, ELM_DAYSELECTOR_MON, ELM_DAYSELECTOR_TUE, ELM_DAYSELECTOR_WED, ELM_DAYSELECTOR_THU, ELM_DAYSELECTOR_FRI, ELM_DAYSELECTOR_SAT, ELM_DAYSELECTOR_MAX, ELM_DAYSELECTOR_SUN = 0, ELM_DAYSELECTOR_MON, ELM_DAYSELECTOR_TUE, ELM_DAYSELECTOR_WED, ELM_DAYSELECTOR_THU, ELM_DAYSELECTOR_FRI, ELM_DAYSELECTOR_SAT, ELM_DAYSELECTOR_MAX }
Identifies the day of the week.

  Functions
EOAPI void elm_obj_dayselector_week_start_set (Eo *obj, Elm_Dayselector_Day day)
Set the starting day of Dayselector.
EOAPI Elm_Dayselector_Day elm_obj_dayselector_week_start_get (const Eo *obj)
Get the starting day of Dayselector.
EOAPI void elm_obj_dayselector_weekend_length_set (Eo *obj, unsigned int length)
Set the weekend length of Dayselector.
EOAPI unsigned int elm_obj_dayselector_weekend_length_get (const Eo *obj)
Get the weekend length of Dayselector.
EOAPI void elm_obj_dayselector_weekend_start_set (Eo *obj, Elm_Dayselector_Day day)
Set the weekend starting day of Dayselector.
EOAPI Elm_Dayselector_Day elm_obj_dayselector_weekend_start_get (const Eo *obj)
Get the weekend starting day of Dayselector.
EOAPI void elm_obj_dayselector_weekdays_names_set (Eo *obj, const char **weekdays)
Set weekdays names to be displayed by the Dayselector.
EOAPI Eina_List * elm_obj_dayselector_weekdays_names_get (const Eo *obj)
Get weekdays names displayed by the calendar.
EOAPI void elm_obj_dayselector_day_selected_set (Eo *obj, Elm_Dayselector_Day day, Eina_Bool selected)
Set the state of given Dayselector_Day.
EOAPI Eina_Bool elm_obj_dayselector_day_selected_get (const Eo *obj, Elm_Dayselector_Day day)
Get the state of given Dayselector_Day.
Evas_Object * elm_dayselector_add (Evas_Object *parent)
Add the dayselector.

Detailed Description

Dayselector widget:

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 elm_dayselector_week_start_set() API.

APIs are provided for setting the duration of weekend elm_dayselector_weekend_start_set() and elm_dayselector_weekend_length_set() 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.

Supported elm_object_item common APIs.

•   elm_object_part_text_set,
•   elm_object_part_text_get,
•   elm_object_part_content_set,
•   elm_object_part_content_get,
•   elm_object_part_content_unset
•
Application can change individual day display string by using the API elm_object_part_text_set().
elm_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 inherits from the Layout one, so that all the functions acting on it also work for dayselector objects.
This widget emits the following signals, besides the ones sent from Layout :
•   'dayselector,changed' - when the user changes the state of a day.
•   'language,changed' - the program's language changed
Available styles for dayselector are:
•   default
This example shows the usage of the widget.
•   Dayselector widget example

Enumeration Type Documentation

  enum Elm_Dayselector_Day
Identifies the day of the week. API can call the selection/unselection of day with this as a parameter.
See also elm_obj_dayselector_day_selected_set, elm_obj_dayselector_day_selected_get.
Enumerator
ELM_DAYSELECTOR_SUN
    Indicates Sunday.
ELM_DAYSELECTOR_MON
    Indicates Monday.
ELM_DAYSELECTOR_TUE
    Indicates Tuesday.
ELM_DAYSELECTOR_WED
    Indicates Wednesday.
ELM_DAYSELECTOR_THU
    Indicates Thursday.
ELM_DAYSELECTOR_FRI
    Indicates Friday.
ELM_DAYSELECTOR_SAT
    Indicates Saturday.
ELM_DAYSELECTOR_MAX
    Sentinel value to indicate last enum field during iteration.
ELM_DAYSELECTOR_SUN
    Indicates Sunday.
ELM_DAYSELECTOR_MON
    Indicates Monday.
ELM_DAYSELECTOR_TUE
    Indicates Tuesday.
ELM_DAYSELECTOR_WED
    Indicates Wednesday.
ELM_DAYSELECTOR_THU
    Indicates Thursday.
ELM_DAYSELECTOR_FRI
    Indicates Friday.
ELM_DAYSELECTOR_SAT
    Indicates Saturday.
ELM_DAYSELECTOR_MAX
    Sentinel value to indicate last enum field during iteration.
Examples
dayselector_example.c.

  enum Elm_Dayselector_Day
Identifies the day of the week. API can call the selection/unselection of day with this as a parameter.
See also elm_dayselector_day_selected_set, elm_dayselector_day_selected_get.
Enumerator
ELM_DAYSELECTOR_SUN
    Indicates Sunday.
ELM_DAYSELECTOR_MON
    Indicates Monday.
ELM_DAYSELECTOR_TUE
    Indicates Tuesday.
ELM_DAYSELECTOR_WED
    Indicates Wednesday.
ELM_DAYSELECTOR_THU
    Indicates Thursday.
ELM_DAYSELECTOR_FRI
    Indicates Friday.
ELM_DAYSELECTOR_SAT
    Indicates Saturday.
ELM_DAYSELECTOR_MAX
    Sentinel value to indicate last enum field during iteration.
ELM_DAYSELECTOR_SUN
    Indicates Sunday.
ELM_DAYSELECTOR_MON
    Indicates Monday.
ELM_DAYSELECTOR_TUE
    Indicates Tuesday.
ELM_DAYSELECTOR_WED
    Indicates Wednesday.
ELM_DAYSELECTOR_THU
    Indicates Thursday.
ELM_DAYSELECTOR_FRI
    Indicates Friday.
ELM_DAYSELECTOR_SAT
    Indicates Saturday.
ELM_DAYSELECTOR_MAX
    Sentinel value to indicate last enum field during iteration.

Function Documentation

  EOAPI void elm_obj_dayselector_week_start_set (Eo * obj, Elm_Dayselector_Day day)
Set the starting day of Dayselector. See also Elm_Dayselector_Day, elm_obj_dayselector_week_start_get.
Parameters
    obj The object.
    day Dayselector_Day the first day that the user wants to display.

  EOAPI Elm_Dayselector_Day elm_obj_dayselector_week_start_get (const Eo * obj)
Get the starting day of Dayselector. See also Elm_Dayselector_Day, elm_obj_dayselector_week_start_set.
Parameters
    obj The object.
Returns
    Dayselector_Day the first day that the user wants to display.

  EOAPI void elm_obj_dayselector_weekend_length_set (Eo * obj, unsigned int length)
Set the weekend length of Dayselector. See also elm_obj_dayselector_weekend_length_get.
Parameters
    obj The object.
    length Weekend length, number of days as an integer.

  EOAPI unsigned int elm_obj_dayselector_weekend_length_get (const Eo * obj)
Get the weekend length of Dayselector. See also Elm_Dayselector_Day, elm_obj_dayselector_weekend_length_set.
Parameters
    obj The object.
Returns
    Weekend length, number of days as an integer.

  EOAPI void elm_obj_dayselector_weekend_start_set (Eo * obj, Elm_Dayselector_Day day)
Set the weekend starting day of Dayselector. See also Elm_Dayselector_Day, elm_obj_dayselector_weekend_start_get.
Parameters
    obj The object.
    day Dayselector_Day the first day from where weekend starts.

  EOAPI Elm_Dayselector_Day elm_obj_dayselector_weekend_start_get (const Eo * obj)
Get the weekend starting day of Dayselector. See also Elm_Dayselector_Day, elm_obj_dayselector_weekend_start_set.
Parameters
    obj The object.
Returns
    Dayselector_Day the first day from where weekend starts.

  EOAPI void elm_obj_dayselector_weekdays_names_set (Eo * obj, const char ** weekdays)
Set weekdays names to be displayed by the Dayselector. By default or if weekdays is null, 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...
See also elm_obj_dayselector_weekdays_names_get, elm_obj_dayselector_weekend_start_set.
Parameters
    obj The object.
    weekdays Array of seven strings to be used as weekday names. Warning: It must have 7 elements, or it will access invalid memory. Warning: The strings must be NULL terminated ('\0').
Since
    1.8

  EOAPI Eina_List* elm_obj_dayselector_weekdays_names_get (const Eo * obj)
Get weekdays names displayed by the calendar. By default, weekdays abbreviations get from system are displayed: E.g. for an en_US locale: 'Sun, Mon, Tue, Wed, Thu, Fri, Sat' The first string is related to Sunday, the second to Monday...
See also elm_obj_dayselector_weekdays_names_set.
Parameters
    obj The object.
Returns
    A list of seven strings to be used as weekday names.
Since
    1.8

  EOAPI void elm_obj_dayselector_day_selected_set (Eo * obj, Elm_Dayselector_Day day, Eina_Bool selected)
Set the state of given Dayselector_Day. See also Elm_Dayselector_Day, elm_obj_dayselector_day_selected_get.
Parameters
    obj The object.
    day Dayselector_Day that the user want to set state.
    selected State of the day. true is selected.

  EOAPI Eina_Bool elm_obj_dayselector_day_selected_get (const Eo * obj, Elm_Dayselector_Day day)
Get the state of given Dayselector_Day. See also Elm_Dayselector_Day, elm_obj_dayselector_day_selected_set.
Parameters
    obj The object.
    day Dayselector_Day that the user want to know state.
Returns
    true on success, false on failure

  Evas_Object* elm_dayselector_add (Evas_Object * parent)
Add the dayselector.
Parameters
    parent Parent object
Returns
    New dayselector object or NULL, if it cannot be created
References EINA_SAFETY_ON_NULL_RETURN_VAL.

Author
Generated automatically by Doxygen for EFL from the source code.