efl/src/lib/elementary/elm_dayselector.eo

162 lines
4.8 KiB
Plaintext
Raw Normal View History

enum Elm.Dayselector.Day
{
[[Identifies the day of the week. API can call the selection/unselection
of day with this as a parameter.
See also @Elm.Dayselector.day_selected_set, @Elm.Dayselector.day_selected_get.
]]
legacy: elm_dayselector;
sun = 0,[[Indicates Sunday.]]
mon, [[Indicates Monday.]]
tue, [[Indicates Tuesday.]]
wed, [[Indicates Wednesday.]]
thu, [[Indicates Thursday.]]
fri, [[Indicates Friday.]]
sat, [[Indicates Saturday.]]
max [[Sentinel value to indicate last enum field during iteration]]
}
class Elm.Dayselector (Efl.Ui.Layout)
2014-03-21 07:01:48 -07:00
{
[[Elementary dayselector class]]
legacy_prefix: elm_dayselector;
2014-03-21 07:01:48 -07:00
eo_prefix: elm_obj_dayselector;
event_prefix: elm_dayselector;
2015-05-07 09:32:53 -07:00
methods {
@property week_start {
2014-03-21 07:01:48 -07:00
set {
[[Set the starting day of Dayselector.
2014-03-21 07:01:48 -07:00
See also @Elm.Dayselector.Day,
@.week_start.get.
]]
2014-03-21 07:01:48 -07:00
}
get {
[[Get the starting day of Dayselector.
2014-03-21 07:01:48 -07:00
See also @Elm.Dayselector.Day,
@.week_start.set.
]]
2014-03-21 07:01:48 -07:00
}
values {
day: Elm.Dayselector.Day; [[Dayselector_Day the first day that the user wants to display.]]
2014-03-21 07:01:48 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property weekend_length {
2014-03-21 07:01:48 -07:00
set {
[[Set the weekend length of Dayselector.
2014-03-21 07:01:48 -07:00
See also @.weekend_length.get.
]]
2014-03-21 07:01:48 -07:00
}
get {
[[Get the weekend length of Dayselector.
2014-03-21 07:01:48 -07:00
See also @Elm.Dayselector.Day,
@.weekend_length.set.
]]
2014-03-21 07:01:48 -07:00
}
values {
length: uint; [[Weekend length, number of days as an integer.]]
2014-03-21 07:01:48 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property weekend_start {
2014-03-21 07:01:48 -07:00
set {
[[Set the weekend starting day of Dayselector.
2014-03-21 07:01:48 -07:00
See also @Elm.Dayselector.Day,
@.weekend_start.get.
]]
2014-03-21 07:01:48 -07:00
}
get {
[[Get the weekend starting day of Dayselector.
2014-03-21 07:01:48 -07:00
See also @Elm.Dayselector.Day,
@.weekend_start.set.
]]
2014-03-21 07:01:48 -07:00
}
values {
day: Elm.Dayselector.Day; [[Dayselector_Day the first day from where weekend starts.]]
2014-03-21 07:01:48 -07:00
}
}
weekdays_names_set {
[[Set weekdays names to be displayed by the Dayselector.
By default or if weekdays is $null, 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,
@.weekend_start.set.
@since 1.8
]]
/* FIXME-doc
*
* The usage should be like this:
* @code
* const char *weekdays[] =
* {
* "Sunday", "Monday", "Tuesday", "Wednesday",
* "Thursday", "Friday", "Saturday"
* };
* elm_dayselector_wekdays_names_set(calendar, weekdays);
* @endcode
*/
2014-03-21 07:01:48 -07:00
params {
@in weekdays: legacy(ptr(string)) @nullable; [[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').]]
2014-03-21 07:01:48 -07:00
}
}
2014-07-22 09:13:52 -07:00
weekdays_names_get @const {
[[Get weekdays names displayed by the calendar.
2014-03-21 07:01:48 -07:00
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...
2014-03-21 07:01:48 -07:00
See also @.weekdays_names_set.
2014-03-21 07:01:48 -07:00
@since 1.8
]]
2017-09-15 08:05:30 -07:00
return: list<stringshare @owned> @owned @warn_unused; [[A list of seven strings to be used as weekday names.]]
2014-03-21 07:01:48 -07:00
}
day_selected_set {
[[Set the state of given Dayselector_Day.
2014-03-21 07:01:48 -07:00
See also @Elm.Dayselector.Day,
@.day_selected_get.
]]
2014-03-21 07:01:48 -07:00
params {
@in day: Elm.Dayselector.Day; [[Dayselector_Day that the user want to set state.]]
@in selected: bool; [[State of the day. $true is selected.]]
2014-03-21 07:01:48 -07:00
}
}
2014-07-22 09:13:52 -07:00
day_selected_get @const {
[[Get the state of given Dayselector_Day.
2014-03-21 07:01:48 -07:00
See also @Elm.Dayselector.Day,
@.day_selected_set.
]]
return: bool; [[$true on success, $false on failure]]
2014-03-21 07:01:48 -07:00
params {
@in day: Elm.Dayselector.Day; [[Dayselector_Day that the user want to know state.]]
2014-03-21 07:01:48 -07:00
}
}
}
implements {
class.constructor;
Efl.Object.constructor;
Elm.Widget.theme_apply;
Efl.Ui.Translatable.translation_update;
Efl.Part.part;
2014-03-21 07:01:48 -07:00
}
events {
dayselector,changed; [[Called when dayselector widget changed]]
2014-03-21 07:01:48 -07:00
}
}