configuration Module¶
Description¶
Elementary configuration is formed by a set options bounded to a given profile, like theme, “finger size”, etc.
These are functions with which one synchronizes changes made to those values to the configuration storing files, de facto. You most probably don’t want to use the functions in this group unless you’re writing an elementary configuration manager.
Profiles¶
Profiles are pre-set options that affect the whole look-and-feel of Elementary-based applications. There are, for example, profiles aimed at desktop computer applications and others aimed at mobile, touchscreen-based ones. You most probably don’t want to use the functions in this group unless you’re writing an elementary configuration manager.
Elementary Scrolling¶
These set how scrollable views in Elementary widgets should behave on user interaction.
Password show last¶
Show last feature of password mode enables user to view the last input entered for few seconds before masking it. These functions allow to set this feature in password mode of entry widget and also allow to manipulate the duration for which the input has to be visible.
Elementary Engine¶
These are functions setting and querying which rendering engine Elementary will use for drawing its windows’ pixels.
The following are the available engines:
- “software_x11”
- “fb”
- “directfb”
- “software_16_x11”
- “software_8_x11”
- “xrender_x11”
- “opengl_x11”
- “software_gdi”
- “software_16_wince_gdi”
- “sdl”
- “software_16_sdl”
- “opengl_sdl”
- “buffer”
- “ews”
- “opengl_cocoa”
- “psl1ght”
Enumerations¶
Elm_Softcursor_Mode¶
- efl.elementary.configuration.ELM_SOFTCURSOR_MODE_AUTO¶
Auto-detect if a software cursor should be used (default)
- efl.elementary.configuration.ELM_SOFTCURSOR_MODE_ON¶
Always use a softcursor
- efl.elementary.configuration.ELM_SOFTCURSOR_MODE_OFF¶
Never use a softcursor
- class efl.elementary.configuration.Configuration¶
Bases: object
The configuration class
- all_flush()¶
Flush all config settings then apply those settings to all applications using elementary on the current display.
- cache_edje_collection_cache_size¶
The globally configured edje collections cache size, in number of collections.
Type : int
- cache_edje_file_cache_size¶
The globally configured edje file cache size, in number of files.
Type : int
- cache_flush_enabled¶
The configured cache flush enabled state
This property reflects the globally configured cache flush state - if it is enabled or not. When cache flushing is enabled, elementary will regularly (see cache_flush_interval) flush caches and dump data out of memory and allow usage to re-seed caches and data in memory where it can do so. An idle application will thus minimize its memory usage as data will be freed from memory and not be re-loaded as it is idle and not rendering or doing anything graphically right now.
Type : bool
- cache_flush_interval¶
The globally configured cache flush interval time, in ticks
Note
The size must be greater than 0. if not, the cache flush will be ignored.
Type : int
- cache_font_cache_size¶
The globally configured font cache size, in bytes.
Type : int
- cache_image_cache_size¶
The globally configured image cache size, in bytes
Type : int
- clouseau_enabled¶
Clouseau state. True if clouseau was tried to be run.
Returns: True if clouseau was tried to run, False otherwise New in version 1.8.
- cursor_engine_only¶
The globally configured exclusive usage of engine cursors.
If True only engine cursors will be enabled, if False will look for them on theme before.
Type : bool
- engine¶
Elementary’s rendering engine in use.
This gets the global rendering engine that is applied to all Elementary applications.
Note that it will take effect only to Elementary windows created after this is set.
Type : string
- finger_size¶
The configured “finger size”
This gets the globally configured finger size, in pixels
Type : int
- focus_highlight_animate¶
Whether the focus highlight, if enabled, will animate its switch from one object to the next
Note that it will take effect only to Elementary windows created after this is set.
See also
Type : bool
- focus_highlight_enabled¶
Whether the highlight on focused objects is enabled or not
Note that it will take effect only to Elementary windows created after this is set.
Type : bool
- font_overlay_apply()¶
Apply the changes made with font_overlay_set() and font_overlay_unset() on the current Elementary window.
This applies all font overlays set to all objects in the UI.
- font_overlay_list¶
Get Elementary’s list of font overlays, set with font_overlay_set().
For each text class, one can set a font overlay for it, overriding the default font properties for that class coming from the theme in use. There is no need to free this list.
Type : list of Elm_Font_Overlay
- font_overlay_set(unicode text_class, unicode font, int size)¶
Set a font overlay for a given Elementary text class.
font has to be in the format returned by efl.elementary.general.font_fontconfig_name_get().
Parameters: - text_class (string) – Text class name
- font (string) – Font name and style string
- size (Evas_Font_Size) – Font size
- font_overlay_unset(unicode text_class)¶
Unset a font overlay for a given Elementary text class.
This will bring back text elements belonging to text class text_class back to their default font settings.
Parameters: text_class (string) – Text class name
- glayer_double_tap_timeout¶
Get the duration for occurring double tap event of gesture layer.
Returns: Timeout for double tap event of gesture layer. New in version 1.8.
- glayer_long_tap_start_timeout¶
The duration for occurring long tap event of gesture layer.
Type : float New in version 1.8.
- indicator_service_get(int rotation) → unicode¶
Get the indicator service name according to the rotation degree.
Parameters: rotation – The rotation which is related with the indicator service name, in degrees (0-360), Returns: The indicator service name according to the rotation degree. New in version 1.8.
- longpress_timeout¶
The duration for occurring long press event.
Type : float
- mirrored¶
Get the system mirrored mode. This determines the default mirrored mode of widgets.
type: bool
- password_show_last¶
The “show last” setting of password mode.
Type : bool
- password_show_last_timeout¶
The timeout value for which the last input entered in password mode will be visible.
Type : float
- preferred_engine¶
Get Elementary’s preferred engine to use.
This gets the global rendering engine that is applied to all Elementary applications and is PREFERRED by the application.
Note that it will take effect only to Elementary windows created after this is called. This overrides the engine set by configuration at application startup. Note that it is a hint and may not be honored.
Type : string
- profile¶
Elementary’s profile in use.
The global profile that is applied to all Elementary applications.
Type : string
- profile_dir_get(unicode profile, bool is_user)¶
Get an Elementary’s profile directory path in the filesystem. One may want to fetch a system profile’s dir or a user one (fetched inside $HOME).
Parameters: - profile (unicode) – The profile’s name
- is_user (bool) – Whether to lookup for a user profile (True) or a system one (False)
Returns: The profile’s directory path.
Return type: string
- profile_list¶
Get Elementary’s list of available profiles.
Type : tuple of strings
- reload()¶
Reload Elementary’s configuration, bounded to current selected profile.
Useful when you want to force reloading of configuration values for a profile. If one removes user custom configuration directories, for example, it will force a reload with system values instead.
Returns: True, when successful. False, otherwise. Return type: bool
- save()¶
Save back Elementary’s configuration, so that it will persist on future sessions.
This function will take effect – thus, do I/O – immediately. Use it when you want to save all configuration changes at once. The current configuration set will get saved onto the current profile configuration file.
Returns: True, when successful. False, otherwise. Return type: bool
- scale¶
The global scaling factor
This gets the globally configured scaling factor that is applied to all objects.
Type : float
- scroll_bounce_enabled¶
Whether scrollers should bounce when they reach their viewport’s edge during a scroll.
Type : bool
- scroll_bounce_friction¶
The amount of inertia a scroller will impose at bounce animations.
Type : float
- scroll_bring_in_scroll_friction¶
The amount of inertia a scroller will impose at region bring animations.
Type : float
- scroll_page_scroll_friction¶
The amount of inertia a paged scroller will impose at page fitting animations.
Type : float
- scroll_thumbscroll_acceleration_threshold¶
The minimum speed of mouse cursor movement which will accelerate scrolling velocity after a mouse up event (pixels/second).
Type : float New in version 1.8.
- scroll_thumbscroll_acceleration_time_limit¶
The time limit for accelerating velocity.
Type : float New in version 1.8.
- scroll_thumbscroll_acceleration_weight¶
The weight for the acceleration.
Type : float New in version 1.8.
- scroll_thumbscroll_border_friction¶
The amount of lag between your actual mouse cursor dragging movement and a scroller’s view movement itself, while pushing it into bounce state manually.
Note
parameter value will get bound to 0.0 - 1.0 interval, always
Type : float New in version 1.8.
- scroll_thumbscroll_enabled¶
Whether scrollers should be draggable from any point in their views.
Note
This is the default behavior for touch screens, in general.
Note
All other functions namespaced with “thumbscroll” will only have effect if this mode is enabled.
Type : bool
- scroll_thumbscroll_flick_distance_tolerance¶
The number of pixels the maximum distance which can be flicked. If it is flicked more than this, the flick distance is same with maximum distance.
Type : int New in version 1.8.
- scroll_thumbscroll_friction¶
The amount of inertia a scroller will impose at self scrolling animations.
Type : float
- scroll_thumbscroll_friction_standard¶
The standard velocity of the scroller. The scroll animation time is same with thumbscroll friction, if the velocity is same with standard velocity.
Type : float
- scroll_thumbscroll_hold_threshold¶
The number of pixels the range which can be scrolled, while the scroller is holded.
Type : int New in version 1.8.
- scroll_thumbscroll_min_friction¶
The min amount of inertia a scroller will impose at self scrolling animations.
Type : float New in version 1.8.
- scroll_thumbscroll_momentum_threshold¶
The minimum speed of mouse cursor movement which will trigger list self scrolling animation after a mouse up event (pixels/second).
Type : float
- scroll_thumbscroll_sensitivity_friction¶
The sensitivity amount which is be multiplied by the length of mouse dragging.
0.1 for minimum sensitivity, 1.0 for maximum sensitivity. 0.25 is proper.
Type : float
- scroll_thumbscroll_threshold¶
The number of pixels one should travel while dragging a scroller’s view to actually trigger scrolling.
One would use higher values for touch screens, in general, because of their inherent imprecision.
Type : int
- scroll_zoom_friction¶
The amount of inertia scrollers will impose at animations triggered by Elementary widgets’ zooming API.
Type : float
- selection_unfocused_clear¶
Whether selection should be cleared when entry widget is unfocused.
Type : bool New in version 1.8.
- softcursor_mode¶
The mode used for software provided mouse cursors inline in the window canvas.
A software rendered cursor can be provided for rendering inline inside the canvas windows in the event the native display system does not provide one or the native oneis not wanted.
Type : Elm_Softcursor_Mode New in version 1.8.
- text_classes_list¶
Get Elementary’s list of supported text classes.
Type : list of Elm_Text_Class
- tooltip_delay¶
The duration after which tooltip will be shown.
Type : float