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>GtkPaned</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="AbstractObjects.html" title="Abstract Base Classes">
9
<link rel="prev" href="GtkObject.html" title="GtkObject">
10
<link rel="next" href="GtkRange.html" title="GtkRange">
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="GtkObject.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
<td><a accesskey="u" href="AbstractObjects.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="GtkRange.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="#GtkPaned.synopsis" class="shortcut">Top</a>
26
<a href="#GtkPaned.description" class="shortcut">Description</a>
28
<a href="#GtkPaned.object-hierarchy" class="shortcut">Object Hierarchy</a>
30
<a href="#GtkPaned.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
32
<a href="#GtkPaned.properties" class="shortcut">Properties</a>
34
<a href="#GtkPaned.child-properties" class="shortcut">Child Properties</a>
36
<a href="#GtkPaned.style-properties" class="shortcut">Style Properties</a>
38
<a href="#GtkPaned.signals" class="shortcut">Signals</a>
41
<div class="refentry">
42
<a name="GtkPaned"></a><div class="titlepage"></div>
43
<div class="refnamediv"><table width="100%"><tr>
45
<h2><span class="refentrytitle"><a name="GtkPaned.top_of_page"></a>GtkPaned</span></h2>
46
<p>GtkPaned — Base class for widgets with two adjustable panes</p>
48
<td valign="top" align="right"><img src="panes.png"></td>
50
<div class="refsynopsisdiv">
51
<a name="GtkPaned.synopsis"></a><h2>Synopsis</h2>
52
<pre class="synopsis">
53
#include <gtk/gtk.h>
55
struct <a class="link" href="GtkPaned.html#GtkPaned-struct" title="struct GtkPaned">GtkPaned</a>;
56
<span class="returnvalue">void</span> <a class="link" href="GtkPaned.html#gtk-paned-add1" title="gtk_paned_add1 ()">gtk_paned_add1</a> (<em class="parameter"><code><a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> *paned</code></em>,
57
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *child</code></em>);
58
<span class="returnvalue">void</span> <a class="link" href="GtkPaned.html#gtk-paned-add2" title="gtk_paned_add2 ()">gtk_paned_add2</a> (<em class="parameter"><code><a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> *paned</code></em>,
59
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *child</code></em>);
60
#define <a class="link" href="GtkPaned.html#gtk-paned-gutter-size" title="gtk_paned_gutter_size()">gtk_paned_gutter_size</a> (p,
62
<span class="returnvalue">void</span> <a class="link" href="GtkPaned.html#gtk-paned-pack1" title="gtk_paned_pack1 ()">gtk_paned_pack1</a> (<em class="parameter"><code><a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> *paned</code></em>,
63
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *child</code></em>,
64
<em class="parameter"><code><span class="type">gboolean</span> resize</code></em>,
65
<em class="parameter"><code><span class="type">gboolean</span> shrink</code></em>);
66
<span class="returnvalue">void</span> <a class="link" href="GtkPaned.html#gtk-paned-pack2" title="gtk_paned_pack2 ()">gtk_paned_pack2</a> (<em class="parameter"><code><a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> *paned</code></em>,
67
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *child</code></em>,
68
<em class="parameter"><code><span class="type">gboolean</span> resize</code></em>,
69
<em class="parameter"><code><span class="type">gboolean</span> shrink</code></em>);
70
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GtkPaned.html#gtk-paned-get-child1" title="gtk_paned_get_child1 ()">gtk_paned_get_child1</a> (<em class="parameter"><code><a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> *paned</code></em>);
71
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GtkPaned.html#gtk-paned-get-child2" title="gtk_paned_get_child2 ()">gtk_paned_get_child2</a> (<em class="parameter"><code><a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> *paned</code></em>);
72
#define <a class="link" href="GtkPaned.html#gtk-paned-set-gutter-size" title="gtk_paned_set_gutter_size()">gtk_paned_set_gutter_size</a> (p,
74
<span class="returnvalue">void</span> <a class="link" href="GtkPaned.html#gtk-paned-set-position" title="gtk_paned_set_position ()">gtk_paned_set_position</a> (<em class="parameter"><code><a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> *paned</code></em>,
75
<em class="parameter"><code><span class="type">gint</span> position</code></em>);
76
<span class="returnvalue">gint</span> <a class="link" href="GtkPaned.html#gtk-paned-get-position" title="gtk_paned_get_position ()">gtk_paned_get_position</a> (<em class="parameter"><code><a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> *paned</code></em>);
77
<a href="../gdk2/gdk2-Windows.html#GdkWindow"><span class="returnvalue">GdkWindow</span></a> * <a class="link" href="GtkPaned.html#gtk-paned-get-handle-window" title="gtk_paned_get_handle_window ()">gtk_paned_get_handle_window</a> (<em class="parameter"><code><a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> *paned</code></em>);
80
<div class="refsect1">
81
<a name="GtkPaned.object-hierarchy"></a><h2>Object Hierarchy</h2>
82
<pre class="synopsis">
84
+----GInitiallyUnowned
85
+----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
86
+----<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
87
+----<a class="link" href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
89
+----<a class="link" href="GtkHPaned.html" title="GtkHPaned">GtkHPaned</a>
90
+----<a class="link" href="GtkVPaned.html" title="GtkVPaned">GtkVPaned</a>
93
<div class="refsect1">
94
<a name="GtkPaned.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
97
AtkImplementorIface, <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a> and <a class="link" href="gtk2-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
99
<div class="refsect1">
100
<a name="GtkPaned.properties"></a><h2>Properties</h2>
101
<pre class="synopsis">
102
"<a class="link" href="GtkPaned.html#GtkPaned--max-position" title='The "max-position" property'>max-position</a>" <span class="type">gint</span> : Read
103
"<a class="link" href="GtkPaned.html#GtkPaned--min-position" title='The "min-position" property'>min-position</a>" <span class="type">gint</span> : Read
104
"<a class="link" href="GtkPaned.html#GtkPaned--position" title='The "position" property'>position</a>" <span class="type">gint</span> : Read / Write
105
"<a class="link" href="GtkPaned.html#GtkPaned--position-set" title='The "position-set" property'>position-set</a>" <span class="type">gboolean</span> : Read / Write
108
<div class="refsect1">
109
<a name="GtkPaned.child-properties"></a><h2>Child Properties</h2>
110
<pre class="synopsis">
111
"<a class="link" href="GtkPaned.html#GtkPaned--c-resize" title='The "resize" child property'>resize</a>" <span class="type">gboolean</span> : Read / Write
112
"<a class="link" href="GtkPaned.html#GtkPaned--c-shrink" title='The "shrink" child property'>shrink</a>" <span class="type">gboolean</span> : Read / Write
115
<div class="refsect1">
116
<a name="GtkPaned.style-properties"></a><h2>Style Properties</h2>
117
<pre class="synopsis">
118
"<a class="link" href="GtkPaned.html#GtkPaned--s-handle-size" title='The "handle-size" style property'>handle-size</a>" <span class="type">gint</span> : Read
121
<div class="refsect1">
122
<a name="GtkPaned.signals"></a><h2>Signals</h2>
123
<pre class="synopsis">
124
"<a class="link" href="GtkPaned.html#GtkPaned-accept-position" title='The "accept-position" signal'>accept-position</a>" : <code class="literal">Action</code>
125
"<a class="link" href="GtkPaned.html#GtkPaned-cancel-position" title='The "cancel-position" signal'>cancel-position</a>" : <code class="literal">Action</code>
126
"<a class="link" href="GtkPaned.html#GtkPaned-cycle-child-focus" title='The "cycle-child-focus" signal'>cycle-child-focus</a>" : <code class="literal">Action</code>
127
"<a class="link" href="GtkPaned.html#GtkPaned-cycle-handle-focus" title='The "cycle-handle-focus" signal'>cycle-handle-focus</a>" : <code class="literal">Action</code>
128
"<a class="link" href="GtkPaned.html#GtkPaned-move-handle" title='The "move-handle" signal'>move-handle</a>" : <code class="literal">Action</code>
129
"<a class="link" href="GtkPaned.html#GtkPaned-toggle-handle-focus" title='The "toggle-handle-focus" signal'>toggle-handle-focus</a>" : <code class="literal">Action</code>
132
<div class="refsect1">
133
<a name="GtkPaned.description"></a><h2>Description</h2>
135
<a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> is the base class for widgets with two panes,
136
arranged either horizontally (<a class="link" href="GtkHPaned.html" title="GtkHPaned"><span class="type">GtkHPaned</span></a>) or
137
vertically (<a class="link" href="GtkVPaned.html" title="GtkVPaned"><span class="type">GtkVPaned</span></a>). Child widgets are
138
added to the panes of the widget with
139
<a class="link" href="GtkPaned.html#gtk-paned-pack1" title="gtk_paned_pack1 ()"><code class="function">gtk_paned_pack1()</code></a> and <a class="link" href="GtkPaned.html#gtk-paned-pack2" title="gtk_paned_pack2 ()"><code class="function">gtk_paned_pack2()</code></a>. The division
140
beween the two children is set by default from the
141
size requests of the children, but it can be adjusted
145
A paned widget draws a separator between the two
146
child widgets and a small handle that the user
147
can drag to adjust the division. It does not
148
draw any relief around the children or around
149
the separator. (The space in which the separator
150
is called the gutter.) Often, it is useful
151
to put each child inside a <a class="link" href="GtkFrame.html" title="GtkFrame"><span class="type">GtkFrame</span></a> with the
152
shadow type set to <a class="link" href="gtk2-Standard-Enumerations.html#GTK-SHADOW-IN:CAPS"><code class="literal">GTK_SHADOW_IN</code></a> so that the
153
gutter appears as a ridge. No separator is drawn
154
if one of the children is missing.
157
Each child has two options that can be set,
158
<em class="parameter"><code>resize</code></em> and <em class="parameter"><code>shrink</code></em>. If <em class="parameter"><code>resize</code></em> is true, then when the
159
<a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> is resized, that child will expand
160
or shrink along with the paned widget. If <em class="parameter"><code>shrink</code></em>
161
is true, then when that child can be made smaller
162
than its requisition by the user. Setting <em class="parameter"><code>shrink</code></em>
163
to <code class="literal">FALSE</code> allows the application to set a minimum
164
size. If <em class="parameter"><code>resize</code></em> is false for both children, then
165
this is treated as if <em class="parameter"><code>resize</code></em> is true for both
169
The application can set the position of the slider
170
as if it were set by the user, by calling
171
<a class="link" href="GtkPaned.html#gtk-paned-set-position" title="gtk_paned_set_position ()"><code class="function">gtk_paned_set_position()</code></a>.
173
<div class="example">
174
<a name="idp102495872"></a><p class="title"><b>Example 56. Creating a paned widget with minimum sizes.</b></p>
175
<div class="example-contents">
176
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
179
<td class="listing_lines" align="right"><pre>1
189
<td class="listing_code"><pre class="programlisting"><span class="usertype">GtkWidget</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">hpaned </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkHPaned.html#gtk-hpaned-new">gtk_hpaned_new</a></span><span class="normal"> </span><span class="symbol">();</span>
190
<span class="usertype">GtkWidget</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">frame1 </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkFrame.html#gtk-frame-new">gtk_frame_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span>
191
<span class="usertype">GtkWidget</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">frame2 </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkFrame.html#gtk-frame-new">gtk_frame_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span>
192
<span class="function"><a href="GtkFrame.html#gtk-frame-set-shadow-type">gtk_frame_set_shadow_type</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_FRAME</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">frame1</span><span class="symbol">),</span><span class="normal"> <a href="gtk2-Standard-Enumerations.html#GTK-SHADOW-IN:CAPS">GTK_SHADOW_IN</a></span><span class="symbol">);</span>
193
<span class="function"><a href="GtkFrame.html#gtk-frame-set-shadow-type">gtk_frame_set_shadow_type</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_FRAME</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">frame2</span><span class="symbol">),</span><span class="normal"> <a href="gtk2-Standard-Enumerations.html#GTK-SHADOW-IN:CAPS">GTK_SHADOW_IN</a></span><span class="symbol">);</span>
194
<span class="function"><a href="GtkWidget.html#gtk-widget-set-size-request">gtk_widget_set_size_request</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">hpaned</span><span class="symbol">,</span><span class="normal"> </span><span class="number">200</span><span class="normal"> </span><span class="symbol">+</span><span class="normal"> </span><span class="function">GTK_PANED</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">hpaned</span><span class="symbol">)-></span><span class="normal">gutter_size</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">-</span><span class="number">1</span><span class="symbol">);</span>
195
<span class="function"><a href="GtkPaned.html#gtk-paned-pack1">gtk_paned_pack1</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_PANED</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">hpaned</span><span class="symbol">),</span><span class="normal"> frame1</span><span class="symbol">,</span><span class="normal"> TRUE</span><span class="symbol">,</span><span class="normal"> FALSE</span><span class="symbol">);</span>
196
<span class="function"><a href="GtkWidget.html#gtk-widget-set-size-request">gtk_widget_set_size_request</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">frame1</span><span class="symbol">,</span><span class="normal"> </span><span class="number">50</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">-</span><span class="number">1</span><span class="symbol">);</span>
197
<span class="function"><a href="GtkPaned.html#gtk-paned-pack2">gtk_paned_pack2</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_PANED</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">hpaned</span><span class="symbol">),</span><span class="normal"> frame2</span><span class="symbol">,</span><span class="normal"> FALSE</span><span class="symbol">,</span><span class="normal"> FALSE</span><span class="symbol">);</span>
198
<span class="function"><a href="GtkWidget.html#gtk-widget-set-size-request">gtk_widget_set_size_request</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">frame2</span><span class="symbol">,</span><span class="normal"> </span><span class="number">50</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">-</span><span class="number">1</span><span class="symbol">);</span></pre></td>
205
<br class="example-break">
207
<div class="refsect1">
208
<a name="GtkPaned.details"></a><h2>Details</h2>
209
<div class="refsect2">
210
<a name="GtkPaned-struct"></a><h3>struct GtkPaned</h3>
211
<pre class="programlisting">struct GtkPaned;</pre>
216
<div class="refsect2">
217
<a name="gtk-paned-add1"></a><h3>gtk_paned_add1 ()</h3>
218
<pre class="programlisting"><span class="returnvalue">void</span> gtk_paned_add1 (<em class="parameter"><code><a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> *paned</code></em>,
219
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *child</code></em>);</pre>
221
Adds a child to the top or left pane with
222
default parameters. This is equivalent
223
to <code class="literal">gtk_paned_pack1 (paned, child, FALSE, TRUE)</code>.
225
<div class="variablelist"><table border="0" class="variablelist">
227
<col align="left" valign="top">
232
<td><p><span class="term"><em class="parameter"><code>paned</code></em> :</span></p></td>
233
<td>a paned widget</td>
236
<td><p><span class="term"><em class="parameter"><code>child</code></em> :</span></p></td>
237
<td>the child to add</td>
243
<div class="refsect2">
244
<a name="gtk-paned-add2"></a><h3>gtk_paned_add2 ()</h3>
245
<pre class="programlisting"><span class="returnvalue">void</span> gtk_paned_add2 (<em class="parameter"><code><a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> *paned</code></em>,
246
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *child</code></em>);</pre>
248
Adds a child to the bottom or right pane with default
249
parameters. This is equivalent to
250
<code class="literal">gtk_paned_pack2 (paned, child, TRUE, TRUE)</code>.
252
<div class="variablelist"><table border="0" class="variablelist">
254
<col align="left" valign="top">
259
<td><p><span class="term"><em class="parameter"><code>paned</code></em> :</span></p></td>
260
<td>a paned widget</td>
263
<td><p><span class="term"><em class="parameter"><code>child</code></em> :</span></p></td>
264
<td>the child to add</td>
270
<div class="refsect2">
271
<a name="gtk-paned-gutter-size"></a><h3>gtk_paned_gutter_size()</h3>
272
<pre class="programlisting">#define gtk_paned_gutter_size(p,s) (void) 0
274
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
275
<h3 class="title">Warning</h3>
276
<p><code class="literal">gtk_paned_gutter_size</code> is deprecated and should not be used in newly-written code.</p>
279
Old name for <a class="link" href="GtkPaned.html#gtk-paned-set-gutter-size" title="gtk_paned_set_gutter_size()"><code class="function">gtk_paned_set_gutter_size()</code></a>.
281
<div class="variablelist"><table border="0" class="variablelist">
283
<col align="left" valign="top">
288
<td><p><span class="term"><em class="parameter"><code>p</code></em> :</span></p></td>
289
<td>a paned widget</td>
292
<td><p><span class="term"><em class="parameter"><code>s</code></em> :</span></p></td>
293
<td>the width of the gutter in pixels</td>
299
<div class="refsect2">
300
<a name="gtk-paned-pack1"></a><h3>gtk_paned_pack1 ()</h3>
301
<pre class="programlisting"><span class="returnvalue">void</span> gtk_paned_pack1 (<em class="parameter"><code><a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> *paned</code></em>,
302
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *child</code></em>,
303
<em class="parameter"><code><span class="type">gboolean</span> resize</code></em>,
304
<em class="parameter"><code><span class="type">gboolean</span> shrink</code></em>);</pre>
306
Adds a child to the top or left pane.
308
<div class="variablelist"><table border="0" class="variablelist">
310
<col align="left" valign="top">
315
<td><p><span class="term"><em class="parameter"><code>paned</code></em> :</span></p></td>
316
<td>a paned widget</td>
319
<td><p><span class="term"><em class="parameter"><code>child</code></em> :</span></p></td>
320
<td>the child to add</td>
323
<td><p><span class="term"><em class="parameter"><code>resize</code></em> :</span></p></td>
324
<td>should this child expand when the paned widget is resized.</td>
327
<td><p><span class="term"><em class="parameter"><code>shrink</code></em> :</span></p></td>
328
<td>can this child be made smaller than its requisition.</td>
334
<div class="refsect2">
335
<a name="gtk-paned-pack2"></a><h3>gtk_paned_pack2 ()</h3>
336
<pre class="programlisting"><span class="returnvalue">void</span> gtk_paned_pack2 (<em class="parameter"><code><a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> *paned</code></em>,
337
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *child</code></em>,
338
<em class="parameter"><code><span class="type">gboolean</span> resize</code></em>,
339
<em class="parameter"><code><span class="type">gboolean</span> shrink</code></em>);</pre>
341
Adds a child to the bottom or right pane.
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>paned</code></em> :</span></p></td>
351
<td>a paned widget</td>
354
<td><p><span class="term"><em class="parameter"><code>child</code></em> :</span></p></td>
355
<td>the child to add</td>
358
<td><p><span class="term"><em class="parameter"><code>resize</code></em> :</span></p></td>
359
<td>should this child expand when the paned widget is resized.</td>
362
<td><p><span class="term"><em class="parameter"><code>shrink</code></em> :</span></p></td>
363
<td>can this child be made smaller than its requisition.</td>
369
<div class="refsect2">
370
<a name="gtk-paned-get-child1"></a><h3>gtk_paned_get_child1 ()</h3>
371
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * gtk_paned_get_child1 (<em class="parameter"><code><a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> *paned</code></em>);</pre>
373
Obtains the first child of the paned widget.
375
<div class="variablelist"><table border="0" class="variablelist">
377
<col align="left" valign="top">
382
<td><p><span class="term"><em class="parameter"><code>paned</code></em> :</span></p></td>
383
<td>a <a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> widget</td>
386
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
387
<td>first child, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if it is not set. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
392
<p class="since">Since 2.4</p>
395
<div class="refsect2">
396
<a name="gtk-paned-get-child2"></a><h3>gtk_paned_get_child2 ()</h3>
397
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * gtk_paned_get_child2 (<em class="parameter"><code><a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> *paned</code></em>);</pre>
399
Obtains the second child of the paned widget.
401
<div class="variablelist"><table border="0" class="variablelist">
403
<col align="left" valign="top">
408
<td><p><span class="term"><em class="parameter"><code>paned</code></em> :</span></p></td>
409
<td>a <a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> widget</td>
412
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
413
<td>second child, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if it is not set. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
418
<p class="since">Since 2.4</p>
421
<div class="refsect2">
422
<a name="gtk-paned-set-gutter-size"></a><h3>gtk_paned_set_gutter_size()</h3>
423
<pre class="programlisting">#define gtk_paned_set_gutter_size(p,s) (void) 0
425
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
426
<h3 class="title">Warning</h3>
427
<p><code class="literal">gtk_paned_set_gutter_size</code> is deprecated and should not be used in newly-written code.</p>
430
In older versions of GTK+, this function used to set the width of the
431
gutter (the area between the two panes). It does nothing now.
433
<div class="variablelist"><table border="0" class="variablelist">
435
<col align="left" valign="top">
440
<td><p><span class="term"><em class="parameter"><code>p</code></em> :</span></p></td>
441
<td>a paned widget</td>
444
<td><p><span class="term"><em class="parameter"><code>s</code></em> :</span></p></td>
445
<td>the width of the gutter in pixels</td>
451
<div class="refsect2">
452
<a name="gtk-paned-set-position"></a><h3>gtk_paned_set_position ()</h3>
453
<pre class="programlisting"><span class="returnvalue">void</span> gtk_paned_set_position (<em class="parameter"><code><a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> *paned</code></em>,
454
<em class="parameter"><code><span class="type">gint</span> position</code></em>);</pre>
456
Sets the position of the divider between the two panes.
458
<div class="variablelist"><table border="0" class="variablelist">
460
<col align="left" valign="top">
465
<td><p><span class="term"><em class="parameter"><code>paned</code></em> :</span></p></td>
466
<td>a <a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> widget</td>
469
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
470
<td>pixel position of divider, a negative value means that the position
477
<div class="refsect2">
478
<a name="gtk-paned-get-position"></a><h3>gtk_paned_get_position ()</h3>
479
<pre class="programlisting"><span class="returnvalue">gint</span> gtk_paned_get_position (<em class="parameter"><code><a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> *paned</code></em>);</pre>
481
Obtains the position of the divider between the two panes.
483
<div class="variablelist"><table border="0" class="variablelist">
485
<col align="left" valign="top">
490
<td><p><span class="term"><em class="parameter"><code>paned</code></em> :</span></p></td>
491
<td>a <a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> widget</td>
494
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
495
<td>position of the divider</td>
501
<div class="refsect2">
502
<a name="gtk-paned-get-handle-window"></a><h3>gtk_paned_get_handle_window ()</h3>
503
<pre class="programlisting"><a href="../gdk2/gdk2-Windows.html#GdkWindow"><span class="returnvalue">GdkWindow</span></a> * gtk_paned_get_handle_window (<em class="parameter"><code><a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> *paned</code></em>);</pre>
505
Returns the <a href="../gdk2/gdk2-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a> of the handle. This function is
506
useful when handling button or motion events because it
507
enables the callback to distinguish between the window
508
of the paned, a child and the handle.
510
<div class="variablelist"><table border="0" class="variablelist">
512
<col align="left" valign="top">
516
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
517
<td>the paned's handle window. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
521
<p class="since">Since 2.20</p>
524
<div class="refsect1">
525
<a name="GtkPaned.property-details"></a><h2>Property Details</h2>
526
<div class="refsect2">
527
<a name="GtkPaned--max-position"></a><h3>The <code class="literal">"max-position"</code> property</h3>
528
<pre class="programlisting"> "max-position" <span class="type">gint</span> : Read</pre>
530
The largest possible value for the position property. This property is derived from the
531
size and shrinkability of the widget's children.
533
<p>Allowed values: >= 0</p>
534
<p>Default value: 2147483647</p>
535
<p class="since">Since 2.4</p>
538
<div class="refsect2">
539
<a name="GtkPaned--min-position"></a><h3>The <code class="literal">"min-position"</code> property</h3>
540
<pre class="programlisting"> "min-position" <span class="type">gint</span> : Read</pre>
542
The smallest possible value for the position property. This property is derived from the
543
size and shrinkability of the widget's children.
545
<p>Allowed values: >= 0</p>
546
<p>Default value: 0</p>
547
<p class="since">Since 2.4</p>
550
<div class="refsect2">
551
<a name="GtkPaned--position"></a><h3>The <code class="literal">"position"</code> property</h3>
552
<pre class="programlisting"> "position" <span class="type">gint</span> : Read / Write</pre>
553
<p>Position of paned separator in pixels (0 means all the way to the left/top).</p>
554
<p>Allowed values: >= 0</p>
555
<p>Default value: 0</p>
558
<div class="refsect2">
559
<a name="GtkPaned--position-set"></a><h3>The <code class="literal">"position-set"</code> property</h3>
560
<pre class="programlisting"> "position-set" <span class="type">gboolean</span> : Read / Write</pre>
561
<p>TRUE if the Position property should be used.</p>
562
<p>Default value: FALSE</p>
565
<div class="refsect1">
566
<a name="GtkPaned.child-property-details"></a><h2>Child Property Details</h2>
567
<div class="refsect2">
568
<a name="GtkPaned--c-resize"></a><h3>The <code class="literal">"resize"</code> child property</h3>
569
<pre class="programlisting"> "resize" <span class="type">gboolean</span> : Read / Write</pre>
571
The "resize" child property determines whether the child expands and
572
shrinks along with the paned widget.
574
<p>Default value: TRUE</p>
575
<p class="since">Since 2.4</p>
578
<div class="refsect2">
579
<a name="GtkPaned--c-shrink"></a><h3>The <code class="literal">"shrink"</code> child property</h3>
580
<pre class="programlisting"> "shrink" <span class="type">gboolean</span> : Read / Write</pre>
582
The "shrink" child property determines whether the child can be made
583
smaller than its requisition.
585
<p>Default value: TRUE</p>
586
<p class="since">Since 2.4</p>
589
<div class="refsect1">
590
<a name="GtkPaned.style-property-details"></a><h2>Style Property Details</h2>
591
<div class="refsect2">
592
<a name="GtkPaned--s-handle-size"></a><h3>The <code class="literal">"handle-size"</code> style property</h3>
593
<pre class="programlisting"> "handle-size" <span class="type">gint</span> : Read</pre>
594
<p>Width of handle.</p>
595
<p>Allowed values: >= 0</p>
596
<p>Default value: 5</p>
599
<div class="refsect1">
600
<a name="GtkPaned.signal-details"></a><h2>Signal Details</h2>
601
<div class="refsect2">
602
<a name="GtkPaned-accept-position"></a><h3>The <code class="literal">"accept-position"</code> signal</h3>
603
<pre class="programlisting"><span class="returnvalue">gboolean</span> user_function (<a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> *widget,
604
<span class="type">gpointer</span> user_data) : <code class="literal">Action</code></pre>
606
The ::accept-position signal is a
607
<a class="link" href="gtk2-Bindings.html#keybinding-signals">keybinding signal</a>
608
which gets emitted to accept the current position of the handle when
609
moving it using key bindings.
612
The default binding for this signal is Return or Space.
614
<div class="variablelist"><table border="0" class="variablelist">
616
<col align="left" valign="top">
621
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
622
<td>the object that received the signal</td>
625
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
626
<td>user data set when the signal handler was connected.</td>
630
<p class="since">Since 2.0</p>
633
<div class="refsect2">
634
<a name="GtkPaned-cancel-position"></a><h3>The <code class="literal">"cancel-position"</code> signal</h3>
635
<pre class="programlisting"><span class="returnvalue">gboolean</span> user_function (<a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> *widget,
636
<span class="type">gpointer</span> user_data) : <code class="literal">Action</code></pre>
638
The ::cancel-position signal is a
639
<a class="link" href="gtk2-Bindings.html#keybinding-signals">keybinding signal</a>
640
which gets emitted to cancel moving the position of the handle using key
641
bindings. The position of the handle will be reset to the value prior to
645
The default binding for this signal is Escape.
647
<div class="variablelist"><table border="0" class="variablelist">
649
<col align="left" valign="top">
654
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
655
<td>the object that received the signal</td>
658
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
659
<td>user data set when the signal handler was connected.</td>
663
<p class="since">Since 2.0</p>
666
<div class="refsect2">
667
<a name="GtkPaned-cycle-child-focus"></a><h3>The <code class="literal">"cycle-child-focus"</code> signal</h3>
668
<pre class="programlisting"><span class="returnvalue">gboolean</span> user_function (<a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> *widget,
669
<span class="type">gboolean</span> reversed,
670
<span class="type">gpointer</span> user_data) : <code class="literal">Action</code></pre>
672
The ::cycle-child-focus signal is a
673
<a class="link" href="gtk2-Bindings.html#keybinding-signals">keybinding signal</a>
674
which gets emitted to cycle the focus between the children of the paned.
677
The default binding is f6.
679
<div class="variablelist"><table border="0" class="variablelist">
681
<col align="left" valign="top">
686
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
687
<td>the object that received the signal</td>
690
<td><p><span class="term"><em class="parameter"><code>reversed</code></em> :</span></p></td>
691
<td>whether cycling backward or forward</td>
694
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
695
<td>user data set when the signal handler was connected.</td>
699
<p class="since">Since 2.0</p>
702
<div class="refsect2">
703
<a name="GtkPaned-cycle-handle-focus"></a><h3>The <code class="literal">"cycle-handle-focus"</code> signal</h3>
704
<pre class="programlisting"><span class="returnvalue">gboolean</span> user_function (<a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> *widget,
705
<span class="type">gboolean</span> reversed,
706
<span class="type">gpointer</span> user_data) : <code class="literal">Action</code></pre>
708
The ::cycle-handle-focus signal is a
709
<a class="link" href="gtk2-Bindings.html#keybinding-signals">keybinding signal</a>
710
which gets emitted to cycle whether the paned should grab focus to allow
711
the user to change position of the handle by using key bindings.
714
The default binding for this signal is f8.
716
<div class="variablelist"><table border="0" class="variablelist">
718
<col align="left" valign="top">
723
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
724
<td>the object that received the signal</td>
727
<td><p><span class="term"><em class="parameter"><code>reversed</code></em> :</span></p></td>
728
<td>whether cycling backward or forward</td>
731
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
732
<td>user data set when the signal handler was connected.</td>
736
<p class="since">Since 2.0</p>
739
<div class="refsect2">
740
<a name="GtkPaned-move-handle"></a><h3>The <code class="literal">"move-handle"</code> signal</h3>
741
<pre class="programlisting"><span class="returnvalue">gboolean</span> user_function (<a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> *widget,
742
<a class="link" href="gtk2-Standard-Enumerations.html#GtkScrollType" title="enum GtkScrollType"><span class="type">GtkScrollType</span></a> scroll_type,
743
<span class="type">gpointer</span> user_data) : <code class="literal">Action</code></pre>
745
The ::move-handle signal is a
746
<a class="link" href="gtk2-Bindings.html#keybinding-signals">keybinding signal</a>
747
which gets emitted to move the handle when the user is using key bindings
750
<div class="variablelist"><table border="0" class="variablelist">
752
<col align="left" valign="top">
757
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
758
<td>the object that received the signal</td>
761
<td><p><span class="term"><em class="parameter"><code>scroll_type</code></em> :</span></p></td>
762
<td>a <a class="link" href="gtk2-Standard-Enumerations.html#GtkScrollType" title="enum GtkScrollType"><span class="type">GtkScrollType</span></a>
766
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
767
<td>user data set when the signal handler was connected.</td>
771
<p class="since">Since 2.0</p>
774
<div class="refsect2">
775
<a name="GtkPaned-toggle-handle-focus"></a><h3>The <code class="literal">"toggle-handle-focus"</code> signal</h3>
776
<pre class="programlisting"><span class="returnvalue">gboolean</span> user_function (<a class="link" href="GtkPaned.html" title="GtkPaned"><span class="type">GtkPaned</span></a> *widget,
777
<span class="type">gpointer</span> user_data) : <code class="literal">Action</code></pre>
779
The ::toggle-handle-focus is a
780
<a class="link" href="gtk2-Bindings.html#keybinding-signals">keybinding signal</a>
781
which gets emitted to accept the current position of the handle and then
782
move focus to the next widget in the focus chain.
785
The default binding is Tab.
787
<div class="variablelist"><table border="0" class="variablelist">
789
<col align="left" valign="top">
794
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
795
<td>the object that received the signal</td>
798
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
799
<td>user data set when the signal handler was connected.</td>
803
<p class="since">Since 2.0</p>
809
Generated by GTK-Doc V1.18</div>
b'\\ No newline at end of file'
added
removed
share/gtk-doc/html/gtk2/GtkPaned.html
