libmutter-dev 3.10.4-0ubuntu2 / usr / share / gtk-doc / html / meta / MetaBarrier.html

This file is indexed.

/usr/share/gtk-doc/html/meta/MetaBarrier.html is in libmutter-dev 3.10.4-0ubuntu2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Mutter Reference Manual: MetaBarrier</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Mutter Reference Manual">
<link rel="up" href="core-reference.html" title="Part III. Mutter Core Reference">
<link rel="prev" href="MetaPlugin.html" title="MetaPlugin">
<link rel="next" href="MetaRectangle.html" title="MetaRectangle">
<meta name="generator" content="GTK-Doc V1.19.1 (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="10"><tr valign="middle">
<td width="100%" align="left">
<a href="#" class="shortcut">Top</a>
                   | 
                  <a href="#MetaBarrier.description" class="shortcut">Description</a>
                   | 
                  <a href="#MetaBarrier.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#MetaBarrier.properties" class="shortcut">Properties</a>
                   | 
                  <a href="#MetaBarrier.signals" class="shortcut">Signals</a>
</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="core-reference.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="MetaPlugin.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="MetaRectangle.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="MetaBarrier"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="MetaBarrier.top_of_page"></a>MetaBarrier</span></h2>
<p>MetaBarrier — Pointer barriers</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="MetaBarrier.synopsis"></a><h2>Synopsis</h2>
<a name="MetaBarrierEvent"></a><pre class="synopsis">struct              <a class="link" href="MetaBarrier.html#MetaBarrier-struct" title="struct MetaBarrier">MetaBarrier</a>;
struct              <a class="link" href="MetaBarrier.html#MetaBarrierClass" title="struct MetaBarrierClass">MetaBarrierClass</a>;
<span class="returnvalue">gboolean</span>            <a class="link" href="MetaBarrier.html#meta-barrier-is-active" title="meta_barrier_is_active ()">meta_barrier_is_active</a>              (<em class="parameter"><code><a class="link" href="MetaBarrier.html" title="MetaBarrier"><span class="type">MetaBarrier</span></a> *barrier</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="MetaBarrier.html#meta-barrier-destroy" title="meta_barrier_destroy ()">meta_barrier_destroy</a>                (<em class="parameter"><code><a class="link" href="MetaBarrier.html" title="MetaBarrier"><span class="type">MetaBarrier</span></a> *barrier</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="MetaBarrier.html#meta-barrier-release" title="meta_barrier_release ()">meta_barrier_release</a>                (<em class="parameter"><code><a class="link" href="MetaBarrier.html" title="MetaBarrier"><span class="type">MetaBarrier</span></a> *barrier</code></em>,
                                                         <em class="parameter"><code><a class="link" href="MetaBarrier.html#MetaBarrierEvent"><span class="type">MetaBarrierEvent</span></a> *event</code></em>);
enum                <a class="link" href="MetaBarrier.html#MetaBarrierDirection" title="enum MetaBarrierDirection">MetaBarrierDirection</a>;
struct              <a class="link" href="MetaBarrier.html#MetaBarrierEvent-struct" title="struct MetaBarrierEvent">MetaBarrierEvent</a>;
</pre>
</div>
<div class="refsect1">
<a name="MetaBarrier.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----MetaBarrier
</pre>
<pre class="synopsis">
  GBoxed
   +----MetaBarrierEvent
</pre>
</div>
<div class="refsect1">
<a name="MetaBarrier.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="MetaBarrier.html#MetaBarrier--directions" title='The "directions" property'>directions</a>"               <a class="link" href="MetaBarrier.html#MetaBarrierDirection" title="enum MetaBarrierDirection"><span class="type">MetaBarrierDirection</span></a>  : Read / Write / Construct Only
  "<a class="link" href="MetaBarrier.html#MetaBarrier--display" title='The "display" property'>display</a>"                  <a class="link" href="MetaDisplay.html" title="MetaDisplay"><span class="type">MetaDisplay</span></a>*          : Read / Write / Construct Only
  "<a class="link" href="MetaBarrier.html#MetaBarrier--x1" title='The "x1" property'>x1</a>"                       <span class="type">gint</span>                  : Read / Write / Construct Only
  "<a class="link" href="MetaBarrier.html#MetaBarrier--x2" title='The "x2" property'>x2</a>"                       <span class="type">gint</span>                  : Read / Write / Construct Only
  "<a class="link" href="MetaBarrier.html#MetaBarrier--y1" title='The "y1" property'>y1</a>"                       <span class="type">gint</span>                  : Read / Write / Construct Only
  "<a class="link" href="MetaBarrier.html#MetaBarrier--y2" title='The "y2" property'>y2</a>"                       <span class="type">gint</span>                  : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="MetaBarrier.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="MetaBarrier.html#MetaBarrier-hit" title='The "hit" signal'>hit</a>"                                            : <code class="literal">Run First</code>
  "<a class="link" href="MetaBarrier.html#MetaBarrier-left" title='The "left" signal'>left</a>"                                           : <code class="literal">Run First</code>
</pre>
</div>
<div class="refsect1">
<a name="MetaBarrier.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="MetaBarrier.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="MetaBarrier-struct"></a><h3>struct MetaBarrier</h3>
<pre class="programlisting">struct MetaBarrier;</pre>
<p>
The <span class="structname">MetaBarrier</span> structure contains
only private data and should be accessed using the provided API
</p>
</div>
<hr>
<div class="refsect2">
<a name="MetaBarrierClass"></a><h3>struct MetaBarrierClass</h3>
<pre class="programlisting">struct MetaBarrierClass {
};
</pre>
<p>
The <span class="structname">MetaBarrierClass</span> structure contains only
private data.
</p>
</div>
<hr>
<div class="refsect2">
<a name="meta-barrier-is-active"></a><h3>meta_barrier_is_active ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            meta_barrier_is_active              (<em class="parameter"><code><a class="link" href="MetaBarrier.html" title="MetaBarrier"><span class="type">MetaBarrier</span></a> *barrier</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="meta-barrier-destroy"></a><h3>meta_barrier_destroy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                meta_barrier_destroy                (<em class="parameter"><code><a class="link" href="MetaBarrier.html" title="MetaBarrier"><span class="type">MetaBarrier</span></a> *barrier</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="meta-barrier-release"></a><h3>meta_barrier_release ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                meta_barrier_release                (<em class="parameter"><code><a class="link" href="MetaBarrier.html" title="MetaBarrier"><span class="type">MetaBarrier</span></a> *barrier</code></em>,
                                                         <em class="parameter"><code><a class="link" href="MetaBarrier.html#MetaBarrierEvent"><span class="type">MetaBarrierEvent</span></a> *event</code></em>);</pre>
<p>
In XI2.3, pointer barriers provide a feature where they can
be temporarily released so that the pointer goes through
them. Pass a <a class="link" href="MetaBarrier.html#MetaBarrierEvent"><span class="type">MetaBarrierEvent</span></a> to release the barrier for
this event sequence.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>barrier</code></em> :</span></p></td>
<td>The barrier to release</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
<td>The event to release the pointer for</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="MetaBarrierDirection"></a><h3>enum MetaBarrierDirection</h3>
<pre class="programlisting">typedef enum {
  META_BARRIER_DIRECTION_POSITIVE_X = 1 &lt;&lt; 0,
  META_BARRIER_DIRECTION_POSITIVE_Y = 1 &lt;&lt; 1,
  META_BARRIER_DIRECTION_NEGATIVE_X = 1 &lt;&lt; 2,
  META_BARRIER_DIRECTION_NEGATIVE_Y = 1 &lt;&lt; 3,
} MetaBarrierDirection;
</pre>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="META-BARRIER-DIRECTION-POSITIVE-X:CAPS"></a><span class="term"><code class="literal">META_BARRIER_DIRECTION_POSITIVE_X</code></span></p></td>
<td>Positive direction in the X axis
</td>
</tr>
<tr>
<td><p><a name="META-BARRIER-DIRECTION-POSITIVE-Y:CAPS"></a><span class="term"><code class="literal">META_BARRIER_DIRECTION_POSITIVE_Y</code></span></p></td>
<td>Positive direction in the Y axis
</td>
</tr>
<tr>
<td><p><a name="META-BARRIER-DIRECTION-NEGATIVE-X:CAPS"></a><span class="term"><code class="literal">META_BARRIER_DIRECTION_NEGATIVE_X</code></span></p></td>
<td>Negative direction in the X axis
</td>
</tr>
<tr>
<td><p><a name="META-BARRIER-DIRECTION-NEGATIVE-Y:CAPS"></a><span class="term"><code class="literal">META_BARRIER_DIRECTION_NEGATIVE_Y</code></span></p></td>
<td>Negative direction in the Y axis
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="MetaBarrierEvent-struct"></a><h3>struct MetaBarrierEvent</h3>
<pre class="programlisting">struct MetaBarrierEvent {
  int event_id;
  int dt;
  guint32 time;
  double x;
  double y;
  double dx;
  double dy;
  gboolean released;
  gboolean grabbed;
};
</pre>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="MetaBarrierEvent-struct.event-id"></a>event_id</code></em>;</span></p></td>
<td>A unique integer ID identifying a
consecutive series of motions at or along the barrier</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="MetaBarrierEvent-struct.dt"></a>dt</code></em>;</span></p></td>
<td>Server time, in milliseconds, since the last event
sent for this barrier</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">guint32</span> <em class="structfield"><code><a name="MetaBarrierEvent-struct.time"></a>time</code></em>;</span></p></td>
<td>Server time, in milliseconds</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">double</span> <em class="structfield"><code><a name="MetaBarrierEvent-struct.x"></a>x</code></em>;</span></p></td>
<td>The cursor X position in screen coordinates</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">double</span> <em class="structfield"><code><a name="MetaBarrierEvent-struct.y"></a>y</code></em>;</span></p></td>
<td>The cursor Y position in screen coordinates.</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">double</span> <em class="structfield"><code><a name="MetaBarrierEvent-struct.dx"></a>dx</code></em>;</span></p></td>
<td>If the cursor hadn't been constrained, the delta
of X movement past the barrier, in screen coordinates</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">double</span> <em class="structfield"><code><a name="MetaBarrierEvent-struct.dy"></a>dy</code></em>;</span></p></td>
<td>If the cursor hadn't been constrained, the delta
of X movement past the barrier, in screen coordinates</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">gboolean</span> <em class="structfield"><code><a name="MetaBarrierEvent-struct.released"></a>released</code></em>;</span></p></td>
<td>A boolean flag, <code class="literal">TRUE</code> if this event generated
by the pointer leaving the barrier as a result of a client
calling <a class="link" href="MetaBarrier.html#meta-barrier-release" title="meta_barrier_release ()"><code class="function">meta_barrier_release()</code></a> (will be set only for
MetaBarrier::leave signals)</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">gboolean</span> <em class="structfield"><code><a name="MetaBarrierEvent-struct.grabbed"></a>grabbed</code></em>;</span></p></td>
<td>A boolean flag, <code class="literal">TRUE</code> if the pointer was grabbed
at the time this event was sent</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="MetaBarrier.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="MetaBarrier--directions"></a><h3>The <code class="literal">"directions"</code> property</h3>
<pre class="programlisting">  "directions"               <a class="link" href="MetaBarrier.html#MetaBarrierDirection" title="enum MetaBarrierDirection"><span class="type">MetaBarrierDirection</span></a>  : Read / Write / Construct Only</pre>
<p>A set of directions to let the pointer through.</p>
</div>
<hr>
<div class="refsect2">
<a name="MetaBarrier--display"></a><h3>The <code class="literal">"display"</code> property</h3>
<pre class="programlisting">  "display"                  <a class="link" href="MetaDisplay.html" title="MetaDisplay"><span class="type">MetaDisplay</span></a>*          : Read / Write / Construct Only</pre>
<p>The display to construct the pointer barrier on.</p>
</div>
<hr>
<div class="refsect2">
<a name="MetaBarrier--x1"></a><h3>The <code class="literal">"x1"</code> property</h3>
<pre class="programlisting">  "x1"                       <span class="type">gint</span>                  : Read / Write / Construct Only</pre>
<p>The first X coordinate of the barrier.</p>
<p>Allowed values: [0,32767]</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="MetaBarrier--x2"></a><h3>The <code class="literal">"x2"</code> property</h3>
<pre class="programlisting">  "x2"                       <span class="type">gint</span>                  : Read / Write / Construct Only</pre>
<p>The second X coordinate of the barrier.</p>
<p>Allowed values: [0,32767]</p>
<p>Default value: 32767</p>
</div>
<hr>
<div class="refsect2">
<a name="MetaBarrier--y1"></a><h3>The <code class="literal">"y1"</code> property</h3>
<pre class="programlisting">  "y1"                       <span class="type">gint</span>                  : Read / Write / Construct Only</pre>
<p>The first Y coordinate of the barrier.</p>
<p>Allowed values: [0,32767]</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="MetaBarrier--y2"></a><h3>The <code class="literal">"y2"</code> property</h3>
<pre class="programlisting">  "y2"                       <span class="type">gint</span>                  : Read / Write / Construct Only</pre>
<p>The second Y coordinate of the barrier.</p>
<p>Allowed values: [0,32767]</p>
<p>Default value: 32767</p>
</div>
</div>
<div class="refsect1">
<a name="MetaBarrier.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="MetaBarrier-hit"></a><h3>The <code class="literal">"hit"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="MetaBarrier.html" title="MetaBarrier"><span class="type">MetaBarrier</span></a>      *barrier,
                                                        <a class="link" href="MetaBarrier.html#MetaBarrierEvent"><span class="type">MetaBarrierEvent</span></a> *event,
                                                        <span class="type">gpointer</span>          user_data)      : <code class="literal">Run First</code></pre>
<p>
When a pointer barrier is hit, this will trigger. This
requires an XI2-enabled server.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>barrier</code></em> :</span></p></td>
<td>The <a class="link" href="MetaBarrier.html" title="MetaBarrier"><span class="type">MetaBarrier</span></a> that was hit</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
<td>A <a class="link" href="MetaBarrier.html#MetaBarrierEvent"><span class="type">MetaBarrierEvent</span></a> that has the details of how
the barrier was hit.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="MetaBarrier-left"></a><h3>The <code class="literal">"left"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="MetaBarrier.html" title="MetaBarrier"><span class="type">MetaBarrier</span></a>      *barrier,
                                                        <a class="link" href="MetaBarrier.html#MetaBarrierEvent"><span class="type">MetaBarrierEvent</span></a> *event,
                                                        <span class="type">gpointer</span>          user_data)      : <code class="literal">Run First</code></pre>
<p>
When a pointer barrier hitbox was left, this will trigger.
This requires an XI2-enabled server.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>barrier</code></em> :</span></p></td>
<td>The <a class="link" href="MetaBarrier.html" title="MetaBarrier"><span class="type">MetaBarrier</span></a> that was left</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
<td>A <a class="link" href="MetaBarrier.html#MetaBarrierEvent"><span class="type">MetaBarrierEvent</span></a> that has the details of how
the barrier was left.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.19.1</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.