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>GeditPanel</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
<link rel="home" href="index.html" title="gedit Reference Manual">
8
<link rel="up" href="ch01.html" title="gedit">
9
<link rel="prev" href="gedit-gedit-notebook.html" title="GeditNotebook">
10
<link rel="next" href="GeditPlugin.html" title="GeditPlugin">
11
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="chapter" href="ch01.html" title="gedit">
15
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
16
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
18
<td><a accesskey="p" href="gedit-gedit-notebook.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
19
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
20
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
21
<th width="100%" align="center">gedit Reference Manual</th>
22
<td><a accesskey="n" href="GeditPlugin.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
24
<tr><td colspan="5" class="shortcuts">
25
<a href="#gedit-gedit-panel.synopsis" class="shortcut">Top</a>
27
<a href="#gedit-gedit-panel.description" class="shortcut">Description</a>
29
<a href="#gedit-gedit-panel.object-hierarchy" class="shortcut">Object Hierarchy</a>
31
<a href="#gedit-gedit-panel.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
33
<a href="#gedit-gedit-panel.properties" class="shortcut">Properties</a>
35
<a href="#gedit-gedit-panel.signals" class="shortcut">Signals</a>
38
<div class="refentry" title="GeditPanel">
39
<a name="gedit-gedit-panel"></a><div class="titlepage"></div>
40
<div class="refnamediv"><table width="100%"><tr>
42
<h2><span class="refentrytitle"><a name="gedit-gedit-panel.top_of_page"></a>GeditPanel</span></h2>
45
<td valign="top" align="right"></td>
47
<div class="refsynopsisdiv" title="Synopsis">
48
<a name="gedit-gedit-panel.synopsis"></a><h2>Synopsis</h2>
49
<a name="GeditPanel"></a><pre class="synopsis"> <a class="link" href="gedit-gedit-panel.html#GeditPanelPrivate" title="GeditPanelPrivate">GeditPanelPrivate</a>;
50
<a class="link" href="gedit-gedit-panel.html#GeditPanel-struct" title="GeditPanel">GeditPanel</a>;
51
<span class="returnvalue">GtkWidget</span> * <a class="link" href="gedit-gedit-panel.html#gedit-panel-new" title="gedit_panel_new ()">gedit_panel_new</a> (<em class="parameter"><code><span class="type">GtkOrientation</span> orientation</code></em>);
52
<span class="returnvalue">void</span> <a class="link" href="gedit-gedit-panel.html#gedit-panel-add-item" title="gedit_panel_add_item ()">gedit_panel_add_item</a> (<em class="parameter"><code><a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a> *panel</code></em>,
53
<em class="parameter"><code><span class="type">GtkWidget</span> *item</code></em>,
54
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
55
<em class="parameter"><code><span class="type">GtkWidget</span> *image</code></em>);
56
<span class="returnvalue">void</span> <a class="link" href="gedit-gedit-panel.html#gedit-panel-add-item-with-stock-icon" title="gedit_panel_add_item_with_stock_icon ()">gedit_panel_add_item_with_stock_icon</a>
57
(<em class="parameter"><code><a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a> *panel</code></em>,
58
<em class="parameter"><code><span class="type">GtkWidget</span> *item</code></em>,
59
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
60
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *stock_id</code></em>);
61
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gedit-gedit-panel.html#gedit-panel-remove-item" title="gedit_panel_remove_item ()">gedit_panel_remove_item</a> (<em class="parameter"><code><a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a> *panel</code></em>,
62
<em class="parameter"><code><span class="type">GtkWidget</span> *item</code></em>);
63
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gedit-gedit-panel.html#gedit-panel-activate-item" title="gedit_panel_activate_item ()">gedit_panel_activate_item</a> (<em class="parameter"><code><a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a> *panel</code></em>,
64
<em class="parameter"><code><span class="type">GtkWidget</span> *item</code></em>);
65
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gedit-gedit-panel.html#gedit-panel-item-is-active" title="gedit_panel_item_is_active ()">gedit_panel_item_is_active</a> (<em class="parameter"><code><a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a> *panel</code></em>,
66
<em class="parameter"><code><span class="type">GtkWidget</span> *item</code></em>);
67
<span class="returnvalue">GtkOrientation</span> <a class="link" href="gedit-gedit-panel.html#gedit-panel-get-orientation" title="gedit_panel_get_orientation ()">gedit_panel_get_orientation</a> (<em class="parameter"><code><a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a> *panel</code></em>);
68
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="gedit-gedit-panel.html#gedit-panel-get-n-items" title="gedit_panel_get_n_items ()">gedit_panel_get_n_items</a> (<em class="parameter"><code><a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a> *panel</code></em>);
71
<div class="refsect1" title="Object Hierarchy">
72
<a name="gedit-gedit-panel.object-hierarchy"></a><h2>Object Hierarchy</h2>
73
<pre class="synopsis">
74
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
75
+----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
84
<div class="refsect1" title="Implemented Interfaces">
85
<a name="gedit-gedit-panel.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
88
AtkImplementorIface, GtkBuildable and GtkOrientable.</p>
90
<div class="refsect1" title="Properties">
91
<a name="gedit-gedit-panel.properties"></a><h2>Properties</h2>
92
<pre class="synopsis">
93
"<a class="link" href="gedit-gedit-panel.html#GeditPanel--orientation" title='The "orientation" property'>orientation</a>" <span class="type">GtkOrientation</span> : Read / Write / Construct Only
96
<div class="refsect1" title="Signals">
97
<a name="gedit-gedit-panel.signals"></a><h2>Signals</h2>
98
<pre class="synopsis">
99
"<a class="link" href="gedit-gedit-panel.html#GeditPanel-close" title='The "close" signal'>close</a>" : Run Last / Action
100
"<a class="link" href="gedit-gedit-panel.html#GeditPanel-focus-document" title='The "focus-document" signal'>focus-document</a>" : Run Last / Action
101
"<a class="link" href="gedit-gedit-panel.html#GeditPanel-item-added" title='The "item-added" signal'>item-added</a>" : Run First
102
"<a class="link" href="gedit-gedit-panel.html#GeditPanel-item-removed" title='The "item-removed" signal'>item-removed</a>" : Run First
105
<div class="refsect1" title="Description">
106
<a name="gedit-gedit-panel.description"></a><h2>Description</h2>
108
<div class="refsect1" title="Details">
109
<a name="gedit-gedit-panel.details"></a><h2>Details</h2>
110
<div class="refsect2" title="GeditPanelPrivate">
111
<a name="GeditPanelPrivate"></a><h3>GeditPanelPrivate</h3>
112
<pre class="programlisting">typedef struct _GeditPanelPrivate GeditPanelPrivate;</pre>
115
<div class="refsect2" title="GeditPanel">
116
<a name="GeditPanel-struct"></a><h3>GeditPanel</h3>
117
<pre class="programlisting">typedef struct _GeditPanel GeditPanel;</pre>
120
<div class="refsect2" title="gedit_panel_new ()">
121
<a name="gedit-panel-new"></a><h3>gedit_panel_new ()</h3>
122
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * gedit_panel_new (<em class="parameter"><code><span class="type">GtkOrientation</span> orientation</code></em>);</pre>
124
Creates a new <a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a> with the given <em class="parameter"><code>orientation</code></em>. You shouldn't create
125
a new panel use <a class="link" href="gedit-gedit-window.html#gedit-window-get-side-panel" title="gedit_window_get_side_panel ()"><code class="function">gedit_window_get_side_panel()</code></a> or <a class="link" href="gedit-gedit-window.html#gedit-window-get-bottom-panel" title="gedit_window_get_bottom_panel ()"><code class="function">gedit_window_get_bottom_panel()</code></a>
127
<div class="variablelist"><table border="0">
128
<col align="left" valign="top">
131
<td><p><span class="term"><em class="parameter"><code>orientation</code></em> :</span></p></td>
132
<td>a <span class="type">GtkOrientation</span>
136
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
137
<td> a new <a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a> object.
144
<div class="refsect2" title="gedit_panel_add_item ()">
145
<a name="gedit-panel-add-item"></a><h3>gedit_panel_add_item ()</h3>
146
<pre class="programlisting"><span class="returnvalue">void</span> gedit_panel_add_item (<em class="parameter"><code><a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a> *panel</code></em>,
147
<em class="parameter"><code><span class="type">GtkWidget</span> *item</code></em>,
148
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
149
<em class="parameter"><code><span class="type">GtkWidget</span> *image</code></em>);</pre>
151
Adds a new item to the <em class="parameter"><code>panel</code></em>.</p>
152
<div class="variablelist"><table border="0">
153
<col align="left" valign="top">
156
<td><p><span class="term"><em class="parameter"><code>panel</code></em> :</span></p></td>
157
<td>a <a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a>
161
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
162
<td>the <span class="type">GtkWidget</span> to add to the <em class="parameter"><code>panel</code></em>
166
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
167
<td>the name to be shown in the <em class="parameter"><code>panel</code></em>
171
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
172
<td>the image to be shown in the <em class="parameter"><code>panel</code></em>
179
<div class="refsect2" title="gedit_panel_add_item_with_stock_icon ()">
180
<a name="gedit-panel-add-item-with-stock-icon"></a><h3>gedit_panel_add_item_with_stock_icon ()</h3>
181
<pre class="programlisting"><span class="returnvalue">void</span> gedit_panel_add_item_with_stock_icon
182
(<em class="parameter"><code><a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a> *panel</code></em>,
183
<em class="parameter"><code><span class="type">GtkWidget</span> *item</code></em>,
184
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
185
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *stock_id</code></em>);</pre>
187
Same as <a class="link" href="gedit-gedit-panel.html#gedit-panel-add-item" title="gedit_panel_add_item ()"><code class="function">gedit_panel_add_item()</code></a> but using an image from stock.</p>
188
<div class="variablelist"><table border="0">
189
<col align="left" valign="top">
192
<td><p><span class="term"><em class="parameter"><code>panel</code></em> :</span></p></td>
193
<td>a <a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a>
197
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
198
<td>the <span class="type">GtkWidget</span> to add to the <em class="parameter"><code>panel</code></em>
202
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
203
<td>the name to be shown in the <em class="parameter"><code>panel</code></em>
207
<td><p><span class="term"><em class="parameter"><code>stock_id</code></em> :</span></p></td>
215
<div class="refsect2" title="gedit_panel_remove_item ()">
216
<a name="gedit-panel-remove-item"></a><h3>gedit_panel_remove_item ()</h3>
217
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gedit_panel_remove_item (<em class="parameter"><code><a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a> *panel</code></em>,
218
<em class="parameter"><code><span class="type">GtkWidget</span> *item</code></em>);</pre>
220
Removes the widget <em class="parameter"><code>item</code></em> from the panel if it is in the <em class="parameter"><code>panel</code></em> and returns
221
TRUE if there was not any problem.</p>
222
<div class="variablelist"><table border="0">
223
<col align="left" valign="top">
226
<td><p><span class="term"><em class="parameter"><code>panel</code></em> :</span></p></td>
227
<td>a <a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a>
231
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
232
<td>the item to be removed from the panel
236
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
237
<td> TRUE if it was well removed.
244
<div class="refsect2" title="gedit_panel_activate_item ()">
245
<a name="gedit-panel-activate-item"></a><h3>gedit_panel_activate_item ()</h3>
246
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gedit_panel_activate_item (<em class="parameter"><code><a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a> *panel</code></em>,
247
<em class="parameter"><code><span class="type">GtkWidget</span> *item</code></em>);</pre>
249
Switches to the page that contains <em class="parameter"><code>item</code></em>.</p>
250
<div class="variablelist"><table border="0">
251
<col align="left" valign="top">
254
<td><p><span class="term"><em class="parameter"><code>panel</code></em> :</span></p></td>
255
<td>a <a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a>
259
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
260
<td>the item to be activated
264
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
265
<td> TRUE if it was activated
272
<div class="refsect2" title="gedit_panel_item_is_active ()">
273
<a name="gedit-panel-item-is-active"></a><h3>gedit_panel_item_is_active ()</h3>
274
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gedit_panel_item_is_active (<em class="parameter"><code><a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a> *panel</code></em>,
275
<em class="parameter"><code><span class="type">GtkWidget</span> *item</code></em>);</pre>
277
Wheter <em class="parameter"><code>item</code></em> is the one current active in <em class="parameter"><code>panel</code></em></p>
278
<div class="variablelist"><table border="0">
279
<col align="left" valign="top">
282
<td><p><span class="term"><em class="parameter"><code>panel</code></em> :</span></p></td>
283
<td>a <a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a>
287
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
288
<td>a widget contained in <a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a>
292
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
293
<td> TRUE if the widget is active
300
<div class="refsect2" title="gedit_panel_get_orientation ()">
301
<a name="gedit-panel-get-orientation"></a><h3>gedit_panel_get_orientation ()</h3>
302
<pre class="programlisting"><span class="returnvalue">GtkOrientation</span> gedit_panel_get_orientation (<em class="parameter"><code><a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a> *panel</code></em>);</pre>
304
Gets the orientation of the <em class="parameter"><code>panel</code></em>.</p>
305
<div class="variablelist"><table border="0">
306
<col align="left" valign="top">
309
<td><p><span class="term"><em class="parameter"><code>panel</code></em> :</span></p></td>
310
<td>a <a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a>
314
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
315
<td> the <span class="type">GtkOrientation</span> of <a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a>
322
<div class="refsect2" title="gedit_panel_get_n_items ()">
323
<a name="gedit-panel-get-n-items"></a><h3>gedit_panel_get_n_items ()</h3>
324
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gedit_panel_get_n_items (<em class="parameter"><code><a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a> *panel</code></em>);</pre>
326
Gets the number of items in a <em class="parameter"><code>panel</code></em>.</p>
327
<div class="variablelist"><table border="0">
328
<col align="left" valign="top">
331
<td><p><span class="term"><em class="parameter"><code>panel</code></em> :</span></p></td>
332
<td>a <a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a>
336
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
337
<td> the number of items contained in <a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a>
344
<div class="refsect1" title="Property Details">
345
<a name="gedit-gedit-panel.property-details"></a><h2>Property Details</h2>
346
<div class="refsect2" title='The "orientation" property'>
347
<a name="GeditPanel--orientation"></a><h3>The <code class="literal">"orientation"</code> property</h3>
348
<pre class="programlisting"> "orientation" <span class="type">GtkOrientation</span> : Read / Write / Construct Only</pre>
349
<p>The panel's orientation.</p>
350
<p>Default value: GTK_ORIENTATION_VERTICAL</p>
353
<div class="refsect1" title="Signal Details">
354
<a name="gedit-gedit-panel.signal-details"></a><h2>Signal Details</h2>
355
<div class="refsect2" title='The "close" signal'>
356
<a name="GeditPanel-close"></a><h3>The <code class="literal">"close"</code> signal</h3>
357
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a> *geditpanel,
358
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last / Action</pre>
361
<div class="refsect2" title='The "focus-document" signal'>
362
<a name="GeditPanel-focus-document"></a><h3>The <code class="literal">"focus-document"</code> signal</h3>
363
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a> *geditpanel,
364
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last / Action</pre>
367
<div class="refsect2" title='The "item-added" signal'>
368
<a name="GeditPanel-item-added"></a><h3>The <code class="literal">"item-added"</code> signal</h3>
369
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a> *geditpanel,
370
<span class="type">GtkWidget</span> *widget,
371
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run First</pre>
374
<div class="refsect2" title='The "item-removed" signal'>
375
<a name="GeditPanel-item-removed"></a><h3>The <code class="literal">"item-removed"</code> signal</h3>
376
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="gedit-gedit-panel.html#GeditPanel"><span class="type">GeditPanel</span></a> *geditpanel,
377
<span class="type">GtkWidget</span> *widget,
378
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run First</pre>
384
Generated by GTK-Doc V1.14</div>
b'\\ No newline at end of file'