2 * @defgroup Config Elementary Config
4 * Elementary configuration is formed by a set options bounded to a
5 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
6 * "finger size", etc. These are functions with which one synchronizes
7 * changes made to those values to the configuration storing files, de
8 * facto. You most probably don't want to use the functions in this
9 * group unless you're writing an elementary configuration manager.
15 * Save back Elementary's configuration, so that it will persist on
18 * @return @c EINA_TRUE, when successful. @c EINA_FALSE, otherwise.
21 * This function will take effect -- thus, do I/O -- immediately. Use
22 * it when you want to apply all configuration changes at once. The
23 * current configuration set will get saved onto the current profile
27 EAPI Eina_Bool elm_config_save(void);
30 * Reload Elementary's configuration, bounded to current selected
33 * @return @c EINA_TRUE, when successful. @c EINA_FALSE, otherwise.
36 * Useful when you want to force reloading of configuration values for
37 * a profile. If one removes user custom configuration directories,
38 * for example, it will force a reload with system values instead.
41 EAPI void elm_config_reload(void);
44 * Flush all config settings then apply those settings to all applications
45 * using elementary on the current display.
46 * Following functions will update the config settings
47 * @li elm_cache_flush_interval_set()
48 * @li elm_cache_flush_enabled_set()
49 * @li elm_edje_file_cache_set()
50 * @li elm_edje_collection_cache_set()
51 * @li elm_finger_size_set()
52 * @li elm_focus_highlight_enabled_set()
53 * @li elm_focus_highlight_animate_set()
54 * @li elm_font_overlay_set()
55 * @li elm_font_cache_set()
56 * @li elm_image_cache_set()
57 * @li elm_profile_set()
59 * @li elm_scroll_bounce_enabled_set()
60 * @li elm_scroll_bounce_friction_set()
61 * @li elm_scroll_page_scroll_friction_set()
62 * @li elm_scroll_bring_in_scroll_friction_set()
63 * @li elm_scroll_zoom_friction_set()
64 * @li elm_scroll_thumbscroll_enabled_set()
65 * @li elm_scroll_thumbscroll_threshold_set()
66 * @li elm_scroll_thumbscroll_momentum_threshold_set()
67 * @li elm_scroll_thumbscroll_friction_set()
68 * @li elm_scroll_thumbscroll_border_friction_set()
69 * @li elm_scroll_thumbscroll_sensitivity_friction_set()
75 EAPI void elm_config_all_flush(void);
82 * @defgroup Profile Elementary Profile
84 * Profiles are pre-set options that affect the whole look-and-feel of
85 * Elementary-based applications. There are, for example, profiles
86 * aimed at desktop computer applications and others aimed at mobile,
87 * touchscreen-based ones. You most probably don't want to use the
88 * functions in this group unless you're writing an elementary
89 * configuration manager.
95 * Get Elementary's profile in use.
97 * This gets the global profile that is applied to all Elementary
100 * @return The profile's name
103 EAPI const char *elm_profile_current_get(void);
106 * Get an Elementary's profile directory path in the filesystem. One
107 * may want to fetch a system profile's dir or an user one (fetched
110 * @param profile The profile's name
111 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
112 * or a system one (@c EINA_FALSE)
113 * @return The profile's directory path.
116 * @note You must free it with elm_profile_dir_free().
118 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
121 * Free an Elementary's profile directory path, as returned by
122 * elm_profile_dir_get().
124 * @param p_dir The profile's path
128 EAPI void elm_profile_dir_free(const char *p_dir);
131 * Get Elementary's list of available profiles.
133 * @return The profiles list. List node data are the profile name
137 * @note One must free this list, after usage, with the function
138 * elm_profile_list_free().
140 EAPI Eina_List *elm_profile_list_get(void);
143 * Free Elementary's list of available profiles.
145 * @param l The profiles list, as returned by elm_profile_list_get().
149 EAPI void elm_profile_list_free(Eina_List *l);
152 * Set Elementary's profile.
154 * This sets the global profile that is applied to Elementary
155 * applications. Just the process the call comes from will be
158 * @param profile The profile's name
162 EAPI void elm_profile_set(const char *profile);
169 * @defgroup Scrolling Scrolling
171 * These are functions setting how scrollable views in Elementary
172 * widgets should behave on user interaction.
178 * Get whether scrollers should bounce when they reach their
179 * viewport's edge during a scroll.
181 * @return the thumb scroll bouncing state
183 * This is the default behavior for touch screens, in general.
186 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
189 * Set whether scrollers should bounce when they reach their
190 * viewport's edge during a scroll.
192 * @param enabled the thumb scroll bouncing state
194 * @see elm_thumbscroll_bounce_enabled_get()
197 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
200 * Get the amount of inertia a scroller will impose at bounce
203 * @return the thumb scroll bounce friction
207 EAPI double elm_scroll_bounce_friction_get(void);
210 * Set the amount of inertia a scroller will impose at bounce
213 * @param friction the thumb scroll bounce friction
215 * @see elm_thumbscroll_bounce_friction_get()
218 EAPI void elm_scroll_bounce_friction_set(double friction);
221 * Get the amount of inertia a <b>paged</b> scroller will impose at
222 * page fitting animations.
224 * @return the page scroll friction
228 EAPI double elm_scroll_page_scroll_friction_get(void);
231 * Set the amount of inertia a <b>paged</b> scroller will impose at
232 * page fitting animations.
234 * @param friction the page scroll friction
236 * @see elm_thumbscroll_page_scroll_friction_get()
239 EAPI void elm_scroll_page_scroll_friction_set(double friction);
242 * Get the amount of inertia a scroller will impose at region bring
245 * @return the bring in scroll friction
249 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
252 * Set the amount of inertia a scroller will impose at region bring
255 * @param friction the bring in scroll friction
257 * @see elm_thumbscroll_bring_in_scroll_friction_get()
260 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
263 * Get the amount of inertia scrollers will impose at animations
264 * triggered by Elementary widgets' zooming API.
266 * @return the zoom friction
270 EAPI double elm_scroll_zoom_friction_get(void);
273 * Set the amount of inertia scrollers will impose at animations
274 * triggered by Elementary widgets' zooming API.
276 * @param friction the zoom friction
278 * @see elm_thumbscroll_zoom_friction_get()
281 EAPI void elm_scroll_zoom_friction_set(double friction);
284 * Get whether scrollers should be draggable from any point in their
287 * @return the thumb scroll state
289 * @note This is the default behavior for touch screens, in general.
290 * @note All other functions namespaced with "thumbscroll" will only
291 * have effect if this mode is enabled.
295 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
298 * Set whether scrollers should be draggable from any point in their
301 * @param enabled the thumb scroll state
303 * @see elm_thumbscroll_enabled_get()
306 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
309 * Get the number of pixels one should travel while dragging a
310 * scroller's view to actually trigger scrolling.
312 * @return the thumb scroll threshold
314 * One would use higher values for touch screens, in general, because
315 * of their inherent imprecision.
318 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
321 * Set the number of pixels one should travel while dragging a
322 * scroller's view to actually trigger scrolling.
324 * @param threshold the thumb scroll threshold
326 * @see elm_thumbscroll_threshold_get()
329 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
332 * Get the minimum speed of mouse cursor movement which will trigger
333 * list self scrolling animation after a mouse up event
336 * @return the thumb scroll momentum threshold
340 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
343 * Set the minimum speed of mouse cursor movement which will trigger
344 * list self scrolling animation after a mouse up event
347 * @param threshold the thumb scroll momentum threshold
349 * @see elm_thumbscroll_momentum_threshold_get()
352 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
355 * Get the amount of inertia a scroller will impose at self scrolling
358 * @return the thumb scroll friction
362 EAPI double elm_scroll_thumbscroll_friction_get(void);
365 * Set the amount of inertia a scroller will impose at self scrolling
368 * @param friction the thumb scroll friction
370 * @see elm_thumbscroll_friction_get()
373 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
376 * Get the amount of lag between your actual mouse cursor dragging
377 * movement and a scroller's view movement itself, while pushing it
378 * into bounce state manually.
380 * @return the thumb scroll border friction
384 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
387 * Set the amount of lag between your actual mouse cursor dragging
388 * movement and a scroller's view movement itself, while pushing it
389 * into bounce state manually.
391 * @param friction the thumb scroll border friction. @c 0.0 for
392 * perfect synchrony between two movements, @c 1.0 for maximum
395 * @see elm_thumbscroll_border_friction_get()
396 * @note parameter value will get bound to 0.0 - 1.0 interval, always
400 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
403 * Get the sensitivity amount which is be multiplied by the length of
406 * @return the thumb scroll sensitivity friction
410 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
413 * Set the sensitivity amount which is be multiplied by the length of
416 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
417 * minimum sensitivity, @c 1.0 for maximum sensitivity. 0.25
420 * @see elm_thumbscroll_sensitivity_friction_get()
421 * @note parameter value will get bound to 0.1 - 1.0 interval, always
425 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
432 * Get the duration for occurring long press event.
434 * @return Timeout for long press event
437 EAPI double elm_longpress_timeout_get(void);
440 * Set the duration for occurring long press event.
442 * @param lonpress_timeout Timeout for long press event
445 EAPI void elm_longpress_timeout_set(double longpress_timeout);