Codebase list xapp / 7db687e docs / reference / XAppMonitorBlanker.html
7db687e

Tree @7db687e (Download .tar.gz)

XAppMonitorBlanker.html @7db687e — raw · history · 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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>XAppMonitorBlanker: XApp Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="XApp Reference Manual">
<link rel="up" href="ch01.html" title="API reference">
<link rel="prev" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController">
<link rel="next" href="XAppPreferencesWindow.html" title="XAppPreferencesWindow">
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#XAppMonitorBlanker.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#XAppMonitorBlanker.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="XAppKbdLayoutController.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="XAppPreferencesWindow.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="XAppMonitorBlanker"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="XAppMonitorBlanker.top_of_page"></a>XAppMonitorBlanker</span></h2>
<p>XAppMonitorBlanker — Blank and unblank unused monitors</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="XAppMonitorBlanker.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="XAppMonitorBlanker.html" title="XAppMonitorBlanker"><span class="returnvalue">XAppMonitorBlanker</span></a> *
</td>
<td class="function_name">
<a class="link" href="XAppMonitorBlanker.html#xapp-monitor-blanker-new" title="xapp_monitor_blanker_new ()">xapp_monitor_blanker_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="XAppMonitorBlanker.html#xapp-monitor-blanker-blank-other-monitors" title="xapp_monitor_blanker_blank_other_monitors ()">xapp_monitor_blanker_blank_other_monitors</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="XAppMonitorBlanker.html#xapp-monitor-blanker-unblank-monitors" title="xapp_monitor_blanker_unblank_monitors ()">xapp_monitor_blanker_unblank_monitors</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="XAppMonitorBlanker.html#xapp-monitor-blanker-are-monitors-blanked" title="xapp_monitor_blanker_are_monitors_blanked ()">xapp_monitor_blanker_are_monitors_blanked</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="XAppMonitorBlanker.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="XAppMonitorBlanker.html#XAPP-TYPE-MONITOR-BLANKER:CAPS" title="XAPP_TYPE_MONITOR_BLANKER">XAPP_TYPE_MONITOR_BLANKER</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="XAppMonitorBlanker.html#XAppMonitorBlanker-struct" title="XAppMonitorBlanker">XAppMonitorBlanker</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="XAppMonitorBlanker.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> XAppMonitorBlanker
</pre>
</div>
<div class="refsect1">
<a name="XAppMonitorBlanker.description"></a><h2>Description</h2>
<p>The XAppMonitorBlanker widget that creates one or more
POPUP type GtkWindows that are used to blank unused
monitors in multiple monitor setups.</p>
</div>
<div class="refsect1">
<a name="XAppMonitorBlanker.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="xapp-monitor-blanker-new"></a><h3>xapp_monitor_blanker_new ()</h3>
<pre class="programlisting"><a class="link" href="XAppMonitorBlanker.html" title="XAppMonitorBlanker"><span class="returnvalue">XAppMonitorBlanker</span></a> *
xapp_monitor_blanker_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="XAppMonitorBlanker.html" title="XAppMonitorBlanker"><span class="type">XAppMonitorBlanker</span></a>.</p>
<div class="refsect3">
<a name="xapp-monitor-blanker-new.returns"></a><h4>Returns</h4>
<p> a newly created <a class="link" href="XAppMonitorBlanker.html" title="XAppMonitorBlanker"><span class="type">XAppMonitorBlanker</span></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xapp-monitor-blanker-blank-other-monitors"></a><h3>xapp_monitor_blanker_blank_other_monitors ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xapp_monitor_blanker_blank_other_monitors
                               (<em class="parameter"><code><a class="link" href="XAppMonitorBlanker.html" title="XAppMonitorBlanker"><span class="type">XAppMonitorBlanker</span></a> *self</code></em>,
                                <em class="parameter"><code><a href="../gtk3/GtkWindow.html#GtkWindow-struct"><span class="type">GtkWindow</span></a> *window</code></em>);</pre>
<p>Blanks monitors besides the one where the <em class="parameter"><code>window</code></em>
 is.</p>
<div class="refsect3">
<a name="xapp-monitor-blanker-blank-other-monitors.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="XAppMonitorBlanker.html" title="XAppMonitorBlanker"><span class="type">XAppMonitorBlanker</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>window</p></td>
<td class="parameter_description"><p>a <a href="../gtk3/GtkWindow.html#GtkWindow-struct"><span class="type">GtkWindow</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xapp-monitor-blanker-unblank-monitors"></a><h3>xapp_monitor_blanker_unblank_monitors ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xapp_monitor_blanker_unblank_monitors (<em class="parameter"><code><a class="link" href="XAppMonitorBlanker.html" title="XAppMonitorBlanker"><span class="type">XAppMonitorBlanker</span></a> *self</code></em>);</pre>
<p>Unblanks monitors that were blanked by
<a class="link" href="XAppMonitorBlanker.html#xapp-monitor-blanker-blank-other-monitors" title="xapp_monitor_blanker_blank_other_monitors ()"><code class="function">xapp_monitor_blanker_blank_other_monitors()</code></a>;</p>
<div class="refsect3">
<a name="xapp-monitor-blanker-unblank-monitors.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="XAppMonitorBlanker.html" title="XAppMonitorBlanker"><span class="type">XAppMonitorBlanker</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xapp-monitor-blanker-are-monitors-blanked"></a><h3>xapp_monitor_blanker_are_monitors_blanked ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
xapp_monitor_blanker_are_monitors_blanked
                               (<em class="parameter"><code><a class="link" href="XAppMonitorBlanker.html" title="XAppMonitorBlanker"><span class="type">XAppMonitorBlanker</span></a> *self</code></em>);</pre>
<p>Returns whether monitors are currently blanked.
See <a class="link" href="XAppMonitorBlanker.html#xapp-monitor-blanker-blank-other-monitors" title="xapp_monitor_blanker_blank_other_monitors ()"><code class="function">xapp_monitor_blanker_blank_other_monitors()</code></a>.</p>
<div class="refsect3">
<a name="xapp-monitor-blanker-are-monitors-blanked.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="XAppMonitorBlanker.html" title="XAppMonitorBlanker"><span class="type">XAppMonitorBlanker</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xapp-monitor-blanker-are-monitors-blanked.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if monitors are blanked.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="XAppMonitorBlanker.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="XAPP-TYPE-MONITOR-BLANKER:CAPS"></a><h3>XAPP_TYPE_MONITOR_BLANKER</h3>
<pre class="programlisting">#define XAPP_TYPE_MONITOR_BLANKER (xapp_monitor_blanker_get_type ())
</pre>
</div>
<hr>
<div class="refsect2">
<a name="XAppMonitorBlanker-struct"></a><h3>XAppMonitorBlanker</h3>
<pre class="programlisting">typedef struct _XAppMonitorBlanker XAppMonitorBlanker;</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>