Tizen Native API  3.0

calendar_inheritance_tree.png

This is a calendar widget. It helps applications to flexibly display a calendar with day of the week, date, year and month. Applications are able to set specific dates to be reported back, when selected, in the smart callbacks of the calendar widget. The API of this widget lets the applications perform other functions, like:

  • placing marks on specific dates
  • setting the bounds for the calendar (minimum and maximum years)
  • setting the day names of the week (e.g. "Thu" or "Thursday")
  • setting the year and month format.

This widget inherits from the Layout one, so that all the functions acting on it also work for calendar objects.

This widget emits the following signals, besides the ones sent from Elm_Layout:

  • "changed" - emitted when the date in the calendar is changed.
  • "display,changed" - emitted when the current month displayed in the calendar is changed.
  • "focused" - When the calendar has received focus. (since 1.8)
  • "unfocused" - When the calendar has lost focus. (since 1.8)
  • "language,changed" - the program's language changed (since 1.9)

Supported elm_object common APIs.

Functions

void elm_calendar_first_day_of_week_set (Elm_Calendar *obj, Elm_Calendar_Weekday day)
 
Elm_Calendar_Weekday elm_calendar_first_day_of_week_get (const Elm_Calendar *obj)
 
void elm_calendar_selectable_set (Elm_Calendar *obj, Elm_Calendar_Selectable selectable)
 
Elm_Calendar_Selectable elm_calendar_selectable_get (const Elm_Calendar *obj)
 
void elm_calendar_interval_set (Elm_Calendar *obj, double interval)
 
double elm_calendar_interval_get (const Elm_Calendar *obj)
 
void elm_calendar_weekdays_names_set (Elm_Calendar *obj, const char **weekdays)
 
const char ** elm_calendar_weekdays_names_get (const Elm_Calendar *obj)
 
void elm_calendar_select_mode_set (Elm_Calendar *obj, Elm_Calendar_Select_Mode mode)
 
Elm_Calendar_Select_Mode elm_calendar_select_mode_get (const Elm_Calendar *obj)
 
void elm_calendar_min_max_year_set (Elm_Calendar *obj, int min, int max)
 
void elm_calendar_min_max_year_get (const Elm_Calendar *obj, int *min, int *max)
 
void elm_calendar_format_function_set (Elm_Calendar *obj, Elm_Calendar_Format_Cb format_function)
 
const Eina_Listelm_calendar_marks_get (const Elm_Calendar *obj)
 
void elm_calendar_selected_time_set (Elm_Calendar *obj, Elm_Calendar_Time *selected_time)
 
Eina_Bool elm_calendar_selected_time_get (const Elm_Calendar *obj, Elm_Calendar_Time *selected_time)
 
Elm_Calendar_Markelm_calendar_mark_add (Elm_Calendar *obj, const char *mark_type, Elm_Calendar_Time *mark_time, Elm_Calendar_Mark_Repeat_Type repeat)
 
void elm_calendar_marks_clear (Elm_Calendar *obj)
 
void elm_calendar_marks_draw (Elm_Calendar *obj)
 
Eina_Bool elm_calendar_displayed_time_get (const Elm_Calendar *obj, Elm_Calendar_Time *displayed_time)
 
void elm_calendar_mark_del (Elm_Calendar_Mark *mark)
Evas_Objectelm_calendar_add (Evas_Object *parent)

Typedefs

typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark
typedef char *(* Elm_Calendar_Format_Cb )(struct tm *stime)

Typedef Documentation

typedef char*(* Elm_Calendar_Format_Cb)(struct tm *stime)

This callback type is used to format the string that will be used to display month and year.

Parameters:
stimeStruct representing time.
Returns:
String representing time that will be set to calendar's text.
See also:
elm_calendar_format_function_set()
typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark

Item handle for a calendar mark. Created with elm_calendar_mark_add() and deleted with elm_calendar_mark_del().


Enumeration Type Documentation

A bitmask used to define which fields of a tm struct will be taken into account, when elm_calendar_selected_time_set() is invoked.

See also elm_calendar_selectable_set, elm_calendar_selected_time_set.

Since (EFL) :
1.8
Enumerator:
ELM_CALENDAR_SELECTABLE_NONE 

No description

ELM_CALENDAR_SELECTABLE_YEAR 

No description

ELM_CALENDAR_SELECTABLE_MONTH 

No description

ELM_CALENDAR_SELECTABLE_DAY 

No description

A weekday.

See also elm_calendar_first_day_of_week_set.

Enumerator:
ELM_DAY_SUNDAY 

No description

ELM_DAY_MONDAY 

No description

ELM_DAY_TUESDAY 

No description

ELM_DAY_WEDNESDAY 

No description

ELM_DAY_THURSDAY 

No description

ELM_DAY_FRIDAY 

No description

ELM_DAY_SATURDAY 

No description

ELM_DAY_LAST 

No description


Function Documentation

Add a new calendar widget to the given parent Elementary (container) object.

Parameters:
parentThe parent object.
Returns:
a new calendar widget handle or NULL, on errors.

This function inserts a new calendar widget on the canvas.

Since :
2.4
Eina_Bool elm_calendar_displayed_time_get ( const Elm_Calendar *  obj,
Elm_Calendar_Time *  displayed_time 
)

Get the current time displayed in the widget

Since :
2.4
Parameters:
[in,out]displayed_timeA tm struct to point to displayed date.
Since (EFL) :
1.8

Get the first day of week, who are used on calendar widgets'.

See also elm_calendar_first_day_of_week_set for more details.

Since :
2.4
Returns:
An int which correspond to the first day of the week (Sunday = 0, Monday = 1, ..., Saturday = 6).
void elm_calendar_first_day_of_week_set ( Elm_Calendar *  obj,
Elm_Calendar_Weekday  day 
)

Set the first day of week to use on calendar widgets'.

Since :
2.4
Parameters:
[in]dayAn int which correspond to the first day of the week (Sunday = 0, Monday = 1, ..., Saturday = 6).
void elm_calendar_format_function_set ( Elm_Calendar *  obj,
Elm_Calendar_Format_Cb  format_function 
)

Set a function to format the string that will be used to display month and year;

By default it uses strftime with "%B %Y" format string. It should allocate the memory that will be used by the string, that will be freed by the widget after usage. A pointer to the string and a pointer to the time struct will be provided.

Since :
2.4
Parameters:
[in]format_functionFunction to set the month-year string given the selected date.
double elm_calendar_interval_get ( const Elm_Calendar *  obj)

Get the interval on time updates for an user mouse button hold on calendar widgets' month/year selection.

See also elm_calendar_interval_set for more details.

Since :
2.4
Returns:
The (first) interval value in seconds
void elm_calendar_interval_set ( Elm_Calendar *  obj,
double  interval 
)

Set the interval on time updates for an user mouse button hold on calendar widgets' month/year selection.

This interval value is decreased while the user holds the mouse pointer either selecting next or previous month/year.

This helps the user to get to a given month distant from the current one easier/faster, as it will start to change quicker and quicker on mouse button holds.

The calculation for the next change interval value, starting from the one set with this call, is the previous interval divided by 1.05, so it decreases a little bit.

The default starting interval value for automatic changes is 0.85 seconds.

See also elm_calendar_interval_get.

Since :
2.4
Parameters:
[in]intervalThe (first) interval value in seconds
Elm_Calendar_Mark* elm_calendar_mark_add ( Elm_Calendar *  obj,
const char *  mark_type,
Elm_Calendar_Time *  mark_time,
Elm_Calendar_Mark_Repeat_Type  repeat 
)

Add a new mark to the calendar

Add a mark that will be drawn in the calendar respecting the insertion time and periodicity. It will emit the type as signal to the widget theme. Default theme supports "holiday" and "checked", but it can be extended.

It won't immediately update the calendar, drawing the marks. For this, elm_calendar_marks_draw(). However, when user selects next or previous month calendar forces marks drawn.

Marks created with this method can be deleted with elm_calendar_mark_del().

See also elm_calendar_marks_draw, elm_calendar_mark_del().

Since :
2.4
Parameters:
[in]mark_timeA time struct to represent the date of inclusion of the mark. For marks that repeats it will just be displayed after the inclusion date in the calendar.
[in]repeatRepeat the event following this periodicity. Can be a unique mark (that don't repeat), daily, weekly, monthly or annually.

Delete mark from the calendar.

Parameters:
markThe mark to be deleted.

If deleting all calendar marks is required, elm_calendar_marks_clear() should be used instead of getting marks list and deleting each one.

See also:
elm_calendar_mark_add()
Since :
2.4
void elm_calendar_marks_clear ( Elm_Calendar *  obj)

Remove all calendar's marks

See also elm_calendar_mark_add, elm_calendar_mark_del().

Since :
2.4
void elm_calendar_marks_draw ( Elm_Calendar *  obj)

Draw calendar marks.

Should be used after adding, removing or clearing marks. It will go through the entire marks list updating the calendar. If lots of marks will be added, add all the marks and then call this function.

When the month is changed, i.e. user selects next or previous month, marks will be drawn.

See also elm_calendar_mark_add, elm_calendar_mark_del(), elm_calendar_marks_clear.

Since :
2.4
const Eina_List* elm_calendar_marks_get ( const Elm_Calendar *  obj)

Get a list of all the calendar marks.

See also elm_calendar_mark_add, elm_calendar_mark_del(), elm_calendar_marks_clear.

Since :
2.4
void elm_calendar_min_max_year_get ( const Elm_Calendar *  obj,
int *  min,
int *  max 
)

Get the minimum and maximum values for the year

Default values are 1902 and -1.

See also elm_calendar_min_max_year_set for more details.

Calendar - Signal callback and getters..

Since :
2.4
Parameters:
[out]minThe minimum year, greater than 1901;
[out]maxThe maximum year;
void elm_calendar_min_max_year_set ( Elm_Calendar *  obj,
int  min,
int  max 
)

Set the minimum and maximum values for the year

Maximum must be greater than minimum, except if you don't want to set maximum year. Default values are 1902 and -1.

If the maximum year is a negative value, it will be limited depending on the platform architecture (year 2037 for 32 bits);

See also elm_calendar_min_max_year_get.

Calendar - Years restrictions..

Since :
2.4
Parameters:
[in]minThe minimum year, greater than 1901;
[in]maxThe maximum year;
Elm_Calendar_Select_Mode elm_calendar_select_mode_get ( const Elm_Calendar *  obj)

Get the select day mode used.

Get the day selection mode used.

See also elm_calendar_select_mode_set for more details.

Since :
2.4
Returns:
The select mode to use.
void elm_calendar_select_mode_set ( Elm_Calendar *  obj,
Elm_Calendar_Select_Mode  mode 
)

Set select day mode to use.

Set the day selection mode used.

Since :
2.4
Parameters:
[in]modeThe select mode to use.

Get how elm_calendar_selected_time_set manage a date

See also elm_calendar_selectable_set, elm_calendar_selected_time_set.

Since :
2.4
Returns:
A bitmask of Elm_Calendar_Selectable
Since (EFL) :
1.8
void elm_calendar_selectable_set ( Elm_Calendar *  obj,
Elm_Calendar_Selectable  selectable 
)

Define which fields of a tm struct will be taken into account, when Elm.Calendar.selected_time.set is invoked.

By Default the bitmask is set to use all fields of a tm struct (year, month and day of the month).

See also elm_calendar_selected_time_set.

Since :
2.4
Parameters:
[in]selectableA bitmask of Elm_Calendar_Selectable
Since (EFL) :
1.8
Eina_Bool elm_calendar_selected_time_get ( const Elm_Calendar *  obj,
Elm_Calendar_Time *  selected_time 
)

Get selected date.

Get date selected by the user or set by function elm_calendar_selected_time_set(). Selected date changes when the user goes to next/previous month or select a day pressing over it on calendar.

See also elm_calendar_selected_time_get.

Since :
2.4
Parameters:
[in,out]selected_timeA tm struct to point to selected date.
void elm_calendar_selected_time_set ( Elm_Calendar *  obj,
Elm_Calendar_Time *  selected_time 
)

Set selected date to be highlighted on calendar.

Set the selected date, changing the displayed month if needed. Selected date changes when the user goes to next/previous month or select a day pressing over it on calendar.

See also elm_calendar_selected_time_get.

Since :
2.4
Parameters:
[in]selected_timeA tm struct to represent the selected date.
const char** elm_calendar_weekdays_names_get ( const Elm_Calendar *  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_calendar_weekdays_names_set.

Since :
2.4
Returns:
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').
void elm_calendar_weekdays_names_set ( Elm_Calendar *  obj,
const char **  weekdays 
)

Set weekdays names to be 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 should be related to Sunday, the second to Monday...

See also elm_calendar_weekdays_names_get.

Since :
2.4
Parameters:
[in]weekdaysArray 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').