| 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>Gdk Extensions: libxfce4ui Reference Manual</title> |
| 6 |
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> |
| 7 |
<link rel="home" href="index.html" title="libxfce4ui Reference Manual"> |
| 8 |
<link rel="up" href="ch01.html" title="[Insert title here]"> |
| 9 |
<link rel="prev" href="libxfce4ui-Spawn.html" title="Spawn"> |
| 10 |
<link rel="next" href="libxfce4ui-Gtk-Extensions.html" title="Gtk Extensions"> |
| 11 |
<meta name="generator" content="GTK-Doc V1.34.0 (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="5"><tr valign="middle"> |
| 16 |
<td width="100%" align="left" class="shortcuts"> |
| 17 |
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> |
| 18 |
<a href="#libxfce4ui-Gdk-Extensions.description" class="shortcut">Description</a></span> |
| 19 |
</td> |
| 20 |
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> |
| 21 |
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
| 22 |
<td><a accesskey="p" href="libxfce4ui-Spawn.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| 23 |
<td><a accesskey="n" href="libxfce4ui-Gtk-Extensions.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| 24 |
</tr></table> |
| 25 |
<div class="refentry"> |
| 26 |
<a name="libxfce4ui-Gdk-Extensions"></a><div class="titlepage"></div> |
| 27 |
<div class="refnamediv"><table width="100%"><tr> |
| 28 |
<td valign="top"> |
| 29 |
<h2><span class="refentrytitle"><a name="libxfce4ui-Gdk-Extensions.top_of_page"></a>Gdk Extensions</span></h2> |
| 30 |
<p>Gdk Extensions — various extensions to Gdk</p> |
| 31 |
</td> |
| 32 |
<td class="gallery_image" valign="top" align="right"></td> |
| 33 |
</tr></table></div> |
| 34 |
<div class="refsect1"> |
| 35 |
<a name="libxfce4ui-Gdk-Extensions.stability-level"></a><h2>Stability Level</h2> |
| 36 |
<acronym title="The intention of a Stable interface is to enable arbitrary third parties to |
| 37 |
develop applications to these interfaces, release them, and have confidence that |
| 38 |
they will run on all minor releases of the product (after the one in which the |
| 39 |
interface was introduced, and within the same major release). Even at a major |
| 40 |
release, incompatible changes are expected to be rare, and to have strong |
| 41 |
justifications. |
| 42 |
"><span class="acronym">Stable</span></acronym>, unless otherwise indicated |
| 43 |
</div> |
| 44 |
<div class="refsect1"> |
| 45 |
<a name="libxfce4ui-Gdk-Extensions.functions"></a><h2>Functions</h2> |
| 46 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 47 |
<colgroup> |
| 48 |
<col width="150px" class="functions_proto_type"> |
| 49 |
<col class="functions_proto_name"> |
| 50 |
</colgroup> |
| 51 |
<tbody> |
| 52 |
<tr> |
| 53 |
<td class="function_type"> |
| 54 |
<a href="/usr/share/gtk-doc/html/gdk3/GdkScreen.html#GdkScreen-struct"><span class="returnvalue">GdkScreen</span></a> * |
| 55 |
</td> |
| 56 |
<td class="function_name"> |
| 57 |
<a class="link" href="libxfce4ui-Gdk-Extensions.html#xfce-gdk-screen-get-active" title="xfce_gdk_screen_get_active ()">xfce_gdk_screen_get_active</a> <span class="c_punctuation">()</span> |
| 58 |
</td> |
| 59 |
</tr> |
| 60 |
<tr> |
| 61 |
<td class="function_type"> |
| 62 |
<a href="/usr/share/gtk-doc/html/gdk3/gdk3-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="returnvalue">GdkRectangle</span></a> * |
| 63 |
</td> |
| 64 |
<td class="function_name"> |
| 65 |
<a class="link" href="libxfce4ui-Gdk-Extensions.html#xfce-gdk-screen-get-geometry" title="xfce_gdk_screen_get_geometry ()">xfce_gdk_screen_get_geometry</a> <span class="c_punctuation">()</span> |
| 66 |
</td> |
| 67 |
</tr> |
| 68 |
<tr> |
| 69 |
<td class="function_type"> |
| 70 |
<span class="returnvalue">gboolean</span> |
| 71 |
</td> |
| 72 |
<td class="function_name"> |
| 73 |
<a class="link" href="libxfce4ui-Gdk-Extensions.html#xfce-gdk-device-grab" title="xfce_gdk_device_grab ()">xfce_gdk_device_grab</a> <span class="c_punctuation">()</span> |
| 74 |
</td> |
| 75 |
</tr> |
| 76 |
</tbody> |
| 77 |
</table></div> |
| 78 |
</div> |
| 79 |
<div class="refsect1"> |
| 80 |
<a name="libxfce4ui-Gdk-Extensions.includes"></a><h2>Includes</h2> |
| 81 |
<pre class="synopsis">#include <libxfce4ui/libxfce4ui.h> |
| 82 |
</pre> |
| 83 |
</div> |
| 84 |
<div class="refsect1"> |
| 85 |
<a name="libxfce4ui-Gdk-Extensions.description"></a><h2>Description</h2> |
| 86 |
<p>Common used functions that are not provided by the Gdk or Gdk-pixbuf library.</p> |
| 87 |
</div> |
| 88 |
<div class="refsect1"> |
| 89 |
<a name="libxfce4ui-Gdk-Extensions.functions_details"></a><h2>Functions</h2> |
| 90 |
<div class="refsect2"> |
| 91 |
<a name="xfce-gdk-screen-get-active"></a><h3>xfce_gdk_screen_get_active ()</h3> |
| 92 |
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gdk3/GdkScreen.html#GdkScreen-struct"><span class="returnvalue">GdkScreen</span></a> * |
| 93 |
xfce_gdk_screen_get_active (<em class="parameter"><code><span class="type">gint</span> *monitor_return</code></em>);</pre> |
| 94 |
<p>Returns the currently active <a href="/usr/share/gtk-doc/html/gdk3/GdkScreen.html#GdkScreen-struct"><span class="type">GdkScreen</span></a>, that is, the screen which |
| 95 |
currently contains the pointer. If no active screen was found, the |
| 96 |
default <a href="/usr/share/gtk-doc/html/gdk3/GdkScreen.html#GdkScreen-struct"><span class="type">GdkScreen</span></a> is returned.</p> |
| 97 |
<div class="refsect3"> |
| 98 |
<a name="xfce-gdk-screen-get-active.parameters"></a><h4>Parameters</h4> |
| 99 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 100 |
<colgroup> |
| 101 |
<col width="150px" class="parameters_name"> |
| 102 |
<col class="parameters_description"> |
| 103 |
<col width="200px" class="parameters_annotations"> |
| 104 |
</colgroup> |
| 105 |
<tbody><tr> |
| 106 |
<td class="parameter_name"><p>monitor_return</p></td> |
| 107 |
<td class="parameter_description"><p>Address to store the monitor number to or <code class="literal">NULL</code>. </p></td> |
| 108 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 109 |
</tr></tbody> |
| 110 |
</table></div> |
| 111 |
</div> |
| 112 |
<div class="refsect3"> |
| 113 |
<a name="xfce-gdk-screen-get-active.returns"></a><h4>Returns</h4> |
| 114 |
<p>the currently active <a href="/usr/share/gtk-doc/html/gdk3/GdkScreen.html#GdkScreen-struct"><span class="type">GdkScreen</span></a>. </p> |
| 115 |
<p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p> |
| 116 |
</div> |
| 117 |
</div> |
| 118 |
<hr> |
| 119 |
<div class="refsect2"> |
| 120 |
<a name="xfce-gdk-screen-get-geometry"></a><h3>xfce_gdk_screen_get_geometry ()</h3> |
| 121 |
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gdk3/gdk3-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="returnvalue">GdkRectangle</span></a> * |
| 122 |
xfce_gdk_screen_get_geometry (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> |
| 123 |
<p>Returns the width and height of the default <a href="/usr/share/gtk-doc/html/gdk3/GdkScreen.html#GdkScreen-struct"><span class="type">GdkScreen</span></a>. |
| 124 |
This is a replacement for gdk_screen_width/gdk_screen_height.</p> |
| 125 |
<div class="refsect3"> |
| 126 |
<a name="xfce-gdk-screen-get-geometry.returns"></a><h4>Returns</h4> |
| 127 |
<p>a newly created <a href="/usr/share/gtk-doc/html/gdk3/gdk3-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="type">GdkRectangle</span></a> |
| 128 |
containing the width and height of the screen. </p> |
| 129 |
<p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p> |
| 130 |
</div> |
| 131 |
<p class="since">Since: <a class="link" href="api-index-4-14.html#api-index-4.14">4.14</a></p> |
| 132 |
</div> |
| 133 |
<hr> |
| 134 |
<div class="refsect2"> |
| 135 |
<a name="xfce-gdk-device-grab"></a><h3>xfce_gdk_device_grab ()</h3> |
| 136 |
<pre class="programlisting"><span class="returnvalue">gboolean</span> |
| 137 |
xfce_gdk_device_grab (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gdk3/GdkSeat.html#GdkSeat-struct"><span class="type">GdkSeat</span></a> *seat</code></em>, |
| 138 |
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gdk3/gdk3-Windows.html#GdkWindow-struct"><span class="type">GdkWindow</span></a> *window</code></em>, |
| 139 |
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gdk3/GdkSeat.html#GdkSeatCapabilities"><span class="type">GdkSeatCapabilities</span></a> capabilities</code></em>, |
| 140 |
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gdk3/gdk3-Cursors.html#GdkCursor-struct"><span class="type">GdkCursor</span></a> *cursor</code></em>);</pre> |
| 141 |
<p>Similar to gdk_seat_grab but tries to grab the seat five times with 100ms |
| 142 |
between each attempt.</p> |
| 143 |
<div class="refsect3"> |
| 144 |
<a name="xfce-gdk-device-grab.parameters"></a><h4>Parameters</h4> |
| 145 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 146 |
<colgroup> |
| 147 |
<col width="150px" class="parameters_name"> |
| 148 |
<col class="parameters_description"> |
| 149 |
<col width="200px" class="parameters_annotations"> |
| 150 |
</colgroup> |
| 151 |
<tbody> |
| 152 |
<tr> |
| 153 |
<td class="parameter_name"><p>seat</p></td> |
| 154 |
<td class="parameter_description"><p>A <a href="/usr/share/gtk-doc/html/gdk3/GdkSeat.html#GdkSeat-struct"><span class="type">GdkSeat</span></a>.</p></td> |
| 155 |
<td class="parameter_annotations"> </td> |
| 156 |
</tr> |
| 157 |
<tr> |
| 158 |
<td class="parameter_name"><p>window</p></td> |
| 159 |
<td class="parameter_description"><p>The <a href="/usr/share/gtk-doc/html/gdk3/gdk3-Windows.html#GdkWindow-struct"><span class="type">GdkWindow</span></a> which will own the grab.</p></td> |
| 160 |
<td class="parameter_annotations"> </td> |
| 161 |
</tr> |
| 162 |
<tr> |
| 163 |
<td class="parameter_name"><p>capabilities</p></td> |
| 164 |
<td class="parameter_description"><p>Capabilities that will be grabbed.</p></td> |
| 165 |
<td class="parameter_annotations"> </td> |
| 166 |
</tr> |
| 167 |
<tr> |
| 168 |
<td class="parameter_name"><p>cursor</p></td> |
| 169 |
<td class="parameter_description"><p>The cursor to display while the grab is active. If this |
| 170 |
is <code class="literal">NULL</code> then the normal cursors are used for window and |
| 171 |
its descendants, and the cursor for window is used |
| 172 |
elsewhere. </p></td> |
| 173 |
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| 174 |
</tr> |
| 175 |
</tbody> |
| 176 |
</table></div> |
| 177 |
</div> |
| 178 |
<div class="refsect3"> |
| 179 |
<a name="xfce-gdk-device-grab.returns"></a><h4>Returns</h4> |
| 180 |
<p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> otherwise.</p> |
| 181 |
</div> |
| 182 |
<p class="since">Since: <a class="link" href="api-index-4-18.html#api-index-4.18">4.18</a></p> |
| 183 |
</div> |
| 184 |
</div> |
| 185 |
</div> |
| 186 |
<div class="footer"> |
| 187 |
<hr>Generated by GTK-Doc V1.34.0</div> |
| 188 |
</body> |
| 189 |
</html> |