Dayselector widget: More...

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 }
	Identifies the day of the week. More...

Functions
EOAPI void	elm_obj_dayselector_week_start_set (Elm_Dayselector_Day day)
	Set the starting day of Dayselector. More...

EOAPI Elm_Dayselector_Day	elm_obj_dayselector_week_start_get (void)
	Get the starting day of Dayselector. More...

EOAPI void	elm_obj_dayselector_weekend_length_set (unsigned int length)
	Set the weekend length of Dayselector. More...

EOAPI unsigned int	elm_obj_dayselector_weekend_length_get (void)
	Get the weekend length of Dayselector. More...

EOAPI void	elm_obj_dayselector_weekend_start_set (Elm_Dayselector_Day day)
	Set the weekend starting day of Dayselector. More...

EOAPI Elm_Dayselector_Day	elm_obj_dayselector_weekend_start_get (void)
	Get the weekend starting day of Dayselector. More...

EOAPI void	elm_obj_dayselector_weekdays_names_set (const char **weekdays)
	Set weekdays names to be displayed by the Dayselector. More...

EOAPI Eina_List *	elm_obj_dayselector_weekdays_names_get (void)
	Get weekdays names displayed by the calendar. More...

EOAPI void	elm_obj_dayselector_day_selected_set (Elm_Dayselector_Day day, Eina_Bool selected)
	Set the state of given Dayselector_Day. More...

EOAPI Eina_Bool	elm_obj_dayselector_day_selected_get (Elm_Dayselector_Day day)
	Get the state of given Dayselector_Day. More...

void	elm_dayselector_week_start_set (Elm_Dayselector *obj, Elm_Dayselector_Day day)
	Set the starting day of Dayselector. More...

Elm_Dayselector_Day	elm_dayselector_week_start_get (const Elm_Dayselector *obj)
	Get the starting day of Dayselector. More...

void	elm_dayselector_weekend_length_set (Elm_Dayselector *obj, unsigned int length)
	Set the weekend length of Dayselector. More...

unsigned int	elm_dayselector_weekend_length_get (const Elm_Dayselector *obj)
	Get the weekend length of Dayselector. More...

void	elm_dayselector_weekend_start_set (Elm_Dayselector *obj, Elm_Dayselector_Day day)
	Set the weekend starting day of Dayselector. More...

Elm_Dayselector_Day	elm_dayselector_weekend_start_get (const Elm_Dayselector *obj)
	Get the weekend starting day of Dayselector. More...

void	elm_dayselector_weekdays_names_set (Elm_Dayselector obj, const char *weekdays)
	Set weekdays names to be displayed by the Dayselector. More...

Eina_List *	elm_dayselector_weekdays_names_get (const Elm_Dayselector *obj)
	Get weekdays names displayed by the calendar. More...

void	elm_dayselector_day_selected_set (Elm_Dayselector *obj, Elm_Dayselector_Day day, Eina_Bool selected)
	Set the state of given Dayselector_Day. More...

Eina_Bool	elm_dayselector_day_selected_get (const Elm_Dayselector *obj, Elm_Dayselector_Day day)
	Get the state of given Dayselector_Day. More...

Evas_Object *	elm_dayselector_add (Evas_Object *parent)
	Add the dayselector. More...

Detailed Description

Dayselector widget:

"elm_dayselector" is a day selection widget. It 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 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.

"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 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_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, don't use.

Examples:: dayselector_example.c.

Function Documentation

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

Eina_Bool elm_dayselector_day_selected_get	(	const Elm_Dayselector *	obj,
		Elm_Dayselector_Day	day
	)

Get the state of given Dayselector_Day.

Returns: EINA_TRUE, if the Day is selected

See also: Elm_Dayselector_Day; elm_dayselector_day_selected_set()

Parameters

[in] day Dayselector_Day that the user want to know state.

References elm_obj_dayselector_day_selected_get().

void elm_dayselector_day_selected_set	(	Elm_Dayselector *	obj,
		Elm_Dayselector_Day	day,
		Eina_Bool	selected
	)

Set the state of given Dayselector_Day.

See also: Elm_Dayselector_Day; elm_dayselector_day_selected_get()

Parameters

[in]	day	Dayselector_Day that the user want to set state.
[in]	selected	state of the day. `EINA_TRUE` is selected.

References elm_obj_dayselector_day_selected_set().

Elm_Dayselector_Day elm_dayselector_week_start_get ( const Elm_Dayselector * obj )

Get the starting day of Dayselector.

Returns: Day from where Dayselector displays all the weekdays in order.

See also: Elm_Dayselector_Day; elm_dayselector_week_start_set()

References elm_obj_dayselector_week_start_get().

void elm_dayselector_week_start_set	(	Elm_Dayselector *	obj,
		Elm_Dayselector_Day	day
	)

Set the starting day of Dayselector.

See also: Elm_Dayselector_Day; elm_dayselector_week_start_get()

Parameters

[in] day Dayselector_Day the first day that the user wants to display.

References elm_obj_dayselector_week_start_set().

Eina_List* elm_dayselector_weekdays_names_get ( const Elm_Dayselector * obj )

Get weekdays names displayed by the calendar.

Returns: A list of seven strings to be used as weekday names.

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_dayselector_weekdays_name_set()

Since: 1.8

References elm_obj_dayselector_weekdays_names_get().

void elm_dayselector_weekdays_names_set	(	Elm_Dayselector *	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...

The usage should be like this:

 const char *weekdays[] =
 {
 "Sunday", "Monday", "Tuesday", "Wednesday",
 "Thursday", "Friday", "Saturday"
 };
 elm_dayselector_wekdays_names_set(calendar, weekdays);

See also: elm_dayselector_weekdays_name_get(); elm_dayselector_weekend_start_set()

Since: 1.8

Parameters

[in] weekdays Array of seven strings to be used as weekday names.

Warning: It must have 7 elements, or it will access invalid memory.; The strings must be NULL terminated ('\0').

References elm_obj_dayselector_weekdays_names_set().

unsigned int elm_dayselector_weekend_length_get ( const Elm_Dayselector * obj )

Get the weekend length of Dayselector.

Returns: Number of days marked as a weekend.

See also: Elm_Dayselector_Day; elm_dayselector_weekend_length_set()

References elm_obj_dayselector_weekend_length_get().

void elm_dayselector_weekend_length_set	(	Elm_Dayselector *	obj,
		unsigned int	length
	)

Set the weekend length of Dayselector.

See also: elm_dayselector_weekend_length_get()

Parameters

[in] length Weekend length, number of days as an integer.

References elm_obj_dayselector_weekend_length_set().

Elm_Dayselector_Day elm_dayselector_weekend_start_get ( const Elm_Dayselector * obj )

Get the weekend starting day of Dayselector.

Returns: Elm_Dayselector_Day Day from where weekend starts.

See also: Elm_Dayselector_Day; elm_dayselector_weekend_start_set()

References elm_obj_dayselector_weekend_start_get().

void elm_dayselector_weekend_start_set	(	Elm_Dayselector *	obj,
		Elm_Dayselector_Day	day
	)

Set the weekend starting day of Dayselector.

See also: Elm_Dayselector_Day; elm_dayselector_weekend_start_get()

Parameters

[in] day Dayselector_Day the first day from where weekend starts.

References elm_obj_dayselector_weekend_start_set().

EOAPI Eina_Bool elm_obj_dayselector_day_selected_get ( Elm_Dayselector_Day day )

Get the state of given Dayselector_Day.

Returns: EINA_TRUE, if the Day is selected

See also: Elm_Dayselector_Day; elm_dayselector_day_selected_set()

Parameters

[in] day Dayselector_Day that the user want to know state.

Referenced by elm_dayselector_day_selected_get().

EOAPI void elm_obj_dayselector_day_selected_set	(	Elm_Dayselector_Day	day,
		Eina_Bool	selected
	)

Set the state of given Dayselector_Day.

See also: Elm_Dayselector_Day; elm_dayselector_day_selected_get()

Parameters

[in]	day	Dayselector_Day that the user want to set state.
[in]	selected	state of the day. `EINA_TRUE` is selected.

Referenced by elm_dayselector_day_selected_set().

EOAPI Elm_Dayselector_Day elm_obj_dayselector_week_start_get ( void )

Get the starting day of Dayselector.

Returns: Day from where Dayselector displays all the weekdays in order.

See also: Elm_Dayselector_Day; elm_dayselector_week_start_set()

Referenced by elm_dayselector_week_start_get().

EOAPI void elm_obj_dayselector_week_start_set ( Elm_Dayselector_Day day )

Set the starting day of Dayselector.

See also: Elm_Dayselector_Day; elm_dayselector_week_start_get()

Parameters

[in] day Dayselector_Day the first day that the user wants to display.

Referenced by elm_dayselector_week_start_set().

EOAPI Eina_List* elm_obj_dayselector_weekdays_names_get ( void )

Get weekdays names displayed by the calendar.

Returns: A list of seven strings to be used as weekday names.

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_dayselector_weekdays_name_set()

Since: 1.8

Referenced by elm_dayselector_weekdays_names_get().

EOAPI void elm_obj_dayselector_weekdays_names_set ( 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...

The usage should be like this:

 const char *weekdays[] =
 {
 "Sunday", "Monday", "Tuesday", "Wednesday",
 "Thursday", "Friday", "Saturday"
 };
 elm_dayselector_wekdays_names_set(calendar, weekdays);