← Back to branch summary

~ubuntu-branches/debian/experimental/gtk+2.0/experimental

« back to all changes in this revision

Viewing changes to docs/reference/gtk/html/GtkEventBox.html

  • Committer: Package Import Robot
  • Author(s): Josselin Mouette
  • Date: 2011-09-02 17:17:47 UTC
  • mto: (72.4.15 sid)
  • mto: This revision was merged to the branch mainline in revision 102.
  • Revision ID: package-import@ubuntu.com-20110902171747-i8dr3czswn2sk7tu
Tags: upstream-2.24.6
Import upstream version 2.24.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gtk/html/GtkEventBox.html
49
49
struct              <a class="link" href="GtkEventBox.html#GtkEventBox-struct" title="struct GtkEventBox">GtkEventBox</a>;
50
50
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="GtkEventBox.html#gtk-event-box-new" title="gtk_event_box_new ()">gtk_event_box_new</a>                   (<em class="parameter"><code><span class="type">void</span></code></em>);
51
51
<span class="returnvalue">void</span>                <a class="link" href="GtkEventBox.html#gtk-event-box-set-above-child" title="gtk_event_box_set_above_child ()">gtk_event_box_set_above_child</a>       (<em class="parameter"><code><a class="link" href="GtkEventBox.html" title="GtkEventBox"><span class="type">GtkEventBox</span></a> *event_box</code></em>,
52
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> above_child</code></em>);
53
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GtkEventBox.html#gtk-event-box-get-above-child" title="gtk_event_box_get_above_child ()">gtk_event_box_get_above_child</a>       (<em class="parameter"><code><a class="link" href="GtkEventBox.html" title="GtkEventBox"><span class="type">GtkEventBox</span></a> *event_box</code></em>);
 
52
                                                         <em class="parameter"><code><span class="type">gboolean</span> above_child</code></em>);
 
53
<span class="returnvalue">gboolean</span>            <a class="link" href="GtkEventBox.html#gtk-event-box-get-above-child" title="gtk_event_box_get_above_child ()">gtk_event_box_get_above_child</a>       (<em class="parameter"><code><a class="link" href="GtkEventBox.html" title="GtkEventBox"><span class="type">GtkEventBox</span></a> *event_box</code></em>);
54
54
<span class="returnvalue">void</span>                <a class="link" href="GtkEventBox.html#gtk-event-box-set-visible-window" title="gtk_event_box_set_visible_window ()">gtk_event_box_set_visible_window</a>    (<em class="parameter"><code><a class="link" href="GtkEventBox.html" title="GtkEventBox"><span class="type">GtkEventBox</span></a> *event_box</code></em>,
55
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> visible_window</code></em>);
56
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GtkEventBox.html#gtk-event-box-get-visible-window" title="gtk_event_box_get_visible_window ()">gtk_event_box_get_visible_window</a>    (<em class="parameter"><code><a class="link" href="GtkEventBox.html" title="GtkEventBox"><span class="type">GtkEventBox</span></a> *event_box</code></em>);
 
55
                                                         <em class="parameter"><code><span class="type">gboolean</span> visible_window</code></em>);
 
56
<span class="returnvalue">gboolean</span>            <a class="link" href="GtkEventBox.html#gtk-event-box-get-visible-window" title="gtk_event_box_get_visible_window ()">gtk_event_box_get_visible_window</a>    (<em class="parameter"><code><a class="link" href="GtkEventBox.html" title="GtkEventBox"><span class="type">GtkEventBox</span></a> *event_box</code></em>);
57
57
</pre>
58
58
</div>
59
59
<div class="refsect1">
60
60
<a name="GtkEventBox.object-hierarchy"></a><h2>Object Hierarchy</h2>
61
61
<pre class="synopsis">
62
 
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
63
 
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
 
62
  GObject
 
63
   +----GInitiallyUnowned
64
64
         +----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
65
65
               +----<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
66
66
                     +----<a class="link" href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
77
77
<div class="refsect1">
78
78
<a name="GtkEventBox.properties"></a><h2>Properties</h2>
79
79
<pre class="synopsis">
80
 
  "<a class="link" href="GtkEventBox.html#GtkEventBox--above-child" title='The "above-child" property'>above-child</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
81
 
  "<a class="link" href="GtkEventBox.html#GtkEventBox--visible-window" title='The "visible-window" property'>visible-window</a>"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
 
80
  "<a class="link" href="GtkEventBox.html#GtkEventBox--above-child" title='The "above-child" property'>above-child</a>"              <span class="type">gboolean</span>              : Read / Write
 
81
  "<a class="link" href="GtkEventBox.html#GtkEventBox--visible-window" title='The "visible-window" property'>visible-window</a>"           <span class="type">gboolean</span>              : Read / Write
82
82
</pre>
83
83
</div>
84
84
<div class="refsect1">
118
118
<div class="refsect2">
119
119
<a name="gtk-event-box-set-above-child"></a><h3>gtk_event_box_set_above_child ()</h3>
120
120
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_event_box_set_above_child       (<em class="parameter"><code><a class="link" href="GtkEventBox.html" title="GtkEventBox"><span class="type">GtkEventBox</span></a> *event_box</code></em>,
121
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> above_child</code></em>);</pre>
 
121
                                                         <em class="parameter"><code><span class="type">gboolean</span> above_child</code></em>);</pre>
122
122
<p>
123
123
Set whether the event box window is positioned above the windows of its child,
124
124
as opposed to below it. If the window is above, all events inside the
140
140
<tr>
141
141
<td><p><span class="term"><em class="parameter"><code>above_child</code></em> :</span></p></td>
142
142
<td>
143
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the event box window is above the windows of its child</td>
 
143
<code class="literal">TRUE</code> if the event box window is above the windows of its child</td>
144
144
</tr>
145
145
</tbody>
146
146
</table></div>
149
149
<hr>
150
150
<div class="refsect2">
151
151
<a name="gtk-event-box-get-above-child"></a><h3>gtk_event_box_get_above_child ()</h3>
152
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gtk_event_box_get_above_child       (<em class="parameter"><code><a class="link" href="GtkEventBox.html" title="GtkEventBox"><span class="type">GtkEventBox</span></a> *event_box</code></em>);</pre>
 
152
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gtk_event_box_get_above_child       (<em class="parameter"><code><a class="link" href="GtkEventBox.html" title="GtkEventBox"><span class="type">GtkEventBox</span></a> *event_box</code></em>);</pre>
153
153
<p>
154
154
Returns whether the event box window is above or below the
155
155
windows of its child. See <a class="link" href="GtkEventBox.html#gtk-event-box-set-above-child" title="gtk_event_box_set_above_child ()"><code class="function">gtk_event_box_set_above_child()</code></a> for
166
166
<tr>
167
167
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
168
168
<td>
169
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the event box window is above the window
 
169
<code class="literal">TRUE</code> if the event box window is above the window
170
170
of its child.</td>
171
171
</tr>
172
172
</tbody>
177
177
<div class="refsect2">
178
178
<a name="gtk-event-box-set-visible-window"></a><h3>gtk_event_box_set_visible_window ()</h3>
179
179
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_event_box_set_visible_window    (<em class="parameter"><code><a class="link" href="GtkEventBox.html" title="GtkEventBox"><span class="type">GtkEventBox</span></a> *event_box</code></em>,
180
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> visible_window</code></em>);</pre>
 
180
                                                         <em class="parameter"><code><span class="type">gboolean</span> visible_window</code></em>);</pre>
181
181
<p>
182
182
Set whether the event box uses a visible or invisible child
183
183
window. The default is to use visible windows.
184
184
</p>
185
185
<p>
186
186
In an invisible window event box, the window that the
187
 
event box creates is a <a href="http://library.gnome.org/devel/gdk3/gdk-Windows.html#GDK-INPUT-ONLY:CAPS"><code class="literal">GDK_INPUT_ONLY</code></a> window, which 
 
187
event box creates is a <a href="../gdk/gdk-Windows.html#GDK-INPUT-ONLY:CAPS"><code class="literal">GDK_INPUT_ONLY</code></a> window, which 
188
188
means that it is invisible and only serves to receive
189
189
events.
190
190
</p>
191
191
<p>
192
 
A visible window event box creates a visible (<a href="http://library.gnome.org/devel/gdk3/gdk-Windows.html#GDK-INPUT-OUTPUT:CAPS"><code class="literal">GDK_INPUT_OUTPUT</code></a>)
 
192
A visible window event box creates a visible (<a href="../gdk/gdk-Windows.html#GDK-INPUT-OUTPUT:CAPS"><code class="literal">GDK_INPUT_OUTPUT</code></a>)
193
193
window that acts as the parent window for all the widgets  
194
194
contained in the event box.
195
195
</p>
245
245
<hr>
246
246
<div class="refsect2">
247
247
<a name="gtk-event-box-get-visible-window"></a><h3>gtk_event_box_get_visible_window ()</h3>
248
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gtk_event_box_get_visible_window    (<em class="parameter"><code><a class="link" href="GtkEventBox.html" title="GtkEventBox"><span class="type">GtkEventBox</span></a> *event_box</code></em>);</pre>
 
248
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gtk_event_box_get_visible_window    (<em class="parameter"><code><a class="link" href="GtkEventBox.html" title="GtkEventBox"><span class="type">GtkEventBox</span></a> *event_box</code></em>);</pre>
249
249
<p>
250
250
Returns whether the event box has a visible window.
251
251
See <a class="link" href="GtkEventBox.html#gtk-event-box-set-visible-window" title="gtk_event_box_set_visible_window ()"><code class="function">gtk_event_box_set_visible_window()</code></a> for details.
261
261
<tr>
262
262
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
263
263
<td>
264
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the event box window is visible</td>
 
264
<code class="literal">TRUE</code> if the event box window is visible</td>
265
265
</tr>
266
266
</tbody>
267
267
</table></div>
272
272
<a name="GtkEventBox.property-details"></a><h2>Property Details</h2>
273
273
<div class="refsect2">
274
274
<a name="GtkEventBox--above-child"></a><h3>The <code class="literal">"above-child"</code> property</h3>
275
 
<pre class="programlisting">  "above-child"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 
275
<pre class="programlisting">  "above-child"              <span class="type">gboolean</span>              : Read / Write</pre>
276
276
<p>Whether the event-trapping window of the eventbox is above the window of the child widget as opposed to below it.</p>
277
277
<p>Default value: FALSE</p>
278
278
</div>
279
279
<hr>
280
280
<div class="refsect2">
281
281
<a name="GtkEventBox--visible-window"></a><h3>The <code class="literal">"visible-window"</code> property</h3>
282
 
<pre class="programlisting">  "visible-window"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 
282
<pre class="programlisting">  "visible-window"           <span class="type">gboolean</span>              : Read / Write</pre>
283
283
<p>Whether the event box is visible, as opposed to invisible and only used to trap events.</p>
284
284
<p>Default value: TRUE</p>
285
285
</div>