427 lines
14 KiB
Plaintext
427 lines
14 KiB
Plaintext
import efl_types;
|
|
|
|
type Elm_Calendar_Format_Cb: __undefined_type; [[Elementary calendar format callback type]]
|
|
|
|
enum Elm.Calendar.Mark.Repeat.Type
|
|
{
|
|
[[Event periodicity, used to define if a mark should be repeated beyond event's day.
|
|
|
|
It's set when a mark is added. So, for a mark added to 13th May with periodicity
|
|
set to WEEKLY, there will be marks every week after this date. Marks will be
|
|
displayed at 13th, 20th, 27th, 3rd June ...
|
|
|
|
Values don't work as bitmask, only one can be chosen. See also @Elm.Calendar.mark_add.
|
|
]]
|
|
legacy: elm_calendar;
|
|
unique, [[Default value. Marks will be displayed only on event day.]]
|
|
daily, [[Marks will be displayed every day after event day (inclusive).]]
|
|
weekly, [[Marks will be displayed every week after event day (inclusive) - i.e. each seven days.]]
|
|
monthly, [[Marks will be displayed every month day that coincides to event day. E.g.: if an event is set to 30th Jan, no marks will be displayed on Feb, but will be displayed on 30th Mar.]]
|
|
annually, [[Marks will be displayed every year that coincides to event day (and month). E.g. an event added to 30th Jan 2012 will be repeated on 30th Jan 2013.]]
|
|
last_day_of_month, [[Marks will be displayed every last day of month after event day (inclusive).
|
|
@since 1.7]]
|
|
reverse_daily [[Marks will be displayed every day before event day. @since 1.19]]
|
|
}
|
|
|
|
enum Elm.Calendar.Weekday
|
|
{
|
|
[[A weekday
|
|
|
|
See also @Elm.Calendar.first_day_of_week.set.
|
|
]]
|
|
legacy: elm_day;
|
|
sunday, [[Sunday weekday]]
|
|
monday, [[Monday weekday]]
|
|
tuesday, [[Tuesday weekday]]
|
|
wednesday, [[Wednesday weekday]]
|
|
thursday, [[Thursday weekday]]
|
|
friday, [[Friday weekday]]
|
|
saturday, [[Saturday weekday]]
|
|
last [[Sentinel value to indicate last enum field during iteration]]
|
|
}
|
|
|
|
enum Elm.Calendar.Select.Mode
|
|
{
|
|
[[The mode, who determine how user could select a day
|
|
|
|
See also @Elm.Calendar.select_mode.set()
|
|
]]
|
|
default = 0, [[Default value. A day is always selected.]]
|
|
always, [[A day is always selected.]]
|
|
none, [[None of the days can be selected.]]
|
|
ondemand [[User may have selected a day or not.]]
|
|
}
|
|
|
|
enum Elm.Calendar.Selectable
|
|
{
|
|
[[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 1.8
|
|
]]
|
|
none = 0, [[Take no field into account]]
|
|
year = (1 << 0), [[Take year field into account]]
|
|
month = (1 << 1), [[Take month field into account]]
|
|
day = (1 << 2) [[Take day field into account]]
|
|
}
|
|
|
|
struct Elm.Calendar.Mark; [[Item handle for a calendar mark.
|
|
Created with @Elm.Calendar.mark_add and deleted
|
|
with @Elm.Calendar.mark_del.
|
|
]]
|
|
|
|
class Elm.Calendar extends Efl.Ui.Layout_Base implements Efl.Ui.Focus.Composition, Efl.Access.Widget.Action,
|
|
Efl.Ui.Legacy
|
|
{
|
|
[[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.
|
|
]]
|
|
legacy_prefix: elm_calendar;
|
|
eo_prefix: elm_obj_calendar;
|
|
event_prefix: elm_calendar;
|
|
methods {
|
|
@property first_day_of_week {
|
|
[[The first day of week to use on calendar widgets'.]]
|
|
set {
|
|
}
|
|
get {
|
|
}
|
|
values {
|
|
day: Elm.Calendar.Weekday; [[Weekday enum value, see @Elm.Calendar.Weekday]]
|
|
}
|
|
}
|
|
@property 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 @.selected_time_set.
|
|
|
|
@since 1.8
|
|
]]
|
|
set {
|
|
}
|
|
get {
|
|
}
|
|
values {
|
|
selectable: Elm.Calendar.Selectable; [[A bitmask of Elm_Calendar_Selectable]]
|
|
}
|
|
}
|
|
@property 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.
|
|
]]
|
|
set {
|
|
}
|
|
get {
|
|
}
|
|
values {
|
|
interval: double; [[The (first) interval value in seconds]]
|
|
}
|
|
}
|
|
@property weekdays_names {
|
|
[[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 @.weekdays_names.get.
|
|
|
|
\@ref calendar_example_02.
|
|
\@ref calendar_example_05.
|
|
]]
|
|
/* FIXME-doc
|
|
*
|
|
* 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
|
|
*/
|
|
set {
|
|
}
|
|
get {
|
|
}
|
|
values {
|
|
weekdays: legacy(ptr(string)); [[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').]]
|
|
}
|
|
}
|
|
@property select_mode {
|
|
[[Select day mode to use.
|
|
|
|
The day selection mode used.
|
|
]]
|
|
set {
|
|
}
|
|
get {
|
|
}
|
|
values {
|
|
mode: Elm.Calendar.Select.Mode; [[The select mode to use.]]
|
|
}
|
|
}
|
|
@property 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.
|
|
|
|
\@ref calendar_example_02.
|
|
]]
|
|
/* FIXME-doc
|
|
* 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
|
|
*/
|
|
}
|
|
values {
|
|
format_function: Elm_Calendar_Format_Cb; [[Function to set the month-year string given
|
|
the selected date.]]
|
|
}
|
|
}
|
|
@property marks {
|
|
get {
|
|
[[Get a list of all the calendar marks.
|
|
|
|
See also @.mark_add,
|
|
@.mark_del(),
|
|
@.marks_clear.
|
|
|
|
]]
|
|
return: const(list<ptr(Elm.Calendar.Mark)>); [[List with all calendar marks]]
|
|
}
|
|
}
|
|
@property date_min {
|
|
[[Minimum date on calendar.
|
|
|
|
See also @.date_max.set, @.date_max.get
|
|
|
|
@since 1.19
|
|
]]
|
|
set {
|
|
[[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.
|
|
]]
|
|
}
|
|
get {
|
|
[[Get minimum date.
|
|
|
|
Default value is 1 JAN,1902.
|
|
]]
|
|
}
|
|
values {
|
|
@cref min: Efl.Time; [[A tm struct to point to minimum date.]]
|
|
}
|
|
}
|
|
@property date_max {
|
|
[[Maximum date on calendar.
|
|
|
|
See also @.date_min.set, @.date_min.get
|
|
|
|
@since 1.19
|
|
]]
|
|
set {
|
|
[[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.
|
|
]]
|
|
}
|
|
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);
|
|
]]
|
|
}
|
|
values {
|
|
@cref max: Efl.Time; [[A tm struct to point to maximum date.]]
|
|
}
|
|
}
|
|
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 also @.selected_time_get.
|
|
|
|
\@ref calendar_example_04
|
|
]]
|
|
params {
|
|
@in selected_time: ptr(Efl.Time); [[A tm struct to represent the selected date.]]
|
|
}
|
|
}
|
|
selected_time_get @const {
|
|
[[Get selected date.
|
|
|
|
Get date selected by the user or set by function
|
|
@.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 @.selected_time_get.
|
|
|
|
\@ref calendar_example_05.
|
|
]]
|
|
return: bool; [[$true if the method succeeded, $false otherwise]]
|
|
params {
|
|
@inout selected_time: Efl.Time; [[A tm struct to point to selected date.]]
|
|
}
|
|
}
|
|
mark_add {
|
|
[[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, @.marks_draw(). However, when user selects
|
|
next or previous month calendar forces marks drawn.
|
|
|
|
Marks created with this method can be deleted with @.mark_del().
|
|
|
|
See also @.marks_draw, @.mark_del().
|
|
|
|
\@ref calendar_example_06
|
|
]]
|
|
/* FIXME-doc
|
|
* 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
|
|
*/
|
|
return: ptr(Elm.Calendar.Mark); [[The newly added calendar mark]]
|
|
params {
|
|
@in mark_type: string; [[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: ptr(Efl.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: Elm.Calendar.Mark.Repeat.Type; [[Repeat the event following this periodicity. Can be a unique
|
|
mark (that don't repeat), daily, weekly, monthly or annually.]]
|
|
}
|
|
}
|
|
mark_del {
|
|
[[Delete mark from the calendar.
|
|
|
|
If deleting all calendar marks is required, @.marks_clear()
|
|
should be used instead of getting marks list and deleting each one.
|
|
|
|
See also @.mark_add(), @.marks_clear().
|
|
]]
|
|
legacy: null;
|
|
params {
|
|
@in mark: ptr(Elm.Calendar.Mark); [[ The mark to be deleted. ]]
|
|
}
|
|
}
|
|
marks_clear {
|
|
[[Remove all calendar's marks
|
|
|
|
See also @.mark_add, @.mark_del().
|
|
]]
|
|
}
|
|
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 also @.mark_add, @.mark_del(), @.marks_clear.
|
|
|
|
\@ref calendar_example_06
|
|
]]
|
|
}
|
|
displayed_time_get @const {
|
|
[[Get the current time displayed in the widget
|
|
|
|
@since 1.8
|
|
]]
|
|
return: bool; [[$true if the method succeeded, $false otherwise]]
|
|
params {
|
|
@inout displayed_time: Efl.Time; [[A tm struct to point to displayed date.]]
|
|
}
|
|
}
|
|
}
|
|
implements {
|
|
class.constructor;
|
|
Efl.Object.constructor;
|
|
Efl.Canvas.Group.group_calculate;
|
|
Efl.Ui.Widget.theme_apply;
|
|
Efl.Ui.Widget.on_access_update;
|
|
Efl.Ui.Focus.Object.on_focus_update;
|
|
Efl.Ui.Widget.widget_input_event_handler;
|
|
Efl.Access.Widget.Action.elm_actions { get; }
|
|
}
|
|
events {
|
|
changed: void; [[Emitted when the date in the calendar is changed]]
|
|
display,changed: void; [[Emitted when the current month displayed in the calendar is changed]]
|
|
}
|
|
}
|