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
48 * @li elm_finger_size_set()
49 * @li elm_profile_set()
50 * @li elm_font_overlay_set()
51 * @li elm_cache_flush_interval_set()
52 * @li elm_cache_flush_enabled_set()
53 * @li elm_font_cache_set()
54 * @li elm_image_cache_set()
55 * @li elm_edje_file_cache_set()
56 * @li elm_edje_collection_cache_set()
57 * @li elm_scroll_bounce_enabled_set()
58 * @li elm_scroll_bounce_friction_set()
59 * @li elm_scroll_page_scroll_friction_set()
60 * @li elm_scroll_bring_in_scroll_friction_set()
61 * @li elm_scroll_zoom_friction_set()
62 * @li elm_scroll_thumbscroll_enabled_set()
63 * @li elm_scroll_thumbscroll_threshold_set()
64 * @li elm_scroll_thumbscroll_momentum_threshold_set()
65 * @li elm_scroll_thumbscroll_friction_set()
66 * @li elm_scroll_thumbscroll_border_friction_set()
67 * @li elm_scroll_thumbscroll_sensitivity_friction_set()
73 EAPI void elm_config_all_flush(void);
80 * @defgroup Profile Elementary Profile
82 * Profiles are pre-set options that affect the whole look-and-feel of
83 * Elementary-based applications. There are, for example, profiles
84 * aimed at desktop computer applications and others aimed at mobile,
85 * touchscreen-based ones. You most probably don't want to use the
86 * functions in this group unless you're writing an elementary
87 * configuration manager.
93 * Get Elementary's profile in use.
95 * This gets the global profile that is applied to all Elementary
98 * @return The profile's name
101 EAPI const char *elm_profile_current_get(void);
104 * Get an Elementary's profile directory path in the filesystem. One
105 * may want to fetch a system profile's dir or an user one (fetched
108 * @param profile The profile's name
109 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
110 * or a system one (@c EINA_FALSE)
111 * @return The profile's directory path.
114 * @note You must free it with elm_profile_dir_free().
116 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
119 * Free an Elementary's profile directory path, as returned by
120 * elm_profile_dir_get().
122 * @param p_dir The profile's path
126 EAPI void elm_profile_dir_free(const char *p_dir);
129 * Get Elementary's list of available profiles.
131 * @return The profiles list. List node data are the profile name
135 * @note One must free this list, after usage, with the function
136 * elm_profile_list_free().
138 EAPI Eina_List *elm_profile_list_get(void);
141 * Free Elementary's list of available profiles.
143 * @param l The profiles list, as returned by elm_profile_list_get().
147 EAPI void elm_profile_list_free(Eina_List *l);
150 * Set Elementary's profile.
152 * This sets the global profile that is applied to Elementary
153 * applications. Just the process the call comes from will be
156 * @param profile The profile's name
160 EAPI void elm_profile_set(const char *profile);
167 * @defgroup Scrolling Scrolling
169 * These are functions setting how scrollable views in Elementary
170 * widgets should behave on user interaction.
176 * Get whether scrollers should bounce when they reach their
177 * viewport's edge during a scroll.
179 * @return the thumb scroll bouncing state
181 * This is the default behavior for touch screens, in general.
184 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
187 * Set whether scrollers should bounce when they reach their
188 * viewport's edge during a scroll.
190 * @param enabled the thumb scroll bouncing state
192 * @see elm_thumbscroll_bounce_enabled_get()
195 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
198 * Get the amount of inertia a scroller will impose at bounce
201 * @return the thumb scroll bounce friction
205 EAPI double elm_scroll_bounce_friction_get(void);
208 * Set the amount of inertia a scroller will impose at bounce
211 * @param friction the thumb scroll bounce friction
213 * @see elm_thumbscroll_bounce_friction_get()
216 EAPI void elm_scroll_bounce_friction_set(double friction);
219 * Get the amount of inertia a <b>paged</b> scroller will impose at
220 * page fitting animations.
222 * @return the page scroll friction
226 EAPI double elm_scroll_page_scroll_friction_get(void);
229 * Set the amount of inertia a <b>paged</b> scroller will impose at
230 * page fitting animations.
232 * @param friction the page scroll friction
234 * @see elm_thumbscroll_page_scroll_friction_get()
237 EAPI void elm_scroll_page_scroll_friction_set(double friction);
240 * Get the amount of inertia a scroller will impose at region bring
243 * @return the bring in scroll friction
247 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
250 * Set the amount of inertia a scroller will impose at region bring
253 * @param friction the bring in scroll friction
255 * @see elm_thumbscroll_bring_in_scroll_friction_get()
258 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
261 * Get the amount of inertia scrollers will impose at animations
262 * triggered by Elementary widgets' zooming API.
264 * @return the zoom friction
268 EAPI double elm_scroll_zoom_friction_get(void);
271 * Set the amount of inertia scrollers will impose at animations
272 * triggered by Elementary widgets' zooming API.
274 * @param friction the zoom friction
276 * @see elm_thumbscroll_zoom_friction_get()
279 EAPI void elm_scroll_zoom_friction_set(double friction);
282 * Get whether scrollers should be draggable from any point in their
285 * @return the thumb scroll state
287 * @note This is the default behavior for touch screens, in general.
288 * @note All other functions namespaced with "thumbscroll" will only
289 * have effect if this mode is enabled.
293 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
296 * Set whether scrollers should be draggable from any point in their
299 * @param enabled the thumb scroll state
301 * @see elm_thumbscroll_enabled_get()
304 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
307 * Get the number of pixels one should travel while dragging a
308 * scroller's view to actually trigger scrolling.
310 * @return the thumb scroll threshold
312 * One would use higher values for touch screens, in general, because
313 * of their inherent imprecision.
316 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
319 * Set the number of pixels one should travel while dragging a
320 * scroller's view to actually trigger scrolling.
322 * @param threshold the thumb scroll threshold
324 * @see elm_thumbscroll_threshold_get()
327 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
330 * Get the minimum speed of mouse cursor movement which will trigger
331 * list self scrolling animation after a mouse up event
334 * @return the thumb scroll momentum threshold
338 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
341 * Set the minimum speed of mouse cursor movement which will trigger
342 * list self scrolling animation after a mouse up event
345 * @param threshold the thumb scroll momentum threshold
347 * @see elm_thumbscroll_momentum_threshold_get()
350 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
353 * Get the amount of inertia a scroller will impose at self scrolling
356 * @return the thumb scroll friction
360 EAPI double elm_scroll_thumbscroll_friction_get(void);
363 * Set the amount of inertia a scroller will impose at self scrolling
366 * @param friction the thumb scroll friction
368 * @see elm_thumbscroll_friction_get()
371 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
374 * Get the amount of lag between your actual mouse cursor dragging
375 * movement and a scroller's view movement itself, while pushing it
376 * into bounce state manually.
378 * @return the thumb scroll border friction
382 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
385 * Set the amount of lag between your actual mouse cursor dragging
386 * movement and a scroller's view movement itself, while pushing it
387 * into bounce state manually.
389 * @param friction the thumb scroll border friction. @c 0.0 for
390 * perfect synchrony between two movements, @c 1.0 for maximum
393 * @see elm_thumbscroll_border_friction_get()
394 * @note parameter value will get bound to 0.0 - 1.0 interval, always
398 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
401 * Get the sensitivity amount which is be multiplied by the length of
404 * @return the thumb scroll sensitivity friction
408 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
411 * Set the sensitivity amount which is be multiplied by the length of
414 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
415 * minimum sensitivity, @c 1.0 for maximum sensitivity. 0.25
418 * @see elm_thumbscroll_sensitivity_friction_get()
419 * @note parameter value will get bound to 0.1 - 1.0 interval, always
423 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
430 * Get the duration for occurring long press event.
432 * @return Timeout for long press event
435 EAPI double elm_longpress_timeout_get(void);
438 * Set the duration for occurring long press event.
440 * @param lonpress_timeout Timeout for long press event
443 EAPI void elm_longpress_timeout_set(double longpress_timeout);