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
7 * "finger size", etc. These are functions with which one syncronizes
8 * changes made to those values to the configuration storing files, de
9 * facto. You most probably don't want to use the functions in this
10 * group unlees you're writing an elementary configuration manager.
12 * "finger size", etc. These are functions with which one synchronizes
13 * changes made to those values to the configuration storing files, de
14 * facto. You most probably don't want to use the functions in this
15 * group unless you're writing an elementary configuration manager.
16 >>>>>>> remotes/origin/upstream
22 * Save back Elementary's configuration, so that it will persist on
26 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
29 * This function will take effect -- thus, do I/O -- immediately. Use
30 * it when you want to apply all configuration changes at once. The
32 * @return @c EINA_TRUE, when successful. @c EINA_FALSE, otherwise.
35 * This function will take effect -- thus, do I/O -- immediately. Use
36 * it when you want to save all configuration changes at once. The
37 >>>>>>> remotes/origin/upstream
38 * current configuration set will get saved onto the current profile
42 EAPI Eina_Bool elm_config_save(void);
45 * Reload Elementary's configuration, bounded to current selected
49 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
51 * @return @c EINA_TRUE, when successful. @c EINA_FALSE, otherwise.
52 >>>>>>> remotes/origin/upstream
55 * Useful when you want to force reloading of configuration values for
56 * a profile. If one removes user custom configuration directories,
57 * for example, it will force a reload with system values instead.
60 EAPI void elm_config_reload(void);
65 * Flush all config settings then apply those settings to all applications
66 * using elementary on the current display.
70 EAPI void elm_config_all_flush(void);
73 >>>>>>> remotes/origin/upstream
78 * @defgroup Profile Elementary Profile
80 * Profiles are pre-set options that affect the whole look-and-feel of
81 * Elementary-based applications. There are, for example, profiles
82 * aimed at desktop computer applications and others aimed at mobile,
83 * touchscreen-based ones. You most probably don't want to use the
85 * functions in this group unlees you're writing an elementary
87 * functions in this group unless you're writing an elementary
88 >>>>>>> remotes/origin/upstream
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
104 EAPI const char *elm_profile_current_get(void);
107 * Get an Elementary's profile directory path in the filesystem. One
108 * may want to fetch a system profile's dir or an user one (fetched
111 * @param profile The profile's name
112 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
114 EAPI const char *elm_config_profile_get(void);
117 * Get an Elementary's profile directory path in the filesystem. One
118 * may want to fetch a system profile's dir or a user one (fetched
121 * @param profile The profile's name
122 * @param is_user Whether to lookup for a user profile (@c EINA_TRUE)
123 >>>>>>> remotes/origin/upstream
124 * or a system one (@c EINA_FALSE)
125 * @return The profile's directory path.
129 * @note You must free it with elm_profile_dir_free().
131 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
134 * Free an Elementary's profile directory path, as returned by
135 * elm_profile_dir_get().
137 * @note You must free it with elm_config_profile_dir_free().
139 EAPI const char *elm_config_profile_dir_get(const char *profile, Eina_Bool is_user);
142 * Free an Elementary's profile directory path, as returned by
143 * elm_config_profile_dir_get().
144 >>>>>>> remotes/origin/upstream
146 * @param p_dir The profile's path
151 EAPI void elm_profile_dir_free(const char *p_dir);
153 EAPI void elm_config_profile_dir_free(const char *p_dir);
154 >>>>>>> remotes/origin/upstream
157 * Get Elementary's list of available profiles.
159 * @return The profiles list. List node data are the profile name
163 * @note One must free this list, after usage, with the function
165 * elm_profile_list_free().
167 EAPI Eina_List *elm_profile_list_get(void);
169 * elm_config_profile_list_free().
171 EAPI Eina_List *elm_config_profile_list_get(void);
172 >>>>>>> remotes/origin/upstream
175 * Free Elementary's list of available profiles.
178 * @param l The profiles list, as returned by elm_profile_list_get().
182 EAPI void elm_profile_list_free(Eina_List *l);
184 * @param l The profiles list, as returned by elm_config_profile_list_get().
188 EAPI void elm_config_profile_list_free(Eina_List *l);
189 >>>>>>> remotes/origin/upstream
192 * Set Elementary's profile.
194 * This sets the global profile that is applied to Elementary
195 * applications. Just the process the call comes from will be
198 * @param profile The profile's name
203 EAPI void elm_profile_set(const char *profile);
206 * Set Elementary's profile.
208 * This sets the global profile that is applied to all Elementary
209 * applications. All running Elementary windows will be affected.
211 * @param profile The profile's name
215 EAPI void elm_profile_all_set(const char *profile);
217 EAPI void elm_config_profile_set(const char *profile);
218 >>>>>>> remotes/origin/upstream
225 * @defgroup Scrolling Scrolling
227 * These are functions setting how scrollable views in Elementary
228 * widgets should behave on user interaction.
234 * Get whether scrollers should bounce when they reach their
235 * viewport's edge during a scroll.
237 * @return the thumb scroll bouncing state
239 * This is the default behavior for touch screens, in general.
243 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
245 EAPI Eina_Bool elm_config_scroll_bounce_enabled_get(void);
246 >>>>>>> remotes/origin/upstream
249 * Set whether scrollers should bounce when they reach their
250 * viewport's edge during a scroll.
252 * @param enabled the thumb scroll bouncing state
255 * @see elm_thumbscroll_bounce_enabled_get()
258 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
261 * Set whether scrollers should bounce when they reach their
262 * viewport's edge during a scroll, for all Elementary application
265 * @param enabled the thumb scroll bouncing state
267 * @see elm_thumbscroll_bounce_enabled_get()
270 // XXX: deprecate and replace with elm_config_all_flush()
271 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
273 * @see elm_config_scroll_bounce_enabled_get()
276 EAPI void elm_config_scroll_bounce_enabled_set(Eina_Bool enabled);
277 >>>>>>> remotes/origin/upstream
280 * Get the amount of inertia a scroller will impose at bounce
283 * @return the thumb scroll bounce friction
288 EAPI double elm_scroll_bounce_friction_get(void);
290 EAPI double elm_config_scroll_bounce_friction_get(void);
291 >>>>>>> remotes/origin/upstream
294 * Set the amount of inertia a scroller will impose at bounce
297 * @param friction the thumb scroll bounce friction
300 * @see elm_thumbscroll_bounce_friction_get()
303 EAPI void elm_scroll_bounce_friction_set(double friction);
306 * Set the amount of inertia a scroller will impose at bounce
307 * animations, for all Elementary application windows.
309 * @param friction the thumb scroll bounce friction
311 * @see elm_thumbscroll_bounce_friction_get()
314 // XXX: deprecate and replace with elm_config_all_flush()
315 EAPI void elm_scroll_bounce_friction_all_set(double friction);
317 * @see elm_config_scroll_bounce_friction_get()
320 EAPI void elm_config_scroll_bounce_friction_set(double friction);
321 >>>>>>> remotes/origin/upstream
324 * Get the amount of inertia a <b>paged</b> scroller will impose at
325 * page fitting animations.
327 * @return the page scroll friction
332 EAPI double elm_scroll_page_scroll_friction_get(void);
334 EAPI double elm_config_scroll_page_scroll_friction_get(void);
335 >>>>>>> remotes/origin/upstream
338 * Set the amount of inertia a <b>paged</b> scroller will impose at
339 * page fitting animations.
341 * @param friction the page scroll friction
344 * @see elm_thumbscroll_page_scroll_friction_get()
347 EAPI void elm_scroll_page_scroll_friction_set(double friction);
350 * Set the amount of inertia a <b>paged</b> scroller will impose at
351 * page fitting animations, for all Elementary application windows.
353 * @param friction the page scroll friction
355 * @see elm_thumbscroll_page_scroll_friction_get()
358 // XXX: deprecate and replace with elm_config_all_flush()
359 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
361 * @see elm_config_scroll_page_scroll_friction_get()
364 EAPI void elm_config_scroll_page_scroll_friction_set(double friction);
365 >>>>>>> remotes/origin/upstream
368 * Get the amount of inertia a scroller will impose at region bring
371 * @return the bring in scroll friction
376 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
378 EAPI double elm_config_scroll_bring_in_scroll_friction_get(void);
379 >>>>>>> remotes/origin/upstream
382 * Set the amount of inertia a scroller will impose at region bring
385 * @param friction the bring in scroll friction
388 * @see elm_thumbscroll_bring_in_scroll_friction_get()
391 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
394 * Set the amount of inertia a scroller will impose at region bring
395 * animations, for all Elementary application windows.
397 * @param friction the bring in scroll friction
399 * @see elm_thumbscroll_bring_in_scroll_friction_get()
402 // XXX: deprecate and replace with elm_config_all_flush()
403 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
405 * @see elm_config_scroll_bring_in_scroll_friction_get()
408 EAPI void elm_config_scroll_bring_in_scroll_friction_set(double friction);
409 >>>>>>> remotes/origin/upstream
412 * Get the amount of inertia scrollers will impose at animations
413 * triggered by Elementary widgets' zooming API.
415 * @return the zoom friction
420 EAPI double elm_scroll_zoom_friction_get(void);
422 EAPI double elm_config_scroll_zoom_friction_get(void);
423 >>>>>>> remotes/origin/upstream
426 * Set the amount of inertia scrollers will impose at animations
427 * triggered by Elementary widgets' zooming API.
429 * @param friction the zoom friction
432 * @see elm_thumbscroll_zoom_friction_get()
435 EAPI void elm_scroll_zoom_friction_set(double friction);
438 * Set the amount of inertia scrollers will impose at animations
439 * triggered by Elementary widgets' zooming API, for all Elementary
440 * application windows.
442 * @param friction the zoom friction
444 * @see elm_thumbscroll_zoom_friction_get()
447 // XXX: deprecate and replace with elm_config_all_flush()
448 EAPI void elm_scroll_zoom_friction_all_set(double friction);
450 * @see elm_config_scroll_zoom_friction_get()
453 EAPI void elm_config_scroll_zoom_friction_set(double friction);
454 >>>>>>> remotes/origin/upstream
457 * Get whether scrollers should be draggable from any point in their
460 * @return the thumb scroll state
462 * @note This is the default behavior for touch screens, in general.
463 * @note All other functions namespaced with "thumbscroll" will only
464 * have effect if this mode is enabled.
469 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
471 EAPI Eina_Bool elm_config_scroll_thumbscroll_enabled_get(void);
472 >>>>>>> remotes/origin/upstream
475 * Set whether scrollers should be draggable from any point in their
478 * @param enabled the thumb scroll state
481 * @see elm_thumbscroll_enabled_get()
484 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
487 * Set whether scrollers should be draggable from any point in their
488 * views, for all Elementary application windows.
490 * @param enabled the thumb scroll state
492 * @see elm_thumbscroll_enabled_get()
495 // XXX: deprecate and replace with elm_config_all_flush()
496 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
498 * @see elm_config_scroll_thumbscroll_enabled_get()
501 EAPI void elm_config_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
502 >>>>>>> remotes/origin/upstream
505 * Get the number of pixels one should travel while dragging a
506 * scroller's view to actually trigger scrolling.
509 * @return the thumb scroll threshould
511 * @return the thumb scroll threshold
512 >>>>>>> remotes/origin/upstream
514 * One would use higher values for touch screens, in general, because
515 * of their inherent imprecision.
519 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
521 EAPI unsigned int elm_config_scroll_thumbscroll_threshold_get(void);
522 >>>>>>> remotes/origin/upstream
525 * Set the number of pixels one should travel while dragging a
526 * scroller's view to actually trigger scrolling.
529 * @param threshold the thumb scroll threshould
531 * @see elm_thumbscroll_threshould_get()
534 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
537 * Set the number of pixels one should travel while dragging a
538 * scroller's view to actually trigger scrolling, for all Elementary
539 * application windows.
541 * @param threshold the thumb scroll threshould
543 * @see elm_thumbscroll_threshould_get()
546 // XXX: deprecate and replace with elm_config_all_flush()
547 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
549 * @param threshold the thumb scroll threshold
551 * @see elm_config_thumbscroll_threshold_get()
554 EAPI void elm_config_scroll_thumbscroll_threshold_set(unsigned int threshold);
555 >>>>>>> remotes/origin/upstream
558 * Get the minimum speed of mouse cursor movement which will trigger
559 * list self scrolling animation after a mouse up event
563 * @return the thumb scroll momentum threshould
567 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
569 * @return the thumb scroll momentum threshold
573 EAPI double elm_config_scroll_thumbscroll_momentum_threshold_get(void);
574 >>>>>>> remotes/origin/upstream
577 * Set the minimum speed of mouse cursor movement which will trigger
578 * list self scrolling animation after a mouse up event
582 * @param threshold the thumb scroll momentum threshould
584 * @see elm_thumbscroll_momentum_threshould_get()
587 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
590 * Set the minimum speed of mouse cursor movement which will trigger
591 * list self scrolling animation after a mouse up event
592 * (pixels/second), for all Elementary application windows.
594 * @param threshold the thumb scroll momentum threshould
596 * @see elm_thumbscroll_momentum_threshould_get()
599 // XXX: deprecate and replace with elm_config_all_flush()
600 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
602 * @param threshold the thumb scroll momentum threshold
604 * @see elm_config_thumbscroll_momentum_threshold_get()
607 EAPI void elm_config_scroll_thumbscroll_momentum_threshold_set(double threshold);
608 >>>>>>> remotes/origin/upstream
611 * Get the amount of inertia a scroller will impose at self scrolling
614 * @return the thumb scroll friction
619 EAPI double elm_scroll_thumbscroll_friction_get(void);
621 EAPI double elm_config_scroll_thumbscroll_friction_get(void);
622 >>>>>>> remotes/origin/upstream
625 * Set the amount of inertia a scroller will impose at self scrolling
628 * @param friction the thumb scroll friction
631 * @see elm_thumbscroll_friction_get()
634 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
637 * Set the amount of inertia a scroller will impose at self scrolling
638 * animations, for all Elementary application windows.
640 * @param friction the thumb scroll friction
642 * @see elm_thumbscroll_friction_get()
645 // XXX: deprecate and replace with elm_config_all_flush()
646 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
648 * @see elm_config_thumbscroll_friction_get()
651 EAPI void elm_config_scroll_thumbscroll_friction_set(double friction);
652 >>>>>>> remotes/origin/upstream
655 * Get the amount of lag between your actual mouse cursor dragging
656 * movement and a scroller's view movement itself, while pushing it
657 * into bounce state manually.
659 * @return the thumb scroll border friction
664 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
666 EAPI double elm_config_scroll_thumbscroll_border_friction_get(void);
667 >>>>>>> remotes/origin/upstream
670 * Set the amount of lag between your actual mouse cursor dragging
671 * movement and a scroller's view movement itself, while pushing it
672 * into bounce state manually.
674 * @param friction the thumb scroll border friction. @c 0.0 for
675 * perfect synchrony between two movements, @c 1.0 for maximum
679 * @see elm_thumbscroll_border_friction_get()
680 * @note parameter value will get bound to 0.0 - 1.0 interval, always
684 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
687 * Set the amount of lag between your actual mouse cursor dragging
688 * movement and a scroller's view movement itself, while pushing it
689 * into bounce state manually, for all Elementary application windows.
691 * @param friction the thumb scroll border friction. @c 0.0 for
692 * perfect synchrony between two movements, @c 1.0 for maximum
695 * @see elm_thumbscroll_border_friction_get()
697 * @see elm_config_thumbscroll_border_friction_get()
698 >>>>>>> remotes/origin/upstream
699 * @note parameter value will get bound to 0.0 - 1.0 interval, always
704 // XXX: deprecate and replace with elm_config_all_flush()
705 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
707 EAPI void elm_config_scroll_thumbscroll_border_friction_set(double friction);
708 >>>>>>> remotes/origin/upstream
711 * Get the sensitivity amount which is be multiplied by the length of
714 * @return the thumb scroll sensitivity friction
719 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
721 EAPI double elm_config_scroll_thumbscroll_sensitivity_friction_get(void);
722 >>>>>>> remotes/origin/upstream
725 * Set the sensitivity amount which is be multiplied by the length of
728 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
730 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
733 * @see elm_thumbscroll_sensitivity_friction_get()
735 * minimum sensitivity, @c 1.0 for maximum sensitivity. 0.25
738 * @see elm_config_thumbscroll_sensitivity_friction_get()
739 >>>>>>> remotes/origin/upstream
740 * @note parameter value will get bound to 0.1 - 1.0 interval, always
745 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
748 * Set the sensitivity amount which is be multiplied by the length of
749 * mouse dragging, for all Elementary application windows.
751 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
752 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
755 * @see elm_thumbscroll_sensitivity_friction_get()
756 * @note parameter value will get bound to 0.1 - 1.0 interval, always
760 // XXX: deprecate and replace with elm_config_all_flush()
761 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
763 EAPI void elm_config_scroll_thumbscroll_sensitivity_friction_set(double friction);
770 * Get the duration for occurring long press event.
772 * @return Timeout for long press event
775 EAPI double elm_config_longpress_timeout_get(void);
778 * Set the duration for occurring long press event.
780 * @param lonpress_timeout Timeout for long press event
783 EAPI void elm_config_longpress_timeout_set(double longpress_timeout);
786 * Get the duration after which tooltip will be shown.
788 * @return Duration after which tooltip will be shown.
790 EAPI double elm_config_tooltip_delay_get(void);
793 * Set the duration after which tooltip will be shown.
795 * @return EINA_TRUE if value is set.
797 EAPI void elm_config_tooltip_delay_set(double delay);
800 * Get the configured cursor engine only usage
802 * This gets the globally configured exclusive usage of engine cursors.
804 * @return 1 if only engine cursors should be used
807 EAPI Eina_Bool elm_config_cursor_engine_only_get(void);
810 * Set the configured cursor engine only usage
812 * This sets the globally configured exclusive usage of engine cursors.
813 * It won't affect cursors set before changing this value.
815 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
816 * look for them on theme before.
819 EAPI void elm_config_cursor_engine_only_set(Eina_Bool engine_only);
822 * Get the global scaling factor
824 * This gets the globally configured scaling factor that is applied to all
827 * @return The scaling factor
830 EAPI double elm_config_scale_get(void);
833 * Set the global scaling factor
835 * This sets the globally configured scaling factor that is applied to all
838 * @param scale The scaling factor to set
841 EAPI void elm_config_scale_set(double scale);
844 * @defgroup Password_last_show Password show last
846 * Show last feature of password mode enables user to view
847 * the last input entered for few seconds before masking it.
848 * These functions allow to set this feature in password mode
849 * of entry widget and also allow to manipulate the duration
850 * for which the input has to be visible.
856 * Get the "show last" setting of password mode.
858 * This gets the "show last" setting of password mode which might be
859 * enabled or disabled.
861 * @return @c EINA_TRUE, if the "show last" setting is enabled,
862 * @c EINA_FALSE if it's disabled.
864 * @ingroup Password_last_show
866 EAPI Eina_Bool elm_config_password_show_last_get(void);
869 * Set show last setting in password mode.
871 * This enables or disables show last setting of password mode.
873 * @param password_show_last If EINA_TRUE enables "show last" in password mode.
874 * @see elm_config_password_show_last_timeout_set()
875 * @ingroup Password_last_show
877 EAPI void elm_config_password_show_last_set(Eina_Bool password_show_last);
880 * Gets the timeout value in "show last" password mode.
882 * This gets the time out value for which the last input entered in password
883 * mode will be visible.
885 * @return The timeout value of "show last" password mode.
886 * @ingroup Password_last_show
888 EAPI double elm_config_password_show_last_timeout_get(void);
891 * Set's the timeout value in "show last" password mode.
893 * This sets the time out value for which the last input entered in password
894 * mode will be visible.
896 * @param password_show_last_timeout The timeout value.
897 * @see elm_config_password_show_last_set()
898 * @ingroup Password_last_show
900 EAPI void elm_config_password_show_last_timeout_set(double password_show_last_timeout);
901 >>>>>>> remotes/origin/upstream
909 * Get the duration for occuring long press event.
911 * @return Timeout for long press event
914 EAPI double elm_longpress_timeout_get(void);
917 * Set the duration for occuring long press event.
919 * @param lonpress_timeout Timeout for long press event
922 EAPI void elm_longpress_timeout_set(double longpress_timeout);
924 * @defgroup Engine Elementary Engine
926 * These are functions setting and querying which rendering engine
927 * Elementary will use for drawing its windows' pixels.
929 * The following are the available engines:
933 * @li "software_16_x11"
934 * @li "software_8_x11"
938 * @li "software_16_wince_gdi"
940 * @li "software_16_sdl"
951 * @brief Get Elementary's rendering engine in use.
953 * @return The rendering engine's name
954 * @note there's no need to free the returned string, here.
956 * This gets the global rendering engine that is applied to all Elementary
959 * @see elm_config_engine_set()
961 EAPI const char *elm_config_engine_get(void);
964 * @brief Set Elementary's rendering engine for use.
966 * @param engine The rendering engine's name
968 * Note that it will take effect only to Elementary windows created after
973 EAPI void elm_config_engine_set(const char *engine);
976 * @brief Get Elementary's preferred engine to use.
978 * @return The rendering engine's name
979 * @note there's no need to free the returned string, here.
981 * This gets the global rendering engine that is applied to all Elementary
982 * applications and is PREFERRED by the application. This can (and will)
983 * override the engine configured for all applications which.
985 * @see elm_config_preferred_engine_set()
987 EAPI const char *elm_config_preferred_engine_get(void);
990 * @brief Set Elementary's preferred rendering engine for use.
992 * @param engine The rendering engine's name
994 * Note that it will take effect only to Elementary windows created after
995 * this is called. This overrides the engine set by configuration at
996 * application startup. Note that it is a hint and may not be honored.
1000 EAPI void elm_config_preferred_engine_set(const char *engine);
1002 typedef struct _Elm_Text_Class
1008 typedef struct _Elm_Font_Overlay
1010 const char *text_class;
1012 Evas_Font_Size size;
1016 * Get Elementary's list of supported text classes.
1018 * @return The text classes list, with @c Elm_Text_Class blobs as data.
1021 * Release the list with elm_text_classes_list_free().
1023 EAPI Eina_List *elm_config_text_classes_list_get(void);
1026 * Free Elementary's list of supported text classes.
1030 * @see elm_config_text_classes_list_get().
1032 EAPI void elm_config_text_classes_list_free(Eina_List *list);
1035 * Get Elementary's list of font overlays, set with
1036 * elm_config_font_overlay_set().
1038 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1043 * For each text class, one can set a <b>font overlay</b> for it,
1044 * overriding the default font properties for that class coming from
1045 * the theme in use. There is no need to free this list.
1047 * @see elm_config_font_overlay_set() and elm_config_font_overlay_unset().
1049 EAPI const Eina_List *elm_config_font_overlay_list_get(void);
1052 * Set a font overlay for a given Elementary text class.
1054 * @param text_class Text class name
1055 * @param font Font name and style string
1056 * @param size Font size
1060 * @p font has to be in the format returned by
1061 * elm_font_fontconfig_name_get(). @see elm_config_font_overlay_list_get()
1062 * and elm_config_font_overlay_unset().
1064 EAPI void elm_config_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1067 * Unset a font overlay for a given Elementary text class.
1069 * @param text_class Text class name
1073 * This will bring back text elements belonging to text class
1074 * @p text_class back to their default font settings.
1076 EAPI void elm_config_font_overlay_unset(const char *text_class);
1079 * Apply the changes made with elm_config_font_overlay_set() and
1080 * elm_config_font_overlay_unset() on the current Elementary window.
1084 * This applies all font overlays set to all objects in the UI.
1086 EAPI void elm_config_font_overlay_apply(void);
1089 * Get the configured "finger size"
1091 * @return The finger size
1093 * This gets the globally configured finger size, <b>in pixels</b>
1097 EAPI Evas_Coord elm_config_finger_size_get(void);
1100 * Set the configured finger size
1102 * This sets the globally configured finger size in pixels
1104 * @param size The finger size
1107 EAPI void elm_config_finger_size_set(Evas_Coord size);
1111 * Get the configured cache flush interval time
1113 * This gets the globally configured cache flush interval time, in
1116 * @return The cache flush interval time
1119 * @see elm_cache_all_flush()
1121 EAPI int elm_config_cache_flush_interval_get(void);
1124 * Set the configured cache flush interval time
1126 * This sets the globally configured cache flush interval time, in ticks
1128 * @param size The cache flush interval time
1131 * @see elm_cache_all_flush()
1133 EAPI void elm_config_cache_flush_interval_set(int size);
1136 * Get the configured cache flush enabled state
1138 * This gets the globally configured cache flush state - if it is enabled
1139 * or not. When cache flushing is enabled, elementary will regularly
1140 * (see elm_config_cache_flush_interval_get() ) flush caches and dump data out of
1141 * memory and allow usage to re-seed caches and data in memory where it
1142 * can do so. An idle application will thus minimize its memory usage as
1143 * data will be freed from memory and not be re-loaded as it is idle and
1144 * not rendering or doing anything graphically right now.
1146 * @return The cache flush state
1149 * @see elm_cache_all_flush()
1151 EAPI Eina_Bool elm_config_cache_flush_enabled_get(void);
1154 * Set the configured cache flush enabled state
1156 * This sets the globally configured cache flush enabled state.
1158 * @param enabled The cache flush enabled state
1161 * @see elm_cache_all_flush()
1163 EAPI void elm_config_cache_flush_enabled_set(Eina_Bool enabled);
1166 * Get the configured font cache size
1168 * This gets the globally configured font cache size, in bytes.
1170 * @return The font cache size
1173 EAPI int elm_config_cache_font_cache_size_get(void);
1176 * Set the configured font cache size
1178 * This sets the globally configured font cache size, in bytes
1180 * @param size The font cache size
1183 EAPI void elm_config_cache_font_cache_size_set(int size);
1186 * Get the configured image cache size
1188 * This gets the globally configured image cache size, in bytes
1190 * @return The image cache size
1193 EAPI int elm_config_cache_image_cache_size_get(void);
1196 * Set the configured image cache size
1198 * This sets the globally configured image cache size, in bytes
1200 * @param size The image cache size
1203 EAPI void elm_config_cache_image_cache_size_set(int size);
1207 * Get the configured edje file cache size.
1209 * This gets the globally configured edje file cache size, in number
1212 * @return The edje file cache size
1215 EAPI int elm_config_cache_edje_file_cache_size_get(void);
1218 * Set the configured edje file cache size
1220 * This sets the globally configured edje file cache size, in number
1223 * @param size The edje file cache size
1226 EAPI void elm_config_cache_edje_file_cache_size_set(int size);
1229 * Get the configured edje collections (groups) cache size.
1231 * This gets the globally configured edje collections cache size, in
1232 * number of collections.
1234 * @return The edje collections cache size
1237 EAPI int elm_config_cache_edje_collection_cache_size_get(void);
1240 * Set the configured edje collections (groups) cache size
1242 * This sets the globally configured edje collections cache size, in
1243 * number of collections.
1245 * @param size The edje collections cache size
1248 EAPI void elm_config_cache_edje_collection_cache_size_set(int size);
1251 * Get the enable status of the focus highlight
1253 * This gets whether the highlight on focused objects is enabled or not
1255 * @see elm_config_focus_highlight_enabled_set()
1258 EAPI Eina_Bool elm_config_focus_highlight_enabled_get(void);
1261 * Set the enable status of the focus highlight
1263 * @param enable Enable highlight if EINA_TRUE, disable otherwise
1265 * Set whether to show or not the highlight on focused objects
1267 * Note that it will take effect only to Elementary windows created after
1270 * @see elm_win_add()
1274 EAPI void elm_config_focus_highlight_enabled_set(Eina_Bool enable);
1277 * Get the enable status of the highlight animation
1279 * @return The focus highlight mode set
1281 * Get whether the focus highlight, if enabled, will animate its switch from
1282 * one object to the next
1286 EAPI Eina_Bool elm_config_focus_highlight_animate_get(void);
1289 * Set the enable status of the highlight animation
1291 * @param animate Enable animation if EINA_TRUE, disable otherwise
1293 * Set whether the focus highlight, if enabled, will animate its switch from
1294 * one object to the next
1296 * Note that it will take effect only to Elementary windows created after
1299 * @see elm_win_add()
1303 EAPI void elm_config_focus_highlight_animate_set(Eina_Bool animate);
1306 * Get the system mirrored mode. This determines the default mirrored mode
1309 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1311 EAPI Eina_Bool elm_config_mirrored_get(void);
1314 * Set the system mirrored mode. This determines the default mirrored mode
1317 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1319 EAPI void elm_config_mirrored_set(Eina_Bool mirrored);
1325 >>>>>>> remotes/origin/upstream