2014-07-25 01:33:19 -07:00
|
|
|
class Elm_Calendar (Elm_Layout, Elm_Interface_Atspi_Widget_Action)
|
2014-03-20 00:44:34 -07:00
|
|
|
{
|
|
|
|
eo_prefix: elm_obj_calendar;
|
|
|
|
properties {
|
|
|
|
first_day_of_week {
|
|
|
|
set {
|
|
|
|
/*@
|
|
|
|
Set the first day of week to use on calendar widgets'.
|
|
|
|
|
|
|
|
@ingroup Calendar */
|
|
|
|
}
|
|
|
|
get {
|
|
|
|
/*@
|
|
|
|
Get the first day of week, who are used on calendar widgets'.
|
|
|
|
|
|
|
|
@return An int which correspond to the first day of the week (Sunday = 0, Monday = 1,
|
|
|
|
..., Saturday = 6)
|
|
|
|
|
|
|
|
@see elm_calendar_first_day_of_week_set() for more details
|
|
|
|
|
|
|
|
@ingroup Calendar */
|
|
|
|
}
|
|
|
|
values {
|
|
|
|
Elm_Calendar_Weekday day; /*@ An int which correspond to the first day of the week (Sunday = 0, Monday = 1,
|
|
|
|
..., Saturday = 6) */
|
|
|
|
}
|
|
|
|
}
|
|
|
|
selectable {
|
|
|
|
set {
|
|
|
|
/*@
|
|
|
|
Define which fields of a @b 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 @b tm struct (year,
|
|
|
|
month and day of the month).
|
|
|
|
|
|
|
|
@ingroup Calendar
|
|
|
|
@see elm_calendar_selected_time_set
|
|
|
|
@since 1.8 */
|
|
|
|
}
|
|
|
|
get {
|
|
|
|
/*@
|
|
|
|
Get how elm_calendar_selected_time_set manage a date
|
|
|
|
|
|
|
|
@return The flag used to manage a date with a elm_calendar_selected_time_set
|
|
|
|
|
|
|
|
@ingroup Calendar
|
|
|
|
@see elm_calendar_selectable_set
|
|
|
|
@see elm_calendar_selected_time_set
|
|
|
|
@since 1.8 */
|
|
|
|
}
|
|
|
|
values {
|
|
|
|
Elm_Calendar_Selectable selectable; /*@ A bitmask of Elm_Calendar_Selectable */
|
|
|
|
}
|
|
|
|
}
|
|
|
|
interval {
|
|
|
|
set {
|
|
|
|
/*@
|
|
|
|
Set the interval on time updates for an user mouse button hold
|
|
|
|
on calendar widgets' month/year selection.
|
|
|
|
|
|
|
|
This interval value is @b 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
|
|
|
|
@b 0.85 seconds.
|
|
|
|
|
|
|
|
@see elm_calendar_interval_get()
|
|
|
|
|
|
|
|
@ingroup Calendar */
|
|
|
|
}
|
|
|
|
get {
|
|
|
|
/*@
|
|
|
|
Get the interval on time updates for an user mouse button hold
|
|
|
|
on calendar widgets' month/year selection.
|
|
|
|
|
|
|
|
@return The (first) interval value, in seconds, set on it
|
|
|
|
|
|
|
|
@see elm_calendar_interval_set() for more details
|
|
|
|
|
|
|
|
@ingroup Calendar */
|
|
|
|
}
|
|
|
|
values {
|
|
|
|
double interval; /*@ The (first) interval value in seconds */
|
|
|
|
}
|
|
|
|
}
|
|
|
|
weekdays_names {
|
|
|
|
set {
|
|
|
|
/*@
|
|
|
|
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...
|
|
|
|
|
|
|
|
The usage should be like this:
|
|
|
|
@code
|
|
|
|
const char *weekdays[] =
|
|
|
|
{
|
|
|
|
"Sunday", "Monday", "Tuesday", "Wednesday",
|
|
|
|
"Thursday", "Friday", "Saturday"
|
|
|
|
};
|
|
|
|
elm_calendar_weekdays_names_set(calendar, weekdays);
|
|
|
|
@endcode
|
|
|
|
|
|
|
|
@see elm_calendar_weekdays_name_get()
|
|
|
|
|
|
|
|
@ref calendar_example_02
|
|
|
|
|
|
|
|
@ingroup Calendar */
|
|
|
|
}
|
|
|
|
get {
|
|
|
|
/*@
|
|
|
|
Get weekdays names displayed by the calendar.
|
|
|
|
|
|
|
|
@return Array 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 elm_calendar_weekdays_name_set()
|
|
|
|
|
|
|
|
@ref calendar_example_05
|
|
|
|
|
|
|
|
@ingroup Calendar */
|
|
|
|
}
|
|
|
|
values {
|
2014-06-26 05:24:20 -07:00
|
|
|
const(char)** weekdays; /*@ Array of seven strings to be used as weekday names.
|
2014-03-20 00:44:34 -07:00
|
|
|
@warning It must have 7 elements, or it will access invalid memory.
|
|
|
|
@warning The strings must be NULL terminated ('@\0'). */
|
|
|
|
}
|
|
|
|
}
|
|
|
|
select_mode {
|
|
|
|
set {
|
|
|
|
/*@
|
|
|
|
Set select day mode to use.
|
|
|
|
|
|
|
|
Set the day selection mode used.
|
|
|
|
|
|
|
|
@ingroup Calendar */
|
|
|
|
}
|
|
|
|
get {
|
|
|
|
/*@
|
|
|
|
Get the select day mode used.
|
|
|
|
|
|
|
|
@return the selected mode
|
|
|
|
|
|
|
|
Get the day selection mode used.
|
|
|
|
|
|
|
|
@see elm_calendar_select_mode_set() for more details
|
|
|
|
|
|
|
|
@ingroup Calendar */
|
|
|
|
}
|
|
|
|
values {
|
|
|
|
Elm_Calendar_Select_Mode mode; /*@ The select mode to use. */
|
|
|
|
}
|
|
|
|
}
|
|
|
|
min_max_year {
|
|
|
|
set {
|
|
|
|
/*@
|
|
|
|
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 elm_calendar_min_max_year_get()
|
|
|
|
|
|
|
|
@ref calendar_example_03
|
|
|
|
|
|
|
|
@ingroup Calendar */
|
|
|
|
}
|
|
|
|
get {
|
|
|
|
/*@
|
|
|
|
Get the minimum and maximum values for the year
|
|
|
|
|
|
|
|
Default values are 1902 and -1.
|
|
|
|
|
|
|
|
@see elm_calendar_min_max_year_set() for more details.
|
|
|
|
|
|
|
|
@ref calendar_example_05
|
|
|
|
|
|
|
|
@ingroup Calendar */
|
|
|
|
}
|
|
|
|
values {
|
|
|
|
int min; /*@ The minimum year, greater than 1901; */
|
|
|
|
int max; /*@ The maximum year; */
|
|
|
|
}
|
|
|
|
}
|
|
|
|
format_function {
|
|
|
|
set {
|
|
|
|
/*@
|
|
|
|
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.
|
|
|
|
|
|
|
|
Example:
|
|
|
|
@code
|
|
|
|
static char
|
|
|
|
_format_month_year(struct tm *selected_time)
|
|
|
|
{
|
|
|
|
char buf[32];
|
|
|
|
if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
|
|
|
|
return strdup(buf);
|
|
|
|
}
|
|
|
|
|
|
|
|
elm_calendar_format_function_set(calendar, _format_month_year);
|
|
|
|
@endcode
|
|
|
|
|
|
|
|
@ref calendar_example_02
|
|
|
|
|
|
|
|
@ingroup Calendar */
|
|
|
|
}
|
|
|
|
values {
|
|
|
|
Elm_Calendar_Format_Cb format_function; /*@ Function to set the month-year string given
|
|
|
|
the selected date */
|
|
|
|
}
|
|
|
|
}
|
|
|
|
marks {
|
|
|
|
get {
|
|
|
|
/*@
|
|
|
|
Get a list of all the calendar marks.
|
|
|
|
|
|
|
|
@return An @c Eina_List of calendar marks objects, or @c NULL on failure.
|
|
|
|
|
|
|
|
@see elm_calendar_mark_add()
|
|
|
|
@see elm_calendar_mark_del()
|
|
|
|
@see elm_calendar_marks_clear()
|
|
|
|
|
|
|
|
@ingroup Calendar */
|
2014-08-11 07:46:11 -07:00
|
|
|
return: const(Eina_List)*;
|
2014-03-20 00:44:34 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
methods {
|
|
|
|
selected_time_set {
|
|
|
|
/*@
|
|
|
|
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 elm_calendar_selected_time_get()
|
|
|
|
|
|
|
|
@ref calendar_example_04
|
|
|
|
|
|
|
|
@ingroup Calendar */
|
|
|
|
|
|
|
|
params {
|
|
|
|
@in struct tm *selected_time; /*@ A @b tm struct to represent the selected date. */
|
|
|
|
}
|
|
|
|
}
|
2014-07-22 09:13:52 -07:00
|
|
|
selected_time_get @const {
|
2014-03-20 00:44:34 -07:00
|
|
|
/*@
|
|
|
|
Get selected date.
|
|
|
|
|
|
|
|
@return EINA_FALSE means an error occurred and returned time shouldn't
|
|
|
|
be considered.
|
|
|
|
|
|
|
|
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 elm_calendar_selected_time_get()
|
|
|
|
|
|
|
|
@ref calendar_example_05
|
|
|
|
|
|
|
|
@ingroup Calendar */
|
2014-08-11 07:46:11 -07:00
|
|
|
return: bool;
|
2014-03-20 00:44:34 -07:00
|
|
|
params {
|
2014-07-08 06:16:04 -07:00
|
|
|
@inout struct tm selected_time; /*@ A @b tm struct to point to selected date */
|
2014-03-20 00:44:34 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
mark_add {
|
|
|
|
/*@
|
|
|
|
Add a new mark to the calendar
|
|
|
|
|
|
|
|
@return The created mark or @p NULL upon failure.
|
|
|
|
|
|
|
|
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, call 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().
|
|
|
|
|
|
|
|
Example
|
|
|
|
@code
|
|
|
|
struct tm selected_time;
|
|
|
|
time_t current_time;
|
|
|
|
|
|
|
|
current_time = time(NULL) + 5 * (24 * 60 * 60);
|
|
|
|
localtime_r(¤t_time, &selected_time);
|
|
|
|
elm_calendar_mark_add(cal, "holiday", selected_time,
|
|
|
|
ELM_CALENDAR_ANNUALLY);
|
|
|
|
|
|
|
|
current_time = time(NULL) + 1 * (24 * 60 * 60);
|
|
|
|
localtime_r(¤t_time, &selected_time);
|
|
|
|
elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
|
|
|
|
|
|
|
|
elm_calendar_marks_draw(cal);
|
|
|
|
@endcode
|
|
|
|
|
|
|
|
@see elm_calendar_marks_draw()
|
|
|
|
@see elm_calendar_mark_del()
|
|
|
|
|
|
|
|
@ref calendar_example_06
|
|
|
|
|
|
|
|
@ingroup Calendar */
|
|
|
|
|
2014-08-11 07:46:11 -07:00
|
|
|
return: Elm_Calendar_Mark *;
|
2014-03-20 00:44:34 -07:00
|
|
|
params {
|
2014-06-26 05:24:20 -07:00
|
|
|
@in const(char)* mark_type; /*@ A string used to define the type of mark. It will be
|
2014-03-20 00:44:34 -07:00
|
|
|
emitted to the theme, that should display a related modification on these
|
|
|
|
days representation. */
|
|
|
|
@in struct tm *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 Elm_Calendar_Mark_Repeat_Type repeat; /*@ Repeat the event following this periodicity. Can be a unique
|
|
|
|
mark (that don't repeat), daily, weekly, monthly or annually. */
|
|
|
|
}
|
|
|
|
}
|
|
|
|
marks_clear {
|
|
|
|
/*@
|
|
|
|
Remove all calendar's marks
|
|
|
|
|
|
|
|
@see elm_calendar_mark_add()
|
|
|
|
@see elm_calendar_mark_del()
|
|
|
|
|
|
|
|
@ingroup Calendar */
|
|
|
|
|
|
|
|
}
|
|
|
|
marks_draw {
|
|
|
|
/*@
|
|
|
|
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 elm_calendar_mark_add()
|
|
|
|
@see elm_calendar_mark_del()
|
|
|
|
@see elm_calendar_marks_clear()
|
|
|
|
|
|
|
|
@ref calendar_example_06
|
|
|
|
|
|
|
|
@ingroup Calendar */
|
|
|
|
|
|
|
|
}
|
2014-07-22 09:13:52 -07:00
|
|
|
displayed_time_get @const {
|
2014-03-20 00:44:34 -07:00
|
|
|
/*@
|
|
|
|
Get the current time displayed in the widget
|
|
|
|
|
|
|
|
@return EINA_FALSE means an error occurred. If it's an error the returned
|
|
|
|
time is zero filled.
|
|
|
|
|
|
|
|
@ingroup Calendar
|
|
|
|
@since 1.8 */
|
2014-08-11 07:46:11 -07:00
|
|
|
return: bool;
|
2014-03-20 00:44:34 -07:00
|
|
|
params {
|
2014-07-08 06:16:04 -07:00
|
|
|
@inout struct tm displayed_time; /*@ A @b tm struct to point to displayed date */
|
2014-03-20 00:44:34 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
implements {
|
2014-06-20 02:47:39 -07:00
|
|
|
class.constructor;
|
2014-06-27 15:36:05 -07:00
|
|
|
Eo.Base.constructor;
|
|
|
|
Evas.Object_Smart.calculate;
|
|
|
|
Evas.Object_Smart.add;
|
|
|
|
Evas.Object_Smart.del;
|
2014-06-20 02:47:39 -07:00
|
|
|
Elm_Widget.theme_apply;
|
|
|
|
Elm_Widget.focus_next_manager_is;
|
|
|
|
Elm_Widget.focus_direction_manager_is;
|
|
|
|
Elm_Widget.access;
|
|
|
|
Elm_Widget.focus_next;
|
|
|
|
Elm_Widget.event;
|
|
|
|
Elm_Layout.sizing_eval;
|
2014-07-25 01:33:19 -07:00
|
|
|
Elm_Interface_Atspi_Widget_Action.elm_actions.get;
|
2014-03-20 00:44:34 -07:00
|
|
|
}
|
|
|
|
events {
|
|
|
|
changed;
|
|
|
|
display,changed;
|
|
|
|
language,changed;
|
|
|
|
access,changed;
|
|
|
|
focused;
|
|
|
|
unfocused;
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|