summaryrefslogtreecommitdiff
path: root/doc/elementary/configuration.rst
blob: 8dbd278a61a78ad8d62d7ba385f250e385d0c24e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
.. currentmodule:: efl.elementary

Configuration
#############

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"


ATSPI AT-SPI2 Accessibility
===========================

Elementary widgets support Linux Accessibility standard. For more
information please visit:
http://www.linuxfoundation.org/collaborate/workgroups/accessibility/atk/at-spi/at-spi_on_d-bus


Enumerations
============

.. _Elm_Softcursor_Mode:

Elm_Softcursor_Mode
-------------------

.. data:: ELM_SOFTCURSOR_MODE_AUTO

    Auto-detect if a software cursor should be used (default)

.. data:: ELM_SOFTCURSOR_MODE_ON

    Always use a softcursor

.. data:: ELM_SOFTCURSOR_MODE_OFF

    Never use a softcursor


.. _Elm_Slider_Indicator_Visible_Mode:

Elm_Slider_Indicator_Visible_Mode
---------------------------------

.. data:: ELM_SLIDER_INDICATOR_VISIBLE_MODE_DEFAULT

    show indicator on mouse down or change in slider value

.. data:: ELM_SLIDER_INDICATOR_VISIBLE_MODE_ALWAYS

    Always show the indicator

.. data:: ELM_SLIDER_INDICATOR_VISIBLE_MODE_ON_FOCUS

    Show the indicator on focus

.. data:: ELM_SLIDER_INDICATOR_VISIBLE_MODE_NONE

    Never show the indicator


.. _Edje_Channel:

Audio Channels
--------------

.. data:: EDJE_CHANNEL_EFFECT

    Standard audio effects

.. data:: EDJE_CHANNEL_BACKGROUND

    Background audio sounds

.. data:: EDJE_CHANNEL_MUSIC

    Music audio

.. data:: EDJE_CHANNEL_FOREGROUND

    Foreground audio sounds

.. data:: EDJE_CHANNEL_INTERFACE

    Sounds related to the interface

.. data:: EDJE_CHANNEL_INPUT

    Sounds related to regular input

.. data:: EDJE_CHANNEL_ALERT

    Sounds for major alerts

.. data:: EDJE_CHANNEL_ALL

    All audio channels (convenience)


Inheritance diagram
===================

.. inheritance-diagram:: Configuration
    :parts: 2

.. autoclass:: Configuration