1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>GtkHandleBox</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
7
<link rel="home" href="index.html" title="GTK+ 2 Reference Manual">
8
<link rel="up" href="MiscObjects.html" title="Miscellaneous">
9
<link rel="prev" href="GtkEventBox.html" title="GtkEventBox">
10
<link rel="next" href="GtkIMContextSimple.html" title="GtkIMContextSimple">
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
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">
17
<td><a accesskey="p" href="GtkEventBox.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
<td><a accesskey="u" href="MiscObjects.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">GTK+ 2 Reference Manual</th>
21
<td><a accesskey="n" href="GtkIMContextSimple.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
<tr><td colspan="5" class="shortcuts">
24
<a href="#GtkHandleBox.synopsis" class="shortcut">Top</a>
26
<a href="#GtkHandleBox.description" class="shortcut">Description</a>
28
<a href="#GtkHandleBox.object-hierarchy" class="shortcut">Object Hierarchy</a>
30
<a href="#GtkHandleBox.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
32
<a href="#GtkHandleBox.properties" class="shortcut">Properties</a>
34
<a href="#GtkHandleBox.signals" class="shortcut">Signals</a>
37
<div class="refentry">
38
<a name="GtkHandleBox"></a><div class="titlepage"></div>
39
<div class="refnamediv"><table width="100%"><tr>
41
<h2><span class="refentrytitle"><a name="GtkHandleBox.top_of_page"></a>GtkHandleBox</span></h2>
42
<p>GtkHandleBox — a widget for detachable window portions</p>
44
<td valign="top" align="right"></td>
46
<div class="refsynopsisdiv">
47
<a name="GtkHandleBox.synopsis"></a><h2>Synopsis</h2>
48
<pre class="synopsis">
49
#include <gtk/gtk.h>
51
struct <a class="link" href="GtkHandleBox.html#GtkHandleBox-struct" title="struct GtkHandleBox">GtkHandleBox</a>;
52
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GtkHandleBox.html#gtk-handle-box-new" title="gtk_handle_box_new ()">gtk_handle_box_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
53
<span class="returnvalue">void</span> <a class="link" href="GtkHandleBox.html#gtk-handle-box-set-shadow-type" title="gtk_handle_box_set_shadow_type ()">gtk_handle_box_set_shadow_type</a> (<em class="parameter"><code><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> *handle_box</code></em>,
54
<em class="parameter"><code><a class="link" href="gtk2-Standard-Enumerations.html#GtkShadowType" title="enum GtkShadowType"><span class="type">GtkShadowType</span></a> type</code></em>);
55
<span class="returnvalue">void</span> <a class="link" href="GtkHandleBox.html#gtk-handle-box-set-handle-position" title="gtk_handle_box_set_handle_position ()">gtk_handle_box_set_handle_position</a> (<em class="parameter"><code><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> *handle_box</code></em>,
56
<em class="parameter"><code><a class="link" href="gtk2-Standard-Enumerations.html#GtkPositionType" title="enum GtkPositionType"><span class="type">GtkPositionType</span></a> position</code></em>);
57
<span class="returnvalue">void</span> <a class="link" href="GtkHandleBox.html#gtk-handle-box-set-snap-edge" title="gtk_handle_box_set_snap_edge ()">gtk_handle_box_set_snap_edge</a> (<em class="parameter"><code><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> *handle_box</code></em>,
58
<em class="parameter"><code><a class="link" href="gtk2-Standard-Enumerations.html#GtkPositionType" title="enum GtkPositionType"><span class="type">GtkPositionType</span></a> edge</code></em>);
59
<a class="link" href="gtk2-Standard-Enumerations.html#GtkPositionType" title="enum GtkPositionType"><span class="returnvalue">GtkPositionType</span></a> <a class="link" href="GtkHandleBox.html#gtk-handle-box-get-handle-position" title="gtk_handle_box_get_handle_position ()">gtk_handle_box_get_handle_position</a> (<em class="parameter"><code><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> *handle_box</code></em>);
60
<a class="link" href="gtk2-Standard-Enumerations.html#GtkShadowType" title="enum GtkShadowType"><span class="returnvalue">GtkShadowType</span></a> <a class="link" href="GtkHandleBox.html#gtk-handle-box-get-shadow-type" title="gtk_handle_box_get_shadow_type ()">gtk_handle_box_get_shadow_type</a> (<em class="parameter"><code><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> *handle_box</code></em>);
61
<a class="link" href="gtk2-Standard-Enumerations.html#GtkPositionType" title="enum GtkPositionType"><span class="returnvalue">GtkPositionType</span></a> <a class="link" href="GtkHandleBox.html#gtk-handle-box-get-snap-edge" title="gtk_handle_box_get_snap_edge ()">gtk_handle_box_get_snap_edge</a> (<em class="parameter"><code><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> *handle_box</code></em>);
62
<span class="returnvalue">gboolean</span> <a class="link" href="GtkHandleBox.html#gtk-handle-box-get-child-detached" title="gtk_handle_box_get_child_detached ()">gtk_handle_box_get_child_detached</a> (<em class="parameter"><code><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> *handle_box</code></em>);
65
<div class="refsect1">
66
<a name="GtkHandleBox.object-hierarchy"></a><h2>Object Hierarchy</h2>
67
<pre class="synopsis">
69
+----GInitiallyUnowned
70
+----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
71
+----<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
72
+----<a class="link" href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
73
+----<a class="link" href="GtkBin.html" title="GtkBin">GtkBin</a>
77
<div class="refsect1">
78
<a name="GtkHandleBox.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
80
GtkHandleBox implements
81
AtkImplementorIface and <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a>.</p>
83
<div class="refsect1">
84
<a name="GtkHandleBox.properties"></a><h2>Properties</h2>
85
<pre class="synopsis">
86
"<a class="link" href="GtkHandleBox.html#GtkHandleBox--child-detached" title='The "child-detached" property'>child-detached</a>" <span class="type">gboolean</span> : Read
87
"<a class="link" href="GtkHandleBox.html#GtkHandleBox--handle-position" title='The "handle-position" property'>handle-position</a>" <a class="link" href="gtk2-Standard-Enumerations.html#GtkPositionType" title="enum GtkPositionType"><span class="type">GtkPositionType</span></a> : Read / Write
88
"<a class="link" href="GtkHandleBox.html#GtkHandleBox--shadow" title='The "shadow" property'>shadow</a>" <a class="link" href="gtk2-Standard-Enumerations.html#GtkShadowType" title="enum GtkShadowType"><span class="type">GtkShadowType</span></a> : Read / Write
89
"<a class="link" href="GtkHandleBox.html#GtkHandleBox--shadow-type" title='The "shadow-type" property'>shadow-type</a>" <a class="link" href="gtk2-Standard-Enumerations.html#GtkShadowType" title="enum GtkShadowType"><span class="type">GtkShadowType</span></a> : Read / Write
90
"<a class="link" href="GtkHandleBox.html#GtkHandleBox--snap-edge" title='The "snap-edge" property'>snap-edge</a>" <a class="link" href="gtk2-Standard-Enumerations.html#GtkPositionType" title="enum GtkPositionType"><span class="type">GtkPositionType</span></a> : Read / Write
91
"<a class="link" href="GtkHandleBox.html#GtkHandleBox--snap-edge-set" title='The "snap-edge-set" property'>snap-edge-set</a>" <span class="type">gboolean</span> : Read / Write
94
<div class="refsect1">
95
<a name="GtkHandleBox.signals"></a><h2>Signals</h2>
96
<pre class="synopsis">
97
"<a class="link" href="GtkHandleBox.html#GtkHandleBox-child-attached" title='The "child-attached" signal'>child-attached</a>" : <code class="literal">Run First</code>
98
"<a class="link" href="GtkHandleBox.html#GtkHandleBox-child-detached" title='The "child-detached" signal'>child-detached</a>" : <code class="literal">Run First</code>
101
<div class="refsect1">
102
<a name="GtkHandleBox.description"></a><h2>Description</h2>
104
The <a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> widget allows a portion of a window to be "torn
105
off". It is a bin widget which displays its child and a handle that
106
the user can drag to tear off a separate window (the <em class="firstterm">float
107
window</em>) containing the child widget. A thin
108
<em class="firstterm">ghost</em> is drawn in the original location of the
109
handlebox. By dragging the separate window back to its original
110
location, it can be reattached.
113
When reattaching, the ghost and float window, must be aligned
114
along one of the edges, the <em class="firstterm">snap edge</em>.
115
This either can be specified by the application programmer
116
explicitely, or GTK+ will pick a reasonable default based
117
on the handle position.
120
To make detaching and reattaching the handlebox as minimally confusing
121
as possible to the user, it is important to set the snap edge so that
122
the snap edge does not move when the handlebox is deattached. For
123
instance, if the handlebox is packed at the bottom of a VBox, then
124
when the handlebox is detached, the bottom edge of the handlebox's
125
allocation will remain fixed as the height of the handlebox shrinks,
126
so the snap edge should be set to <a class="link" href="gtk2-Standard-Enumerations.html#GTK-POS-BOTTOM:CAPS"><code class="literal">GTK_POS_BOTTOM</code></a>.
129
<div class="refsect1">
130
<a name="GtkHandleBox.details"></a><h2>Details</h2>
131
<div class="refsect2">
132
<a name="GtkHandleBox-struct"></a><h3>struct GtkHandleBox</h3>
133
<pre class="programlisting">struct GtkHandleBox;</pre>
135
The <a class="link" href="GtkHandleBox.html#GtkHandleBox-struct" title="struct GtkHandleBox"><span class="type">GtkHandleBox</span></a> struct contains the following fields.
136
(These fields should be considered read-only. They should never be set by
139
<div class="informaltable"><table width="100%" border="0">
146
<td>GtkShadowType shadow_type;</td>
147
<td>The shadow type for the entry. (See <a class="link" href="GtkHandleBox.html#gtk-handle-box-set-shadow-type" title="gtk_handle_box_set_shadow_type ()"><code class="function">gtk_handle_box_set_shadow_type()</code></a>).</td>
150
<td>GtkPositionType handle_position;</td>
151
<td>The position of the handlebox's handle with respect
152
to the child. (See <a class="link" href="GtkHandleBox.html#gtk-handle-box-set-handle-position" title="gtk_handle_box_set_handle_position ()"><code class="function">gtk_handle_box_set_handle_position()</code></a>)</td>
155
<td>gint snap_edge;</td>
156
<td>A value of type <span class="type">GtkPosition</span> type indicating snap edge for the widget.
157
(See gtk_handle_box_set_snap_edge). The value of -1 indicates
158
that this value has not been set.</td>
162
<span class="type">gboolean</span> child_detached;</td>
163
<td>A boolean value indicating whether the handlebox's
164
child is attached or detached.</td>
172
<div class="refsect2">
173
<a name="gtk-handle-box-new"></a><h3>gtk_handle_box_new ()</h3>
174
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * gtk_handle_box_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
176
Create a new handle box.
178
<div class="variablelist"><table border="0" class="variablelist">
180
<col align="left" valign="top">
184
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
185
<td>a new <a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a>.</td>
190
<div class="refsect2">
191
<a name="gtk-handle-box-set-shadow-type"></a><h3>gtk_handle_box_set_shadow_type ()</h3>
192
<pre class="programlisting"><span class="returnvalue">void</span> gtk_handle_box_set_shadow_type (<em class="parameter"><code><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> *handle_box</code></em>,
193
<em class="parameter"><code><a class="link" href="gtk2-Standard-Enumerations.html#GtkShadowType" title="enum GtkShadowType"><span class="type">GtkShadowType</span></a> type</code></em>);</pre>
195
Sets the type of shadow to be drawn around the border
198
<div class="variablelist"><table border="0" class="variablelist">
200
<col align="left" valign="top">
205
<td><p><span class="term"><em class="parameter"><code>handle_box</code></em> :</span></p></td>
206
<td>a <a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a>
210
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
211
<td>the shadow type.</td>
217
<div class="refsect2">
218
<a name="gtk-handle-box-set-handle-position"></a><h3>gtk_handle_box_set_handle_position ()</h3>
219
<pre class="programlisting"><span class="returnvalue">void</span> gtk_handle_box_set_handle_position (<em class="parameter"><code><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> *handle_box</code></em>,
220
<em class="parameter"><code><a class="link" href="gtk2-Standard-Enumerations.html#GtkPositionType" title="enum GtkPositionType"><span class="type">GtkPositionType</span></a> position</code></em>);</pre>
222
Sets the side of the handlebox where the handle is drawn.
224
<div class="variablelist"><table border="0" class="variablelist">
226
<col align="left" valign="top">
231
<td><p><span class="term"><em class="parameter"><code>handle_box</code></em> :</span></p></td>
232
<td>a <a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a>
236
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
237
<td>the side of the handlebox where the handle should be drawn.</td>
243
<div class="refsect2">
244
<a name="gtk-handle-box-set-snap-edge"></a><h3>gtk_handle_box_set_snap_edge ()</h3>
245
<pre class="programlisting"><span class="returnvalue">void</span> gtk_handle_box_set_snap_edge (<em class="parameter"><code><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> *handle_box</code></em>,
246
<em class="parameter"><code><a class="link" href="gtk2-Standard-Enumerations.html#GtkPositionType" title="enum GtkPositionType"><span class="type">GtkPositionType</span></a> edge</code></em>);</pre>
248
Sets the snap edge of a handlebox. The snap edge is
249
the edge of the detached child that must be aligned
250
with the corresponding edge of the "ghost" left
251
behind when the child was detached to reattach
252
the torn-off window. Usually, the snap edge should
253
be chosen so that it stays in the same place on
254
the screen when the handlebox is torn off.
257
If the snap edge is not set, then an appropriate value
258
will be guessed from the handle position. If the
259
handle position is <a class="link" href="gtk2-Standard-Enumerations.html#GTK-POS-RIGHT:CAPS"><code class="literal">GTK_POS_RIGHT</code></a> or <a class="link" href="gtk2-Standard-Enumerations.html#GTK-POS-LEFT:CAPS"><code class="literal">GTK_POS_LEFT</code></a>,
260
then the snap edge will be <a class="link" href="gtk2-Standard-Enumerations.html#GTK-POS-TOP:CAPS"><code class="literal">GTK_POS_TOP</code></a>, otherwise
261
it will be <a class="link" href="gtk2-Standard-Enumerations.html#GTK-POS-LEFT:CAPS"><code class="literal">GTK_POS_LEFT</code></a>.
263
<div class="variablelist"><table border="0" class="variablelist">
265
<col align="left" valign="top">
270
<td><p><span class="term"><em class="parameter"><code>handle_box</code></em> :</span></p></td>
271
<td>a <a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a>
275
<td><p><span class="term"><em class="parameter"><code>edge</code></em> :</span></p></td>
276
<td>the snap edge, or -1 to unset the value; in which
277
case GTK+ will try to guess an appropriate value
284
<div class="refsect2">
285
<a name="gtk-handle-box-get-handle-position"></a><h3>gtk_handle_box_get_handle_position ()</h3>
286
<pre class="programlisting"><a class="link" href="gtk2-Standard-Enumerations.html#GtkPositionType" title="enum GtkPositionType"><span class="returnvalue">GtkPositionType</span></a> gtk_handle_box_get_handle_position (<em class="parameter"><code><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> *handle_box</code></em>);</pre>
288
Gets the handle position of the handle box. See
289
<a class="link" href="GtkHandleBox.html#gtk-handle-box-set-handle-position" title="gtk_handle_box_set_handle_position ()"><code class="function">gtk_handle_box_set_handle_position()</code></a>.
291
<div class="variablelist"><table border="0" class="variablelist">
293
<col align="left" valign="top">
298
<td><p><span class="term"><em class="parameter"><code>handle_box</code></em> :</span></p></td>
299
<td>a <a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a>
303
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
304
<td>the current handle position.</td>
310
<div class="refsect2">
311
<a name="gtk-handle-box-get-shadow-type"></a><h3>gtk_handle_box_get_shadow_type ()</h3>
312
<pre class="programlisting"><a class="link" href="gtk2-Standard-Enumerations.html#GtkShadowType" title="enum GtkShadowType"><span class="returnvalue">GtkShadowType</span></a> gtk_handle_box_get_shadow_type (<em class="parameter"><code><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> *handle_box</code></em>);</pre>
314
Gets the type of shadow drawn around the handle box. See
315
<a class="link" href="GtkHandleBox.html#gtk-handle-box-set-shadow-type" title="gtk_handle_box_set_shadow_type ()"><code class="function">gtk_handle_box_set_shadow_type()</code></a>.
317
<div class="variablelist"><table border="0" class="variablelist">
319
<col align="left" valign="top">
324
<td><p><span class="term"><em class="parameter"><code>handle_box</code></em> :</span></p></td>
325
<td>a <a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a>
329
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
330
<td>the type of shadow currently drawn around the handle box.</td>
336
<div class="refsect2">
337
<a name="gtk-handle-box-get-snap-edge"></a><h3>gtk_handle_box_get_snap_edge ()</h3>
338
<pre class="programlisting"><a class="link" href="gtk2-Standard-Enumerations.html#GtkPositionType" title="enum GtkPositionType"><span class="returnvalue">GtkPositionType</span></a> gtk_handle_box_get_snap_edge (<em class="parameter"><code><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> *handle_box</code></em>);</pre>
340
Gets the edge used for determining reattachment of the handle box. See
341
<a class="link" href="GtkHandleBox.html#gtk-handle-box-set-snap-edge" title="gtk_handle_box_set_snap_edge ()"><code class="function">gtk_handle_box_set_snap_edge()</code></a>.
343
<div class="variablelist"><table border="0" class="variablelist">
345
<col align="left" valign="top">
350
<td><p><span class="term"><em class="parameter"><code>handle_box</code></em> :</span></p></td>
351
<td>a <a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a>
355
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
356
<td>the edge used for determining reattachment, or (GtkPositionType)-1 if this
357
is determined (as per default) from the handle position.</td>
363
<div class="refsect2">
364
<a name="gtk-handle-box-get-child-detached"></a><h3>gtk_handle_box_get_child_detached ()</h3>
365
<pre class="programlisting"><span class="returnvalue">gboolean</span> gtk_handle_box_get_child_detached (<em class="parameter"><code><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> *handle_box</code></em>);</pre>
367
Whether the handlebox's child is currently detached.
369
<div class="variablelist"><table border="0" class="variablelist">
371
<col align="left" valign="top">
376
<td><p><span class="term"><em class="parameter"><code>handle_box</code></em> :</span></p></td>
377
<td>a <a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a>
381
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
383
<code class="literal">TRUE</code> if the child is currently detached, otherwise <code class="literal">FALSE</code>
388
<p class="since">Since 2.14</p>
391
<div class="refsect1">
392
<a name="GtkHandleBox.property-details"></a><h2>Property Details</h2>
393
<div class="refsect2">
394
<a name="GtkHandleBox--child-detached"></a><h3>The <code class="literal">"child-detached"</code> property</h3>
395
<pre class="programlisting"> "child-detached" <span class="type">gboolean</span> : Read</pre>
396
<p>A boolean value indicating whether the handlebox's child is attached or detached.</p>
397
<p>Default value: FALSE</p>
400
<div class="refsect2">
401
<a name="GtkHandleBox--handle-position"></a><h3>The <code class="literal">"handle-position"</code> property</h3>
402
<pre class="programlisting"> "handle-position" <a class="link" href="gtk2-Standard-Enumerations.html#GtkPositionType" title="enum GtkPositionType"><span class="type">GtkPositionType</span></a> : Read / Write</pre>
403
<p>Position of the handle relative to the child widget.</p>
404
<p>Default value: GTK_POS_LEFT</p>
407
<div class="refsect2">
408
<a name="GtkHandleBox--shadow"></a><h3>The <code class="literal">"shadow"</code> property</h3>
409
<pre class="programlisting"> "shadow" <a class="link" href="gtk2-Standard-Enumerations.html#GtkShadowType" title="enum GtkShadowType"><span class="type">GtkShadowType</span></a> : Read / Write</pre>
410
<p>Deprecated property, use shadow_type instead.</p>
411
<p>Default value: GTK_SHADOW_OUT</p>
414
<div class="refsect2">
415
<a name="GtkHandleBox--shadow-type"></a><h3>The <code class="literal">"shadow-type"</code> property</h3>
416
<pre class="programlisting"> "shadow-type" <a class="link" href="gtk2-Standard-Enumerations.html#GtkShadowType" title="enum GtkShadowType"><span class="type">GtkShadowType</span></a> : Read / Write</pre>
417
<p>Appearance of the shadow that surrounds the container.</p>
418
<p>Default value: GTK_SHADOW_OUT</p>
421
<div class="refsect2">
422
<a name="GtkHandleBox--snap-edge"></a><h3>The <code class="literal">"snap-edge"</code> property</h3>
423
<pre class="programlisting"> "snap-edge" <a class="link" href="gtk2-Standard-Enumerations.html#GtkPositionType" title="enum GtkPositionType"><span class="type">GtkPositionType</span></a> : Read / Write</pre>
424
<p>Side of the handlebox that's lined up with the docking point to dock the handlebox.</p>
425
<p>Default value: GTK_POS_TOP</p>
428
<div class="refsect2">
429
<a name="GtkHandleBox--snap-edge-set"></a><h3>The <code class="literal">"snap-edge-set"</code> property</h3>
430
<pre class="programlisting"> "snap-edge-set" <span class="type">gboolean</span> : Read / Write</pre>
431
<p>Whether to use the value from the snap_edge property or a value derived from handle_position.</p>
432
<p>Default value: FALSE</p>
435
<div class="refsect1">
436
<a name="GtkHandleBox.signal-details"></a><h2>Signal Details</h2>
437
<div class="refsect2">
438
<a name="GtkHandleBox-child-attached"></a><h3>The <code class="literal">"child-attached"</code> signal</h3>
439
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> *handlebox,
440
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget,
441
<span class="type">gpointer</span> user_data) : <code class="literal">Run First</code></pre>
443
This signal is emitted when the contents of the
444
handlebox are reattached to the main window.
446
<div class="variablelist"><table border="0" class="variablelist">
448
<col align="left" valign="top">
453
<td><p><span class="term"><em class="parameter"><code>handlebox</code></em> :</span></p></td>
454
<td>the object which received the signal.</td>
457
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
458
<td>the child widget of the handlebox.
459
(this argument provides no extra information
460
and is here only for backwards-compatibility)</td>
463
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
464
<td>user data set when the signal handler was connected.</td>
470
<div class="refsect2">
471
<a name="GtkHandleBox-child-detached"></a><h3>The <code class="literal">"child-detached"</code> signal</h3>
472
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> *handlebox,
473
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget,
474
<span class="type">gpointer</span> user_data) : <code class="literal">Run First</code></pre>
476
This signal is emitted when the contents of the
477
handlebox are detached from the main window.
479
<div class="variablelist"><table border="0" class="variablelist">
481
<col align="left" valign="top">
486
<td><p><span class="term"><em class="parameter"><code>handlebox</code></em> :</span></p></td>
487
<td>the object which received the signal.</td>
490
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
491
<td>the child widget of the handlebox.
492
(this argument provides no extra information
493
and is here only for backwards-compatibility)</td>
496
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
497
<td>user data set when the signal handler was connected.</td>
506
Generated by GTK-Doc V1.18</div>
b'\\ No newline at end of file'
added
removed
share/gtk-doc/html/gtk2/GtkHandleBox.html
