Typedefs | |
typedef struct _Elm_Calendar_Mark | Elm_Calendar_Mark |
Item handle for a calendar mark. More... | |
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. More... | |
Enumerations | |
enum | Elm_Calendar_Weekday { ELM_DAY_SUNDAY = 0, ELM_DAY_MONDAY, ELM_DAY_TUESDAY, ELM_DAY_WEDNESDAY, ELM_DAY_THURSDAY, ELM_DAY_FRIDAY, ELM_DAY_SATURDAY, ELM_DAY_LAST } |
A weekday. More... | |
enum | Elm_Calendar_Selectable { ELM_CALENDAR_SELECTABLE_NONE = 0, ELM_CALENDAR_SELECTABLE_YEAR = 1, ELM_CALENDAR_SELECTABLE_MONTH = 2, ELM_CALENDAR_SELECTABLE_DAY = 4 } |
A bitmask used to define which fields of a tm struct will be taken into account, when elm_calendar_selected_time_set() is invoked. More... | |
Functions | |
void | elm_calendar_first_day_of_week_set (Elm_Calendar *obj, Elm_Calendar_Weekday day) |
The first day of week to use on calendar widgets'. More... | |
Elm_Calendar_Weekday | elm_calendar_first_day_of_week_get (const Elm_Calendar *obj) |
The first day of week to use on calendar widgets'. More... | |
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. More... | |
Elm_Calendar_Selectable | elm_calendar_selectable_get (const Elm_Calendar *obj) |
Define which fields of a tm struct will be taken into account, when Elm.Calendar.selected_time.set is invoked. More... | |
void | elm_calendar_interval_set (Elm_Calendar *obj, double interval) |
The interval on time updates for an user mouse button hold on calendar widgets' month/year selection. More... | |
double | elm_calendar_interval_get (const Elm_Calendar *obj) |
The interval on time updates for an user mouse button hold on calendar widgets' month/year selection. More... | |
void | elm_calendar_weekdays_names_set (Elm_Calendar *obj, const char **weekdays) |
Weekdays names to be displayed by the calendar. More... | |
const char ** | elm_calendar_weekdays_names_get (const Elm_Calendar *obj) |
Weekdays names to be displayed by the calendar. More... | |
void | elm_calendar_select_mode_set (Elm_Calendar *obj, Elm_Calendar_Select_Mode mode) |
Select day mode to use. More... | |
Elm_Calendar_Select_Mode | elm_calendar_select_mode_get (const Elm_Calendar *obj) |
Select day mode to use. More... | |
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;. More... | |
const Eina_List * | elm_calendar_marks_get (const Elm_Calendar *obj) |
Get a list of all the calendar marks. More... | |
void | elm_calendar_date_min_set (Elm_Calendar *obj, const Efl_Time *min) |
Minimum date on calendar. More... | |
const Efl_Time * | elm_calendar_date_min_get (const Elm_Calendar *obj) |
Minimum date on calendar. More... | |
void | elm_calendar_date_max_set (Elm_Calendar *obj, const Efl_Time *max) |
Maximum date on calendar. More... | |
const Efl_Time * | elm_calendar_date_max_get (const Elm_Calendar *obj) |
Maximum date on calendar. More... | |
void | elm_calendar_selected_time_set (Elm_Calendar *obj, Efl_Time *selected_time) |
Set selected date to be highlighted on calendar. More... | |
Eina_Bool | elm_calendar_selected_time_get (const Elm_Calendar *obj, Efl_Time *selected_time) |
Get selected date. More... | |
Elm_Calendar_Mark * | elm_calendar_mark_add (Elm_Calendar *obj, const char *mark_type, Efl_Time *mark_time, Elm_Calendar_Mark_Repeat_Type repeat) |
Add a new mark to the calendar. More... | |
void | elm_calendar_marks_clear (Elm_Calendar *obj) |
Remove all calendar's marks. More... | |
void | elm_calendar_marks_draw (Elm_Calendar *obj) |
Draw calendar marks. More... | |
Eina_Bool | elm_calendar_displayed_time_get (const Elm_Calendar *obj, Efl_Time *displayed_time) |
Get the current time displayed in the widget. More... | |
Evas_Object * | elm_calendar_add (Evas_Object *parent) |
Add a new calendar widget to the given parent Elementary (container) object. More... | |
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:
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 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.
Here is some sample code using it:
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:
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 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.
Here is some sample code using it:
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.
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.
stime | Struct representing time. |
enum Elm_Calendar_Weekday |
A weekday.
See also elm_calendar_first_day_of_week_set.
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.
void elm_calendar_first_day_of_week_set | ( | Elm_Calendar * | obj, |
Elm_Calendar_Weekday | day | ||
) |
The first day of week to use on calendar widgets'.
[in] | obj | The object. |
[in] | day | Weekday enum value, see Elm_Calendar_Weekday |
Elm_Calendar_Weekday elm_calendar_first_day_of_week_get | ( | const Elm_Calendar * | obj | ) |
The first day of week to use on calendar widgets'.
[in] | obj | The object. |
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.
[in] | obj | The object. |
[in] | selectable | A bitmask of Elm_Calendar_Selectable |
Elm_Calendar_Selectable elm_calendar_selectable_get | ( | const Elm_Calendar * | obj | ) |
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.
[in] | obj | The object. |
void elm_calendar_interval_set | ( | Elm_Calendar * | obj, |
double | interval | ||
) |
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.
[in] | obj | The object. |
[in] | interval | The (first) interval value in seconds |
double elm_calendar_interval_get | ( | const Elm_Calendar * | obj | ) |
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.
[in] | obj | The object. |
void elm_calendar_weekdays_names_set | ( | Elm_Calendar * | obj, |
const char ** | weekdays | ||
) |
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.
calendar_example_02. calendar_example_05.
[in] | obj | The object. |
[in] | 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'). |
const char** elm_calendar_weekdays_names_get | ( | const Elm_Calendar * | obj | ) |
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.
calendar_example_02. calendar_example_05.
[in] | obj | The object. |
null
terminated ('\0'). void elm_calendar_select_mode_set | ( | Elm_Calendar * | obj, |
Elm_Calendar_Select_Mode | mode | ||
) |
Select day mode to use.
The day selection mode used.
[in] | obj | The object. |
[in] | mode | The select mode to use. |
Elm_Calendar_Select_Mode elm_calendar_select_mode_get | ( | const Elm_Calendar * | obj | ) |
Select day mode to use.
The day selection mode used.
[in] | obj | The object. |
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.
calendar_example_02.
[in] | obj | The object. |
[in] | format_function | Function to set the month-year string given the selected date. |
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.
[in] | obj | The object. |
void elm_calendar_date_min_set | ( | Elm_Calendar * | obj, |
const Efl_Time * | min | ||
) |
Minimum date on calendar.
See also elm_calendar_date_max_set, elm_calendar_date_max_get
Set minimum date on calendar.
Set the minimum date, changing the displayed month or year if needed. Displayed day also to be disabled if it is smaller than minimum date.
[in] | obj | The object. |
[in] | min | A tm struct to point to minimum date. |
const Efl_Time* elm_calendar_date_min_get | ( | const Elm_Calendar * | obj | ) |
Minimum date on calendar.
See also elm_calendar_date_max_set, elm_calendar_date_max_get
Get minimum date.
Default value is 1 JAN,1902.
[in] | obj | The object. |
void elm_calendar_date_max_set | ( | Elm_Calendar * | obj, |
const Efl_Time * | max | ||
) |
Maximum date on calendar.
See also elm_calendar_date_min_set, elm_calendar_date_min_get
Set maximum date on calendar.
Set the maximum date, changing the displayed month or year if needed. Displayed day also to be disabled if it is bigger than maximum date.
[in] | obj | The object. |
[in] | max | A tm struct to point to maximum date. |
const Efl_Time* elm_calendar_date_max_get | ( | const Elm_Calendar * | obj | ) |
Maximum date on calendar.
See also elm_calendar_date_min_set, elm_calendar_date_min_get
Get maximum date.
Default maximum year is -1. Default maximum day and month are 31 and DEC.
If the maximum year is a negative value, it will be limited depending on the platform architecture (year 2037 for 32 bits);
[in] | obj | The object. |
void elm_calendar_selected_time_set | ( | Elm_Calendar * | obj, |
Efl_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.
calendar_example_04
[in] | obj | The object. |
[in] | selected_time | A tm struct to represent the selected date. |
Eina_Bool elm_calendar_selected_time_get | ( | const Elm_Calendar * | obj, |
Efl_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.
calendar_example_05.
[in] | obj | The object. |
[in,out] | selected_time | A tm struct to point to selected date. |
true
if the method succeeded, false
otherwise Elm_Calendar_Mark* elm_calendar_mark_add | ( | Elm_Calendar * | obj, |
const char * | mark_type, | ||
Efl_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().
calendar_example_06
[in] | obj | The object. |
[in] | mark_type | A string used to define the type of mark. It will be emitted to the theme, that should display a related modification on these days representation. |
[in] | mark_time | A 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] | repeat | Repeat the event following this periodicity. Can be a unique mark (that don't repeat), daily, weekly, monthly or annually. |
void elm_calendar_marks_clear | ( | Elm_Calendar * | obj | ) |
Remove all calendar's marks.
See also elm_calendar_mark_add, Elm.Calendar.mark_del().
[in] | obj | The object. |
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.
calendar_example_06
[in] | obj | The object. |
Eina_Bool elm_calendar_displayed_time_get | ( | const Elm_Calendar * | obj, |
Efl_Time * | displayed_time | ||
) |
Get the current time displayed in the widget.
[in] | obj | The object. |
[in,out] | displayed_time | A tm struct to point to displayed date. |
true
if the method succeeded, false
otherwiseEvas_Object* elm_calendar_add | ( | Evas_Object * | parent | ) |
Add a new calendar widget to the given parent Elementary (container) object.
parent | The parent object. |
NULL
, on errors.This function inserts a new calendar widget on the canvas.
calendar_example_01