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
|
<?xml version="1.0"?>
<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<node xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
<interface name="org.kde.ScreenBrightness">
<!--
global
-->
<property name="DisplaysDBusNames" type="as" access="read">
<doc:doc>
<doc:summary>A list of D-Bus names for each display with brightness controls available.</doc:summary>
<doc:para>Per-display methods take a display name as parameter. Child objects of type "org.kde.ScreenBrightness.Display" are available at the object path "/org/kde/ScreenBrightness/[name]", with [name] being any of the elements of this list.</doc:para>
</doc:doc>
</property>
<signal name="DisplayAdded">
<arg name="display_dbus_name" type="s">
<doc:doc>
<doc:summary>The display whose brightness controls became newly available.</doc:summary>
</doc:doc>
</arg>
</signal>
<signal name="DisplayRemoved">
<arg name="display_dbus_name" type="s">
<doc:doc>
<doc:summary>The display whose brightness controls became unavailable.</doc:summary>
</doc:doc>
</arg>
</signal>
<method name="AdjustBrightnessRatio">
<doc:doc>
<doc:summary>Adjust display brightness for a predetermined set of displays by a delta between -1.0 and 1.0.</doc:summary>
</doc:doc>
<arg name="delta" type="d" direction="in"/>
<arg name="flags" type="u" direction="in">
<doc:doc>
<doc:summary>Boolean options, combined in a single value with binary OR (pass 0 for default behavior).</doc:summary>
<doc:para>
<doc:list>
<doc:item>0x1: SuppressIndicator - don't show brightness change indicators such as OSD, notification, etc. ("silent mode").</doc:item>
</doc:list>
</doc:para>
</doc:doc>
</arg>
</method>
<method name="AdjustBrightnessRatioWithContext">
<doc:doc>
<doc:summary>Adjust display brightness for a predetermined set of displays by a delta between -1.0 and 1.0, with extra context passthrough.</doc:summary>
<doc:para>Arguments other than source_client_context are the same as in AdjustBrightnessRatio.</doc:para>
</doc:doc>
<arg name="delta" type="d" direction="in"/>
<arg name="flags" type="u" direction="in"/>
<arg name="source_client_context" type="s" direction="in">
<doc:doc>
<doc:summary>Will be passed through to any resulting BrightnessChanged signal.</doc:summary>
</doc:doc>
</arg>
</method>
<method name="AdjustBrightnessStep">
<doc:doc>
<doc:summary>Adjust display brightness for a predetermined set of displays by a step up or down the brightness scale.</doc:summary>
</doc:doc>
<arg name="step_action" type="u" direction="in">
<doc:doc>
<doc:summary>The direction and size of the step</doc:summary>
<doc:para>
<doc:item>0: Increase - raise brightness by a regular step.</doc:item>
<doc:item>1: Decrease - lower brightness by a regular step.</doc:item>
<doc:item>2: IncreaseSmall - raise brightness by a small step.</doc:item>
<doc:item>3: DecreaseSmall - lower brightness by a small step.</doc:item>
</doc:para>
</doc:doc>
</arg>
<arg name="flags" type="u" direction="in">
<doc:doc>
<doc:summary>Boolean options, combined in a single value with binary OR (pass 0 for default behavior).</doc:summary>
<doc:para>
<doc:list>
<doc:item>0x1: SuppressIndicator - don't show brightness change indicators such as OSD, notification, etc. ("silent mode").</doc:item>
</doc:list>
</doc:para>
</doc:doc>
</arg>
</method>
<method name="AdjustBrightnessStepWithContext">
<doc:doc>
<doc:summary>Adjust display brightness for a predetermined set of displays by a step up or down the brightness scale, with extra context passthrough.</doc:summary>
<doc:para>Arguments other than source_client_context are the same as in AdjustBrightnessStep.</doc:para>
</doc:doc>
<arg name="step_action" type="u" direction="in"/>
<arg name="flags" type="u" direction="in"/>
<arg name="source_client_context" type="s" direction="in">
<doc:doc>
<doc:summary>Will be passed through to any resulting BrightnessChanged signal.</doc:summary>
</doc:doc>
</arg>
</method>
<!--
per display (get properties & set brightness via org.kde.ScreenBrightness.Display children)
-->
<signal name="BrightnessChanged">
<arg name="display_dbus_name" type="s">
<doc:doc>
<doc:summary>The display for which a brightness change was performed or observed.</doc:summary>
</doc:doc>
</arg>
<arg name="brightness" type="i">
<doc:doc>
<doc:summary>The updated brightness value.</doc:summary>
<doc:para>Note that not all types of displays allow external brightness changes. The actual screen brightness may be a different one than the one that was last emitted by this signal.</doc:para>
</doc:doc>
</arg>
<arg name="source_client_name" type="s">
<doc:doc>
<doc:summary>The client (bus address) that requested the brightness change.</doc:summary>
</doc:doc>
</arg>
<arg name="source_client_context" type="s">
<doc:doc>
<doc:summary>The context string passed through from a brightness change method, or an empty string if no context was passed.</doc:summary>
</doc:doc>
</arg>
</signal>
<signal name="BrightnessRangeChanged">
<arg name="display_dbus_name" type="s">
<doc:doc>
<doc:summary>The display for which the brightness range changed.</doc:summary>
</doc:doc>
</arg>
<arg name="max_brightness" type="i">
<doc:doc>
<doc:summary>The updated maximum brightness value.</doc:summary>
</doc:doc>
</arg>
<arg name="brightness" type="i">
<doc:doc>
<doc:summary>The current brightness value within the updated scale from 0 to max_brightness.</doc:summary>
</doc:doc>
</arg>
</signal>
</interface>
</node>
|
