summaryrefslogtreecommitdiff
path: root/src/lib/elementary/elm_dayselector_eo.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/elementary/elm_dayselector_eo.h')
-rw-r--r--src/lib/elementary/elm_dayselector_eo.h194
1 files changed, 194 insertions, 0 deletions
diff --git a/src/lib/elementary/elm_dayselector_eo.h b/src/lib/elementary/elm_dayselector_eo.h
new file mode 100644
index 0000000..02e3d6f
--- /dev/null
+++ b/src/lib/elementary/elm_dayselector_eo.h
@@ -0,0 +1,194 @@
1#ifndef _ELM_DAYSELECTOR_EO_H_
2#define _ELM_DAYSELECTOR_EO_H_
3
4#ifndef _ELM_DAYSELECTOR_EO_CLASS_TYPE
5#define _ELM_DAYSELECTOR_EO_CLASS_TYPE
6
7typedef Eo Elm_Dayselector;
8
9#endif
10
11#ifndef _ELM_DAYSELECTOR_EO_TYPES
12#define _ELM_DAYSELECTOR_EO_TYPES
13
14/**
15 * @brief Identifies the day of the week. API can call the
16 * selection/unselection of day with this as a parameter.
17 *
18 * See also @ref elm_obj_dayselector_day_selected_set,
19 * @ref elm_obj_dayselector_day_selected_get.
20 *
21 * @ingroup Elm_Dayselector
22 */
23typedef enum
24{
25 ELM_DAYSELECTOR_SUN = 0, /**< Indicates Sunday. */
26 ELM_DAYSELECTOR_MON, /**< Indicates Monday. */
27 ELM_DAYSELECTOR_TUE, /**< Indicates Tuesday. */
28 ELM_DAYSELECTOR_WED, /**< Indicates Wednesday. */
29 ELM_DAYSELECTOR_THU, /**< Indicates Thursday. */
30 ELM_DAYSELECTOR_FRI, /**< Indicates Friday. */
31 ELM_DAYSELECTOR_SAT, /**< Indicates Saturday. */
32 ELM_DAYSELECTOR_MAX /**< Sentinel value to indicate last enum field during
33 * iteration */
34} Elm_Dayselector_Day;
35
36
37#endif
38/** Elementary dayselector class
39 *
40 * @ingroup Elm_Dayselector
41 */
42#define ELM_DAYSELECTOR_CLASS elm_dayselector_class_get()
43
44EWAPI const Efl_Class *elm_dayselector_class_get(void);
45
46/**
47 * @brief Set the starting day of Dayselector.
48 *
49 * See also @ref Elm_Dayselector_Day, @ref elm_obj_dayselector_week_start_get.
50 *
51 * @param[in] obj The object.
52 * @param[in] day Dayselector_Day the first day that the user wants to display.
53 *
54 * @ingroup Elm_Dayselector
55 */
56EOAPI void elm_obj_dayselector_week_start_set(Eo *obj, Elm_Dayselector_Day day);
57
58/**
59 * @brief Get the starting day of Dayselector.
60 *
61 * See also @ref Elm_Dayselector_Day, @ref elm_obj_dayselector_week_start_set.
62 *
63 * @param[in] obj The object.
64 *
65 * @return Dayselector_Day the first day that the user wants to display.
66 *
67 * @ingroup Elm_Dayselector
68 */
69EOAPI Elm_Dayselector_Day elm_obj_dayselector_week_start_get(const Eo *obj);
70
71/**
72 * @brief Set the weekend length of Dayselector.
73 *
74 * See also @ref elm_obj_dayselector_weekend_length_get.
75 *
76 * @param[in] obj The object.
77 * @param[in] length Weekend length, number of days as an integer.
78 *
79 * @ingroup Elm_Dayselector
80 */
81EOAPI void elm_obj_dayselector_weekend_length_set(Eo *obj, unsigned int length);
82
83/**
84 * @brief Get the weekend length of Dayselector.
85 *
86 * See also @ref Elm_Dayselector_Day,
87 * @ref elm_obj_dayselector_weekend_length_set.
88 *
89 * @param[in] obj The object.
90 *
91 * @return Weekend length, number of days as an integer.
92 *
93 * @ingroup Elm_Dayselector
94 */
95EOAPI unsigned int elm_obj_dayselector_weekend_length_get(const Eo *obj);
96
97/**
98 * @brief Set the weekend starting day of Dayselector.
99 *
100 * See also @ref Elm_Dayselector_Day,
101 * @ref elm_obj_dayselector_weekend_start_get.
102 *
103 * @param[in] obj The object.
104 * @param[in] day Dayselector_Day the first day from where weekend starts.
105 *
106 * @ingroup Elm_Dayselector
107 */
108EOAPI void elm_obj_dayselector_weekend_start_set(Eo *obj, Elm_Dayselector_Day day);
109
110/**
111 * @brief Get the weekend starting day of Dayselector.
112 *
113 * See also @ref Elm_Dayselector_Day,
114 * @ref elm_obj_dayselector_weekend_start_set.
115 *
116 * @param[in] obj The object.
117 *
118 * @return Dayselector_Day the first day from where weekend starts.
119 *
120 * @ingroup Elm_Dayselector
121 */
122EOAPI Elm_Dayselector_Day elm_obj_dayselector_weekend_start_get(const Eo *obj);
123
124/**
125 * @brief Set weekdays names to be displayed by the Dayselector.
126 *
127 * By default or if weekdays is @c null, weekdays abbreviations get from system
128 * are displayed: E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
129 *
130 * The first string should be related to Sunday, the second to Monday...
131 *
132 * See also @ref elm_obj_dayselector_weekdays_names_get,
133 * @ref elm_obj_dayselector_weekend_start_set.
134 *
135 * @param[in] obj The object.
136 * @param[in] weekdays Array of seven strings to be used as weekday names.
137 * Warning: It must have 7 elements, or it will access invalid memory. Warning:
138 * The strings must be NULL terminated ('@\0').
139 *
140 * @since 1.8
141 *
142 * @ingroup Elm_Dayselector
143 */
144EOAPI void elm_obj_dayselector_weekdays_names_set(Eo *obj, const char **weekdays);
145
146/**
147 * @brief Get weekdays names displayed by the calendar.
148 *
149 * By default, weekdays abbreviations get from system are displayed: E.g. for
150 * an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat" The first string is
151 * related to Sunday, the second to Monday...
152 *
153 * See also @ref elm_obj_dayselector_weekdays_names_set.
154 *
155 * @param[in] obj The object.
156 *
157 * @return A list of seven strings to be used as weekday names.
158 *
159 * @since 1.8
160 *
161 * @ingroup Elm_Dayselector
162 */
163EOAPI Eina_List *elm_obj_dayselector_weekdays_names_get(const Eo *obj) EINA_WARN_UNUSED_RESULT;
164
165/**
166 * @brief Set the state of given Dayselector_Day.
167 *
168 * See also @ref Elm_Dayselector_Day,
169 * @ref elm_obj_dayselector_day_selected_get.
170 *
171 * @param[in] obj The object.
172 * @param[in] day Dayselector_Day that the user want to set state.
173 * @param[in] selected State of the day. @c true is selected.
174 *
175 * @ingroup Elm_Dayselector
176 */
177EOAPI void elm_obj_dayselector_day_selected_set(Eo *obj, Elm_Dayselector_Day day, Eina_Bool selected);
178
179/**
180 * @brief Get the state of given Dayselector_Day.
181 *
182 * See also @ref Elm_Dayselector_Day,
183 * @ref elm_obj_dayselector_day_selected_set.
184 *
185 * @param[in] obj The object.
186 * @param[in] day Dayselector_Day that the user want to know state.
187 *
188 * @return @c true on success, @c false on failure
189 *
190 * @ingroup Elm_Dayselector
191 */
192EOAPI Eina_Bool elm_obj_dayselector_day_selected_get(const Eo *obj, Elm_Dayselector_Day day);
193
194#endif