doc/reference/clutter/html/clutter-GDK-Specific-Support.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>GDK Specific Support</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="Clutter Reference Manual">
   8 <link rel="up" href="clutterbackends.html" title="Part VII. Clutter Backends">
   9 <link rel="prev" href="clutter-Intel-CE3100-CE4100-Specific-Support.html" title="Intel CE3100, CE4100 Specific Support">
  10 <link rel="next" href="clutter-Wayland-compositor-specific-support.html" title="Wayland compositor specific support">
  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="clutter-Intel-CE3100-CE4100-Specific-Support.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="clutterbackends.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">Clutter Reference Manual</th>
  21 <td><a accesskey="n" href="clutter-Wayland-compositor-specific-support.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="#clutter-GDK-Specific-Support.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#clutter-GDK-Specific-Support.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="clutter-GDK-Specific-Support"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="clutter-GDK-Specific-Support.top_of_page"></a>GDK Specific Support</span></h2>
  34 <p>GDK Specific Support — GDK specific API</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="clutter-GDK-Specific-Support.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis"><span class="returnvalue">void</span>                <a class="link" href="clutter-GDK-Specific-Support.html#clutter-gdk-disable-event-retrieval" title="clutter_gdk_disable_event_retrieval ()">clutter_gdk_disable_event_retrieval</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
  41 <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *      <a class="link" href="clutter-GDK-Specific-Support.html#clutter-gdk-get-stage-from-window" title="clutter_gdk_get_stage_from_window ()">clutter_gdk_get_stage_from_window</a>   (<em class="parameter"><code><a href="../gdk/gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a> *window</code></em>);
  42 <a href="../gdk/gdk-Windows.html#GdkWindow"><span class="returnvalue">GdkWindow</span></a> *         <a class="link" href="clutter-GDK-Specific-Support.html#clutter-gdk-get-stage-window" title="clutter_gdk_get_stage_window ()">clutter_gdk_get_stage_window</a>        (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);
  43 <a href="../gdk/gdk-Windows.html#GdkFilterReturn"><span class="returnvalue">GdkFilterReturn</span></a>     <a class="link" href="clutter-GDK-Specific-Support.html#clutter-gdk-handle-event" title="clutter_gdk_handle_event ()">clutter_gdk_handle_event</a>            (<em class="parameter"><code><a href="../gdk/gdk-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a> *event</code></em>);
  44 <span class="returnvalue">void</span>                <a class="link" href="clutter-GDK-Specific-Support.html#clutter-gdk-set-display" title="clutter_gdk_set_display ()">clutter_gdk_set_display</a>             (<em class="parameter"><code><a href="../gdk/GdkDisplay.html"><span class="type">GdkDisplay</span></a> *display</code></em>);
  45 <a href="../gdk/GdkDisplay.html"><span class="returnvalue">GdkDisplay</span></a> *        <a class="link" href="clutter-GDK-Specific-Support.html#clutter-gdk-get-default-display" title="clutter_gdk_get_default_display ()">clutter_gdk_get_default_display</a>     (<em class="parameter"><code><span class="type">void</span></code></em>);
  46 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="clutter-GDK-Specific-Support.html#clutter-gdk-set-stage-foreign" title="clutter_gdk_set_stage_foreign ()">clutter_gdk_set_stage_foreign</a>       (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
  47                                                          <em class="parameter"><code><a href="../gdk/gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a> *window</code></em>);
  48 </pre>
  49 </div>
  50 <div class="refsect1">
  51 <a name="clutter-GDK-Specific-Support.description"></a><h2>Description</h2>
  52 <p>
  53 The GDK backend for Clutter provides some specific API, allowing
  54 integration with the GDK API for manipulating the stage window and
  55 handling events outside of Clutter.
  56 </p>
  57 </div>
  58 <div class="refsect1">
  59 <a name="clutter-GDK-Specific-Support.details"></a><h2>Details</h2>
  60 <div class="refsect2">
  61 <a name="clutter-gdk-disable-event-retrieval"></a><h3>clutter_gdk_disable_event_retrieval ()</h3>
  62 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_gdk_disable_event_retrieval (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
  63 <p>
  64 Disable the event retrieval in Clutter.
  65 </p>
  66 <p>
  67 Callers of this function have to set up an event filter using the
  68 GDK API, and call <a class="link" href="clutter-GDK-Specific-Support.html#clutter-gdk-handle-event" title="clutter_gdk_handle_event ()"><code class="function">clutter_gdk_handle_event()</code></a>.
  69 </p>
  70 <p>
  71 This function should only be used when embedding Clutter into
  72 a GDK based toolkit.
  73 </p>
  74 <p class="since">Since 1.10</p>
  75 </div>
  76 <hr>
  77 <div class="refsect2">
  78 <a name="clutter-gdk-get-stage-from-window"></a><h3>clutter_gdk_get_stage_from_window ()</h3>
  79 <pre class="programlisting"><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *      clutter_gdk_get_stage_from_window   (<em class="parameter"><code><a href="../gdk/gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a> *window</code></em>);</pre>
  80 <p>
  81 Gets the stage for a particular X window.
  82 </p>
  83 <div class="variablelist"><table border="0">
  84 <col align="left" valign="top">
  85 <tbody>
  86 <tr>
  87 <td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
  88 <td>a <a href="../gtk/GtkWindow.html"><span class="type">GtkWindow</span></a>
  89 </td>
  90 </tr>
  91 <tr>
  92 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  93 <td>A <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>, or% NULL if a stage
  94 does not exist for the window. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
  95 </td>
  96 </tr>
  97 </tbody>
  98 </table></div>
  99 <p class="since">Since 1.10</p>
 100 </div>
 101 <hr>
 102 <div class="refsect2">
 103 <a name="clutter-gdk-get-stage-window"></a><h3>clutter_gdk_get_stage_window ()</h3>
 104 <pre class="programlisting"><a href="../gdk/gdk-Windows.html#GdkWindow"><span class="returnvalue">GdkWindow</span></a> *         clutter_gdk_get_stage_window        (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
 105 <p>
 106 Gets the stages GdkWindow.
 107 </p>
 108 <div class="variablelist"><table border="0">
 109 <col align="left" valign="top">
 110 <tbody>
 111 <tr>
 112 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
 113 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
 114 </td>
 115 </tr>
 116 <tr>
 117 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 118 <td>A GdkWindow* for the stage window. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 119 </td>
 120 </tr>
 121 </tbody>
 122 </table></div>
 123 <p class="since">Since 1.10</p>
 124 </div>
 125 <hr>
 126 <div class="refsect2">
 127 <a name="clutter-gdk-handle-event"></a><h3>clutter_gdk_handle_event ()</h3>
 128 <pre class="programlisting"><a href="../gdk/gdk-Windows.html#GdkFilterReturn"><span class="returnvalue">GdkFilterReturn</span></a>     clutter_gdk_handle_event            (<em class="parameter"><code><a href="../gdk/gdk-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a> *event</code></em>);</pre>
 129 <p>
 130 This function processes a single GDK event; it can be used to hook
 131 into external event processing
 132 </p>
 133 <div class="variablelist"><table border="0">
 134 <col align="left" valign="top">
 135 <tbody>
 136 <tr>
 137 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
 138 <td>a <a href="../gdk/gdk-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a>
 139 </td>
 140 </tr>
 141 <tr>
 142 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 143 <td>
 144 <a href="../gdk/gdk-Windows.html#GdkFilterReturn"><span class="type">GdkFilterReturn</span></a>. <a href="../gdk/gdk-Windows.html#GDK-FILTER-REMOVE:CAPS"><code class="literal">GDK_FILTER_REMOVE</code></a> indicates that
 145 Clutter has internally handled the event and the caller should do
 146 no further processing. <a href="../gdk/gdk-Windows.html#GDK-FILTER-CONTINUE:CAPS"><code class="literal">GDK_FILTER_CONTINUE</code></a> indicates that Clutter
 147 is either not interested in the event, or has used the event to
 148 update internal state without taking any exclusive action.
 149 <a href="../gdk/gdk-Windows.html#GDK-FILTER-TRANSLATE:CAPS"><code class="literal">GDK_FILTER_TRANSLATE</code></a> will not occur.</td>
 150 </tr>
 151 </tbody>
 152 </table></div>
 153 </div>
 154 <hr>
 155 <div class="refsect2">
 156 <a name="clutter-gdk-set-display"></a><h3>clutter_gdk_set_display ()</h3>
 157 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_gdk_set_display             (<em class="parameter"><code><a href="../gdk/GdkDisplay.html"><span class="type">GdkDisplay</span></a> *display</code></em>);</pre>
 158 <p>
 159 Sets the display connection Clutter should use; must be called
 160 before <a class="link" href="clutter-General.html#clutter-init" title="clutter_init ()"><code class="function">clutter_init()</code></a>, <a class="link" href="clutter-General.html#clutter-init-with-args" title="clutter_init_with_args ()"><code class="function">clutter_init_with_args()</code></a> or other functions
 161 pertaining Clutter's initialization process.
 162 </p>
 163 <p>
 164 If you are parsing the command line arguments by retrieving Clutter's
 165 <a href="../glib/glib-Commandline-option-parser.html#GOptionGroup"><span class="type">GOptionGroup</span></a> with <a class="link" href="clutter-General.html#clutter-get-option-group" title="clutter_get_option_group ()"><code class="function">clutter_get_option_group()</code></a> and calling
 166 <a href="../glib/glib-Commandline-option-parser.html#g-option-context-parse"><code class="function">g_option_context_parse()</code></a> yourself, you should also call
 167 <a class="link" href="clutter-GDK-Specific-Support.html#clutter-gdk-set-display" title="clutter_gdk_set_display ()"><code class="function">clutter_gdk_set_display()</code></a> before <a href="../glib/glib-Commandline-option-parser.html#g-option-context-parse"><code class="function">g_option_context_parse()</code></a>.
 168 </p>
 169 <div class="variablelist"><table border="0">
 170 <col align="left" valign="top">
 171 <tbody><tr>
 172 <td><p><span class="term"><em class="parameter"><code>display</code></em> :</span></p></td>
 173 <td>pointer to a GDK display connection.</td>
 174 </tr></tbody>
 175 </table></div>
 176 <p class="since">Since 0.8</p>
 177 </div>
 178 <hr>
 179 <div class="refsect2">
 180 <a name="clutter-gdk-get-default-display"></a><h3>clutter_gdk_get_default_display ()</h3>
 181 <pre class="programlisting"><a href="../gdk/GdkDisplay.html"><span class="returnvalue">GdkDisplay</span></a> *        clutter_gdk_get_default_display     (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 182 <p>
 183 Retrieves the pointer to the default display.
 184 </p>
 185 <div class="variablelist"><table border="0">
 186 <col align="left" valign="top">
 187 <tbody><tr>
 188 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 189 <td>the default display. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 190 </td>
 191 </tr></tbody>
 192 </table></div>
 193 <p class="since">Since 0.6</p>
 194 </div>
 195 <hr>
 196 <div class="refsect2">
 197 <a name="clutter-gdk-set-stage-foreign"></a><h3>clutter_gdk_set_stage_foreign ()</h3>
 198 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_gdk_set_stage_foreign       (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
 199                                                          <em class="parameter"><code><a href="../gdk/gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a> *window</code></em>);</pre>
 200 <p>
 201 Target the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> to use an existing external <a href="../gdk/gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a>
 202 </p>
 203 <div class="variablelist"><table border="0">
 204 <col align="left" valign="top">
 205 <tbody>
 206 <tr>
 207 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
 208 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
 209 </td>
 210 </tr>
 211 <tr>
 212 <td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
 213 <td>an existing <a href="../gdk/gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a>
 214 </td>
 215 </tr>
 216 <tr>
 217 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 218 <td>
 219 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if foreign window is valid</td>
 220 </tr>
 221 </tbody>
 222 </table></div>
 223 <p class="since">Since 1.10</p>
 224 </div>
 225 </div>
 226 </div>
 227 <div class="footer">
 228 <hr>
 229           Generated by GTK-Doc V1.18.1</div>
 230 </body>
 231 </html>