← Back to branch summary

~ubuntu-branches/debian/jessie/gnome-shell/jessie

« back to all changes in this revision

Viewing changes to docs/reference/shell/html/shell-shell-xfixes-cursor.html

  • Committer: Package Import Robot
  • Author(s): Michael Biebl
  • Date: 2012-05-30 13:19:38 UTC
  • mfrom: (18.1.24 experimental)
  • Revision ID: package-import@ubuntu.com-20120530131938-i3trc1g1p3is2u6x
Tags: 3.4.1-3
Upload to unstable.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/shell/html/shell-shell-xfixes-cursor.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>shell-xfixes-cursor</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
7
<link rel="home" href="index.html" title="Shell Reference Manual">
 
8
<link rel="up" href="ch06.html" title="Integration helpers and utilities">
 
9
<link rel="prev" href="shell-ShellWM.html" title="ShellWM">
 
10
<link rel="next" href="shell-shell-util.html" title="shell-util">
 
11
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="shell-ShellWM.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="ch06.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">Shell Reference Manual</th>
 
21
<td><a accesskey="n" href="shell-shell-util.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#shell-shell-xfixes-cursor.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#shell-shell-xfixes-cursor.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#shell-shell-xfixes-cursor.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#shell-shell-xfixes-cursor.properties" class="shortcut">Properties</a>
 
31
                   | 
 
32
                  <a href="#shell-shell-xfixes-cursor.signals" class="shortcut">Signals</a>
 
33
</td></tr>
 
34
</table>
 
35
<div class="refentry">
 
36
<a name="shell-shell-xfixes-cursor"></a><div class="titlepage"></div>
 
37
<div class="refnamediv"><table width="100%"><tr>
 
38
<td valign="top">
 
39
<h2><span class="refentrytitle"><a name="shell-shell-xfixes-cursor.top_of_page"></a>shell-xfixes-cursor</span></h2>
 
40
<p>shell-xfixes-cursor — Capture/manipulate system mouse cursor.</p>
 
41
</td>
 
42
<td valign="top" align="right"></td>
 
43
</tr></table></div>
 
44
<div class="refsynopsisdiv">
 
45
<a name="shell-shell-xfixes-cursor.synopsis"></a><h2>Synopsis</h2>
 
46
<a name="ShellXFixesCursor"></a><pre class="synopsis">                    <a class="link" href="shell-shell-xfixes-cursor.html#ShellXFixesCursor-struct" title="ShellXFixesCursor">ShellXFixesCursor</a>;
 
47
                    <a class="link" href="shell-shell-xfixes-cursor.html#ShellXFixesCursorClass" title="ShellXFixesCursorClass">ShellXFixesCursorClass</a>;
 
48
<a class="link" href="shell-shell-xfixes-cursor.html#ShellXFixesCursor"><span class="returnvalue">ShellXFixesCursor</span></a> * <a class="link" href="shell-shell-xfixes-cursor.html#shell-xfixes-cursor-get-for-stage" title="shell_xfixes_cursor_get_for_stage ()">shell_xfixes_cursor_get_for_stage</a>   (<em class="parameter"><code><span class="type">ClutterStage</span> *stage</code></em>);
 
49
<span class="returnvalue">int</span>                 <a class="link" href="shell-shell-xfixes-cursor.html#shell-xfixes-cursor-get-hot-x" title="shell_xfixes_cursor_get_hot_x ()">shell_xfixes_cursor_get_hot_x</a>       (<em class="parameter"><code><a class="link" href="shell-shell-xfixes-cursor.html#ShellXFixesCursor"><span class="type">ShellXFixesCursor</span></a> *xfixes_cursor</code></em>);
 
50
<span class="returnvalue">int</span>                 <a class="link" href="shell-shell-xfixes-cursor.html#shell-xfixes-cursor-get-hot-y" title="shell_xfixes_cursor_get_hot_y ()">shell_xfixes_cursor_get_hot_y</a>       (<em class="parameter"><code><a class="link" href="shell-shell-xfixes-cursor.html#ShellXFixesCursor"><span class="type">ShellXFixesCursor</span></a> *xfixes_cursor</code></em>);
 
51
<span class="returnvalue">void</span>                <a class="link" href="shell-shell-xfixes-cursor.html#shell-xfixes-cursor-hide" title="shell_xfixes_cursor_hide ()">shell_xfixes_cursor_hide</a>            (<em class="parameter"><code><a class="link" href="shell-shell-xfixes-cursor.html#ShellXFixesCursor"><span class="type">ShellXFixesCursor</span></a> *xfixes_cursor</code></em>);
 
52
<span class="returnvalue">void</span>                <a class="link" href="shell-shell-xfixes-cursor.html#shell-xfixes-cursor-show" title="shell_xfixes_cursor_show ()">shell_xfixes_cursor_show</a>            (<em class="parameter"><code><a class="link" href="shell-shell-xfixes-cursor.html#ShellXFixesCursor"><span class="type">ShellXFixesCursor</span></a> *xfixes_cursor</code></em>);
 
53
<span class="returnvalue">void</span>                <a class="link" href="shell-shell-xfixes-cursor.html#shell-xfixes-cursor-update-texture-image" title="shell_xfixes_cursor_update_texture_image ()">shell_xfixes_cursor_update_texture_image</a>
 
54
                                                        (<em class="parameter"><code><a class="link" href="shell-shell-xfixes-cursor.html#ShellXFixesCursor"><span class="type">ShellXFixesCursor</span></a> *xfixes_cursor</code></em>,
 
55
                                                         <em class="parameter"><code><span class="type">ClutterTexture</span> *texture</code></em>);
 
56
</pre>
 
57
</div>
 
58
<div class="refsect1">
 
59
<a name="shell-shell-xfixes-cursor.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
60
<pre class="synopsis">
 
61
  GObject
 
62
   +----ShellXFixesCursor
 
63
</pre>
 
64
</div>
 
65
<div class="refsect1">
 
66
<a name="shell-shell-xfixes-cursor.properties"></a><h2>Properties</h2>
 
67
<pre class="synopsis">
 
68
  "<a class="link" href="shell-shell-xfixes-cursor.html#ShellXFixesCursor--stage" title='The "stage" property'>stage</a>"                    <span class="type">ClutterStage</span>*         : Read / Write / Construct Only
 
69
</pre>
 
70
</div>
 
71
<div class="refsect1">
 
72
<a name="shell-shell-xfixes-cursor.signals"></a><h2>Signals</h2>
 
73
<pre class="synopsis">
 
74
  "<a class="link" href="shell-shell-xfixes-cursor.html#ShellXFixesCursor-cursor-change" title='The "cursor-change" signal'>cursor-change</a>"                                  : <code class="literal">Run Last</code>
 
75
</pre>
 
76
</div>
 
77
<div class="refsect1">
 
78
<a name="shell-shell-xfixes-cursor.description"></a><h2>Description</h2>
 
79
<p>
 
80
The <a class="link" href="shell-shell-xfixes-cursor.html#ShellXFixesCursor"><span class="type">ShellXFixesCursor</span></a> object uses the XFixes extension to show/hide the
 
81
the system mouse pointer, to grab its image as it changes, and emit a
 
82
notification when its image changes.
 
83
</p>
 
84
</div>
 
85
<div class="refsect1">
 
86
<a name="shell-shell-xfixes-cursor.details"></a><h2>Details</h2>
 
87
<div class="refsect2">
 
88
<a name="ShellXFixesCursor-struct"></a><h3>ShellXFixesCursor</h3>
 
89
<pre class="programlisting">typedef struct _ShellXFixesCursor ShellXFixesCursor;</pre>
 
90
</div>
 
91
<hr>
 
92
<div class="refsect2">
 
93
<a name="ShellXFixesCursorClass"></a><h3>ShellXFixesCursorClass</h3>
 
94
<pre class="programlisting">typedef struct _ShellXFixesCursorClass ShellXFixesCursorClass;</pre>
 
95
</div>
 
96
<hr>
 
97
<div class="refsect2">
 
98
<a name="shell-xfixes-cursor-get-for-stage"></a><h3>shell_xfixes_cursor_get_for_stage ()</h3>
 
99
<pre class="programlisting"><a class="link" href="shell-shell-xfixes-cursor.html#ShellXFixesCursor"><span class="returnvalue">ShellXFixesCursor</span></a> * shell_xfixes_cursor_get_for_stage   (<em class="parameter"><code><span class="type">ClutterStage</span> *stage</code></em>);</pre>
 
100
<div class="variablelist"><table border="0">
 
101
<col align="left" valign="top">
 
102
<tbody>
 
103
<tr>
 
104
<td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
 
105
<td>The <span class="type">ClutterStage</span> to get the cursor for. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 
106
</td>
 
107
</tr>
 
108
<tr>
 
109
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
110
<td>A <a class="link" href="shell-shell-xfixes-cursor.html#ShellXFixesCursor"><span class="type">ShellXFixesCursor</span></a> instance. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 
111
</td>
 
112
</tr>
 
113
</tbody>
 
114
</table></div>
 
115
</div>
 
116
<hr>
 
117
<div class="refsect2">
 
118
<a name="shell-xfixes-cursor-get-hot-x"></a><h3>shell_xfixes_cursor_get_hot_x ()</h3>
 
119
<pre class="programlisting"><span class="returnvalue">int</span>                 shell_xfixes_cursor_get_hot_x       (<em class="parameter"><code><a class="link" href="shell-shell-xfixes-cursor.html#ShellXFixesCursor"><span class="type">ShellXFixesCursor</span></a> *xfixes_cursor</code></em>);</pre>
 
120
<div class="variablelist"><table border="0">
 
121
<col align="left" valign="top">
 
122
<tbody>
 
123
<tr>
 
124
<td><p><span class="term"><em class="parameter"><code>xfixes_cursor</code></em> :</span></p></td>
 
125
<td>the <a class="link" href="shell-shell-xfixes-cursor.html#ShellXFixesCursor"><span class="type">ShellXFixesCursor</span></a>
 
126
</td>
 
127
</tr>
 
128
<tr>
 
129
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
130
<td>the current mouse cursor's hot x-coordinate.</td>
 
131
</tr>
 
132
</tbody>
 
133
</table></div>
 
134
</div>
 
135
<hr>
 
136
<div class="refsect2">
 
137
<a name="shell-xfixes-cursor-get-hot-y"></a><h3>shell_xfixes_cursor_get_hot_y ()</h3>
 
138
<pre class="programlisting"><span class="returnvalue">int</span>                 shell_xfixes_cursor_get_hot_y       (<em class="parameter"><code><a class="link" href="shell-shell-xfixes-cursor.html#ShellXFixesCursor"><span class="type">ShellXFixesCursor</span></a> *xfixes_cursor</code></em>);</pre>
 
139
<div class="variablelist"><table border="0">
 
140
<col align="left" valign="top">
 
141
<tbody>
 
142
<tr>
 
143
<td><p><span class="term"><em class="parameter"><code>xfixes_cursor</code></em> :</span></p></td>
 
144
<td>the <a class="link" href="shell-shell-xfixes-cursor.html#ShellXFixesCursor"><span class="type">ShellXFixesCursor</span></a>
 
145
</td>
 
146
</tr>
 
147
<tr>
 
148
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
149
<td>the current mouse cursor's hot y-coordinate.</td>
 
150
</tr>
 
151
</tbody>
 
152
</table></div>
 
153
</div>
 
154
<hr>
 
155
<div class="refsect2">
 
156
<a name="shell-xfixes-cursor-hide"></a><h3>shell_xfixes_cursor_hide ()</h3>
 
157
<pre class="programlisting"><span class="returnvalue">void</span>                shell_xfixes_cursor_hide            (<em class="parameter"><code><a class="link" href="shell-shell-xfixes-cursor.html#ShellXFixesCursor"><span class="type">ShellXFixesCursor</span></a> *xfixes_cursor</code></em>);</pre>
 
158
<p>
 
159
Hide the system mouse cursor.
 
160
</p>
 
161
<div class="variablelist"><table border="0">
 
162
<col align="left" valign="top">
 
163
<tbody><tr>
 
164
<td><p><span class="term"><em class="parameter"><code>xfixes_cursor</code></em> :</span></p></td>
 
165
<td>the <a class="link" href="shell-shell-xfixes-cursor.html#ShellXFixesCursor"><span class="type">ShellXFixesCursor</span></a>
 
166
</td>
 
167
</tr></tbody>
 
168
</table></div>
 
169
</div>
 
170
<hr>
 
171
<div class="refsect2">
 
172
<a name="shell-xfixes-cursor-show"></a><h3>shell_xfixes_cursor_show ()</h3>
 
173
<pre class="programlisting"><span class="returnvalue">void</span>                shell_xfixes_cursor_show            (<em class="parameter"><code><a class="link" href="shell-shell-xfixes-cursor.html#ShellXFixesCursor"><span class="type">ShellXFixesCursor</span></a> *xfixes_cursor</code></em>);</pre>
 
174
<p>
 
175
Show the system mouse cursor to show
 
176
</p>
 
177
<div class="variablelist"><table border="0">
 
178
<col align="left" valign="top">
 
179
<tbody><tr>
 
180
<td><p><span class="term"><em class="parameter"><code>xfixes_cursor</code></em> :</span></p></td>
 
181
<td>the <a class="link" href="shell-shell-xfixes-cursor.html#ShellXFixesCursor"><span class="type">ShellXFixesCursor</span></a>
 
182
</td>
 
183
</tr></tbody>
 
184
</table></div>
 
185
</div>
 
186
<hr>
 
187
<div class="refsect2">
 
188
<a name="shell-xfixes-cursor-update-texture-image"></a><h3>shell_xfixes_cursor_update_texture_image ()</h3>
 
189
<pre class="programlisting"><span class="returnvalue">void</span>                shell_xfixes_cursor_update_texture_image
 
190
                                                        (<em class="parameter"><code><a class="link" href="shell-shell-xfixes-cursor.html#ShellXFixesCursor"><span class="type">ShellXFixesCursor</span></a> *xfixes_cursor</code></em>,
 
191
                                                         <em class="parameter"><code><span class="type">ClutterTexture</span> *texture</code></em>);</pre>
 
192
<div class="variablelist"><table border="0">
 
193
<col align="left" valign="top">
 
194
<tbody>
 
195
<tr>
 
196
<td><p><span class="term"><em class="parameter"><code>xfixes_cursor</code></em> :</span></p></td>
 
197
<td>the <a class="link" href="shell-shell-xfixes-cursor.html#ShellXFixesCursor"><span class="type">ShellXFixesCursor</span></a>
 
198
</td>
 
199
</tr>
 
200
<tr>
 
201
<td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
 
202
<td>ClutterTexture to update with the current sprite image.</td>
 
203
</tr>
 
204
</tbody>
 
205
</table></div>
 
206
</div>
 
207
</div>
 
208
<div class="refsect1">
 
209
<a name="shell-shell-xfixes-cursor.property-details"></a><h2>Property Details</h2>
 
210
<div class="refsect2">
 
211
<a name="ShellXFixesCursor--stage"></a><h3>The <code class="literal">"stage"</code> property</h3>
 
212
<pre class="programlisting">  "stage"                    <span class="type">ClutterStage</span>*         : Read / Write / Construct Only</pre>
 
213
<p>Stage for mouse cursor.</p>
 
214
</div>
 
215
</div>
 
216
<div class="refsect1">
 
217
<a name="shell-shell-xfixes-cursor.signal-details"></a><h2>Signal Details</h2>
 
218
<div class="refsect2">
 
219
<a name="ShellXFixesCursor-cursor-change"></a><h3>The <code class="literal">"cursor-change"</code> signal</h3>
 
220
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="shell-shell-xfixes-cursor.html#ShellXFixesCursor"><span class="type">ShellXFixesCursor</span></a> *shellxfixescursor,
 
221
                                                        <span class="type">gpointer</span>           user_data)              : <code class="literal">Run Last</code></pre>
 
222
</div>
 
223
</div>
 
224
</div>
 
225
<div class="footer">
 
226
<hr>
 
227
          Generated by GTK-Doc V1.18.1</div>
 
228
</body>
 
229
</html>
 
 
b'\\ No newline at end of file'