elm_calendar: Move enums to elm_calendar.eo

Move enums from elm_calendar_common.h to elm_calendar.eo in order to make them
more accessible for bindings.
This commit is contained in:
Yakov Goldberg 2015-07-07 11:51:50 +03:00
parent ce57367a39
commit 2007cbbeb7
2 changed files with 85 additions and 77 deletions

View File

@ -1,3 +1,84 @@
enum Elm.Calendar.Mark.Repeat.Type
{
[[
@addtogroup Calendar
@enum Elm_Calendar_Mark_Repeat_Type
Event periodicity, used to define if a mark should be repeated
@b 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 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]]
}
enum Elm.Calendar.Weekday
{
[[
@addtogroup Calendar
@enum Elm_Calendar_Weekday
A weekday
@see elm_calendar_first_day_of_week_set()
]]
legacy: elm_day;
sunday,
monday,
tuesday,
wednesday,
thursday,
friday,
saturday,
last
}
enum Elm.Calendar.Select.Mode
{
[[
@addtogroup Calendar
@enum Elm_Calendar_Select_Mode
The mode, who determine how user could select a day
@see 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
{
[[
@addtogroup Calendar
@Elm_Calendar_Selectable
A bitmask used to define which fields of a @b tm struct will be taken into
account, when elm_calendar_selected_time_set() is invoked.
@see elm_calendar_selectable_set()
@see elm_calendar_selected_time_set()
@since 1.8
]]
none = 0,
year = (1 << 0),
month = (1 << 1),
day = (1 << 2)
}
class Elm.Calendar (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
{
eo_prefix: elm_obj_calendar;
@ -21,7 +102,7 @@ class Elm.Calendar (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
@ingroup Calendar */
}
values {
day: Elm_Calendar_Weekday; /*@ An int which correspond to the first day of the week (Sunday = 0, Monday = 1,
day: Elm.Calendar.Weekday; /*@ An int which correspond to the first day of the week (Sunday = 0, Monday = 1,
..., Saturday = 6) */
}
}
@ -50,7 +131,7 @@ class Elm.Calendar (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
@since 1.8 */
}
values {
selectable: Elm_Calendar_Selectable; /*@ A bitmask of Elm_Calendar_Selectable */
selectable: Elm.Calendar.Selectable; /*@ A bitmask of Elm_Calendar_Selectable */
}
}
@property interval {
@ -162,7 +243,7 @@ class Elm.Calendar (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
@ingroup Calendar */
}
values {
mode: Elm_Calendar_Select_Mode; /*@ The select mode to use. */
mode: Elm.Calendar.Select.Mode; /*@ The select mode to use. */
}
}
@property min_max_year {
@ -337,7 +418,7 @@ class Elm.Calendar (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
@in mark_time: Elm_Calendar_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
@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. */
}
}

View File

@ -3,79 +3,6 @@
*
* @{
*/
/**
* @enum Elm_Calendar_Mark_Repeat_Type
* Event periodicity, used to define if a mark should be repeated
* @b 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 elm_calendar_mark_add()
*/
typedef enum
{
ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
ELM_CALENDAR_DAILY, /**< Marks will be displayed every day after event day (inclusive). */
ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
ELM_CALENDAR_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*/
ELM_CALENDAR_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. */
ELM_CALENDAR_LAST_DAY_OF_MONTH /**< Marks will be displayed every last day of month after event day (inclusive). @since 1.7 */
} Elm_Calendar_Mark_Repeat_Type;
/**
* @enum Elm_Calendar_Weekday
* A weekday
*
* @see elm_calendar_first_day_of_week_set()
*/
typedef enum
{
ELM_DAY_SUNDAY,
ELM_DAY_MONDAY,
ELM_DAY_TUESDAY,
ELM_DAY_WEDNESDAY,
ELM_DAY_THURSDAY,
ELM_DAY_FRIDAY,
ELM_DAY_SATURDAY,
ELM_DAY_LAST
} Elm_Calendar_Weekday;
/**
* @enum Elm_Calendar_Select_Mode
*
* The mode, who determine how user could select a day
*
* @see elm_calendar_select_mode_set()
*/
typedef enum
{
ELM_CALENDAR_SELECT_MODE_DEFAULT = 0, /**< Default value. a day is always selected. */
ELM_CALENDAR_SELECT_MODE_ALWAYS, /**< a day is always selected. */
ELM_CALENDAR_SELECT_MODE_NONE, /**< None of the days can be selected. */
ELM_CALENDAR_SELECT_MODE_ONDEMAND /**< User may have selected a day or not. */
} Elm_Calendar_Select_Mode;
/**
* @Elm_Calendar_Selectable
*
* A bitmask used to define which fields of a @b tm struct will be taken into
* account, when elm_calendar_selected_time_set() is invoked.
*
* @see elm_calendar_selectable_set()
* @see elm_calendar_selected_time_set()
* @since 1.8
*/
typedef enum
{
ELM_CALENDAR_SELECTABLE_NONE = 0,
ELM_CALENDAR_SELECTABLE_YEAR = (1 << 0),
ELM_CALENDAR_SELECTABLE_MONTH = (1 << 1),
ELM_CALENDAR_SELECTABLE_DAY = (1 << 2)
} Elm_Calendar_Selectable;
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(). */