2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
<refentry id="GeditPanel">
6
<refentrytitle role="top_of_page" id="GeditPanel.top_of_page">GeditPanel</refentrytitle>
7
<manvolnum>3</manvolnum>
8
<refmiscinfo>GEDIT Library</refmiscinfo>
12
<refname>GeditPanel</refname>
13
<refpurpose></refpurpose>
16
<refsynopsisdiv id="GeditPanel.synopsis" role="synopsis">
17
<title role="synopsis.title">Synopsis</title>
20
<link linkend="GeditPanelPrivate">GeditPanelPrivate</link>;
21
<link linkend="GeditPanel-struct">GeditPanel</link>;
22
<link linkend="GtkWidget">GtkWidget</link> * <link linkend="gedit-panel-new">gedit_panel_new</link> (<link linkend="GtkOrientation">GtkOrientation</link> orientation);
23
<link linkend="void">void</link> <link linkend="gedit-panel-add-item">gedit_panel_add_item</link> (<link linkend="GeditPanel">GeditPanel</link> *panel,
24
<link linkend="GtkWidget">GtkWidget</link> *item,
25
const <link linkend="gchar">gchar</link> *name,
26
<link linkend="GtkWidget">GtkWidget</link> *image);
27
<link linkend="void">void</link> <link linkend="gedit-panel-add-item-with-stock-icon">gedit_panel_add_item_with_stock_icon</link>
28
(<link linkend="GeditPanel">GeditPanel</link> *panel,
29
<link linkend="GtkWidget">GtkWidget</link> *item,
30
const <link linkend="gchar">gchar</link> *name,
31
const <link linkend="gchar">gchar</link> *stock_id);
32
<link linkend="gboolean">gboolean</link> <link linkend="gedit-panel-remove-item">gedit_panel_remove_item</link> (<link linkend="GeditPanel">GeditPanel</link> *panel,
33
<link linkend="GtkWidget">GtkWidget</link> *item);
34
<link linkend="gboolean">gboolean</link> <link linkend="gedit-panel-activate-item">gedit_panel_activate_item</link> (<link linkend="GeditPanel">GeditPanel</link> *panel,
35
<link linkend="GtkWidget">GtkWidget</link> *item);
36
<link linkend="gboolean">gboolean</link> <link linkend="gedit-panel-item-is-active">gedit_panel_item_is_active</link> (<link linkend="GeditPanel">GeditPanel</link> *panel,
37
<link linkend="GtkWidget">GtkWidget</link> *item);
38
<link linkend="GtkOrientation">GtkOrientation</link> <link linkend="gedit-panel-get-orientation">gedit_panel_get_orientation</link> (<link linkend="GeditPanel">GeditPanel</link> *panel);
39
<link linkend="gint">gint</link> <link linkend="gedit-panel-get-n-items">gedit_panel_get_n_items</link> (<link linkend="GeditPanel">GeditPanel</link> *panel);
43
<refsect1 id="GeditPanel.object-hierarchy" role="object_hierarchy">
44
<title role="object_hierarchy.title">Object Hierarchy</title>
46
<link linkend="GObject">GObject</link>
47
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
48
+----<link linkend="GtkObject">GtkObject</link>
49
+----<link linkend="GtkWidget">GtkWidget</link>
50
+----<link linkend="GtkContainer">GtkContainer</link>
51
+----<link linkend="GtkBox">GtkBox</link>
52
+----<link linkend="GtkVBox">GtkVBox</link>
59
<refsect1 id="GeditPanel.implemented-interfaces" role="impl_interfaces">
60
<title role="impl_interfaces.title">Implemented Interfaces</title>
63
<link linkend="AtkImplementorIface">AtkImplementorIface</link>, <link linkend="GtkBuildable">GtkBuildable</link> and <link linkend="GtkOrientable">GtkOrientable</link>.</para>
67
<refsect1 id="GeditPanel.properties" role="properties">
68
<title role="properties.title">Properties</title>
70
"<link linkend="GeditPanel--orientation">orientation</link>" <link linkend="GtkOrientation">GtkOrientation</link> : Read / Write / Construct Only
74
<refsect1 id="GeditPanel.signals" role="signal_proto">
75
<title role="signal_proto.title">Signals</title>
77
"<link linkend="GeditPanel-close">close</link>" : Run Last / Action
78
"<link linkend="GeditPanel-focus-document">focus-document</link>" : Run Last / Action
79
"<link linkend="GeditPanel-item-added">item-added</link>" : Run First
80
"<link linkend="GeditPanel-item-removed">item-removed</link>" : Run First
85
<refsect1 id="GeditPanel.description" role="desc">
86
<title role="desc.title">Description</title>
91
<refsect1 id="GeditPanel.details" role="details">
92
<title role="details.title">Details</title>
93
<refsect2 id="GeditPanelPrivate" role="struct">
94
<title>GeditPanelPrivate</title>
95
<indexterm zone="GeditPanelPrivate"><primary sortas="GeditPanelPrivate">GeditPanelPrivate</primary></indexterm><programlisting>typedef struct _GeditPanelPrivate GeditPanelPrivate;</programlisting>
98
<refsect2 id="GeditPanel-struct" role="struct">
99
<title>GeditPanel</title>
100
<indexterm zone="GeditPanel-struct"><primary sortas="GeditPanel">GeditPanel</primary></indexterm><programlisting>typedef struct _GeditPanel GeditPanel;</programlisting>
103
<refsect2 id="gedit-panel-new" role="function">
104
<title>gedit_panel_new ()</title>
105
<indexterm zone="gedit-panel-new"><primary sortas="gedit_panel_new">gedit_panel_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> * gedit_panel_new (<link linkend="GtkOrientation">GtkOrientation</link> orientation);</programlisting>
107
Creates a new <link linkend="GeditPanel"><type>GeditPanel</type></link> with the given <parameter>orientation</parameter>. You shouldn't create
108
a new panel use <link linkend="gedit-window-get-side-panel"><function>gedit_window_get_side_panel()</function></link> or <link linkend="gedit-window-get-bottom-panel"><function>gedit_window_get_bottom_panel()</function></link>
111
</para><variablelist role="params">
112
<varlistentry><term><parameter>orientation</parameter> :</term>
113
<listitem><simpara> a <link linkend="GtkOrientation"><type>GtkOrientation</type></link>
114
</simpara></listitem></varlistentry>
115
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GeditPanel"><type>GeditPanel</type></link> object.
116
</simpara></listitem></varlistentry>
117
</variablelist></refsect2>
118
<refsect2 id="gedit-panel-add-item" role="function">
119
<title>gedit_panel_add_item ()</title>
120
<indexterm zone="gedit-panel-add-item"><primary sortas="gedit_panel_add_item">gedit_panel_add_item</primary></indexterm><programlisting><link linkend="void">void</link> gedit_panel_add_item (<link linkend="GeditPanel">GeditPanel</link> *panel,
121
<link linkend="GtkWidget">GtkWidget</link> *item,
122
const <link linkend="gchar">gchar</link> *name,
123
<link linkend="GtkWidget">GtkWidget</link> *image);</programlisting>
125
Adds a new item to the <parameter>panel</parameter>.</para>
127
</para><variablelist role="params">
128
<varlistentry><term><parameter>panel</parameter> :</term>
129
<listitem><simpara> a <link linkend="GeditPanel"><type>GeditPanel</type></link>
130
</simpara></listitem></varlistentry>
131
<varlistentry><term><parameter>item</parameter> :</term>
132
<listitem><simpara> the <link linkend="GtkWidget"><type>GtkWidget</type></link> to add to the <parameter>panel</parameter>
133
</simpara></listitem></varlistentry>
134
<varlistentry><term><parameter>name</parameter> :</term>
135
<listitem><simpara> the name to be shown in the <parameter>panel</parameter>
136
</simpara></listitem></varlistentry>
137
<varlistentry><term><parameter>image</parameter> :</term>
138
<listitem><simpara> the image to be shown in the <parameter>panel</parameter>
139
</simpara></listitem></varlistentry>
140
</variablelist></refsect2>
141
<refsect2 id="gedit-panel-add-item-with-stock-icon" role="function">
142
<title>gedit_panel_add_item_with_stock_icon ()</title>
143
<indexterm zone="gedit-panel-add-item-with-stock-icon"><primary sortas="gedit_panel_add_item_with_stock_icon">gedit_panel_add_item_with_stock_icon</primary></indexterm><programlisting><link linkend="void">void</link> gedit_panel_add_item_with_stock_icon
144
(<link linkend="GeditPanel">GeditPanel</link> *panel,
145
<link linkend="GtkWidget">GtkWidget</link> *item,
146
const <link linkend="gchar">gchar</link> *name,
147
const <link linkend="gchar">gchar</link> *stock_id);</programlisting>
149
Same as <link linkend="gedit-panel-add-item"><function>gedit_panel_add_item()</function></link> but using an image from stock.</para>
151
</para><variablelist role="params">
152
<varlistentry><term><parameter>panel</parameter> :</term>
153
<listitem><simpara> a <link linkend="GeditPanel"><type>GeditPanel</type></link>
154
</simpara></listitem></varlistentry>
155
<varlistentry><term><parameter>item</parameter> :</term>
156
<listitem><simpara> the <link linkend="GtkWidget"><type>GtkWidget</type></link> to add to the <parameter>panel</parameter>
157
</simpara></listitem></varlistentry>
158
<varlistentry><term><parameter>name</parameter> :</term>
159
<listitem><simpara> the name to be shown in the <parameter>panel</parameter>
160
</simpara></listitem></varlistentry>
161
<varlistentry><term><parameter>stock_id</parameter> :</term>
162
<listitem><simpara> a stock id
163
</simpara></listitem></varlistentry>
164
</variablelist></refsect2>
165
<refsect2 id="gedit-panel-remove-item" role="function">
166
<title>gedit_panel_remove_item ()</title>
167
<indexterm zone="gedit-panel-remove-item"><primary sortas="gedit_panel_remove_item">gedit_panel_remove_item</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gedit_panel_remove_item (<link linkend="GeditPanel">GeditPanel</link> *panel,
168
<link linkend="GtkWidget">GtkWidget</link> *item);</programlisting>
170
Removes the widget <parameter>item</parameter> from the panel if it is in the <parameter>panel</parameter> and returns
171
TRUE if there was not any problem.</para>
173
</para><variablelist role="params">
174
<varlistentry><term><parameter>panel</parameter> :</term>
175
<listitem><simpara> a <link linkend="GeditPanel"><type>GeditPanel</type></link>
176
</simpara></listitem></varlistentry>
177
<varlistentry><term><parameter>item</parameter> :</term>
178
<listitem><simpara> the item to be removed from the panel
179
</simpara></listitem></varlistentry>
180
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if it was well removed.
181
</simpara></listitem></varlistentry>
182
</variablelist></refsect2>
183
<refsect2 id="gedit-panel-activate-item" role="function">
184
<title>gedit_panel_activate_item ()</title>
185
<indexterm zone="gedit-panel-activate-item"><primary sortas="gedit_panel_activate_item">gedit_panel_activate_item</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gedit_panel_activate_item (<link linkend="GeditPanel">GeditPanel</link> *panel,
186
<link linkend="GtkWidget">GtkWidget</link> *item);</programlisting>
188
Switches to the page that contains <parameter>item</parameter>.</para>
190
</para><variablelist role="params">
191
<varlistentry><term><parameter>panel</parameter> :</term>
192
<listitem><simpara> a <link linkend="GeditPanel"><type>GeditPanel</type></link>
193
</simpara></listitem></varlistentry>
194
<varlistentry><term><parameter>item</parameter> :</term>
195
<listitem><simpara> the item to be activated
196
</simpara></listitem></varlistentry>
197
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if it was activated
198
</simpara></listitem></varlistentry>
199
</variablelist></refsect2>
200
<refsect2 id="gedit-panel-item-is-active" role="function">
201
<title>gedit_panel_item_is_active ()</title>
202
<indexterm zone="gedit-panel-item-is-active"><primary sortas="gedit_panel_item_is_active">gedit_panel_item_is_active</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gedit_panel_item_is_active (<link linkend="GeditPanel">GeditPanel</link> *panel,
203
<link linkend="GtkWidget">GtkWidget</link> *item);</programlisting>
205
Wheter <parameter>item</parameter> is the one current active in <parameter>panel</parameter></para>
207
</para><variablelist role="params">
208
<varlistentry><term><parameter>panel</parameter> :</term>
209
<listitem><simpara> a <link linkend="GeditPanel"><type>GeditPanel</type></link>
210
</simpara></listitem></varlistentry>
211
<varlistentry><term><parameter>item</parameter> :</term>
212
<listitem><simpara> a widget contained in <link linkend="GeditPanel"><type>GeditPanel</type></link>
213
</simpara></listitem></varlistentry>
214
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the widget is active
215
</simpara></listitem></varlistentry>
216
</variablelist></refsect2>
217
<refsect2 id="gedit-panel-get-orientation" role="function">
218
<title>gedit_panel_get_orientation ()</title>
219
<indexterm zone="gedit-panel-get-orientation"><primary sortas="gedit_panel_get_orientation">gedit_panel_get_orientation</primary></indexterm><programlisting><link linkend="GtkOrientation">GtkOrientation</link> gedit_panel_get_orientation (<link linkend="GeditPanel">GeditPanel</link> *panel);</programlisting>
221
Gets the orientation of the <parameter>panel</parameter>.</para>
223
</para><variablelist role="params">
224
<varlistentry><term><parameter>panel</parameter> :</term>
225
<listitem><simpara> a <link linkend="GeditPanel"><type>GeditPanel</type></link>
226
</simpara></listitem></varlistentry>
227
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the <link linkend="GtkOrientation"><type>GtkOrientation</type></link> of <link linkend="GeditPanel"><type>GeditPanel</type></link>
228
</simpara></listitem></varlistentry>
229
</variablelist></refsect2>
230
<refsect2 id="gedit-panel-get-n-items" role="function">
231
<title>gedit_panel_get_n_items ()</title>
232
<indexterm zone="gedit-panel-get-n-items"><primary sortas="gedit_panel_get_n_items">gedit_panel_get_n_items</primary></indexterm><programlisting><link linkend="gint">gint</link> gedit_panel_get_n_items (<link linkend="GeditPanel">GeditPanel</link> *panel);</programlisting>
234
Gets the number of items in a <parameter>panel</parameter>.</para>
236
</para><variablelist role="params">
237
<varlistentry><term><parameter>panel</parameter> :</term>
238
<listitem><simpara> a <link linkend="GeditPanel"><type>GeditPanel</type></link>
239
</simpara></listitem></varlistentry>
240
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the number of items contained in <link linkend="GeditPanel"><type>GeditPanel</type></link>
241
</simpara></listitem></varlistentry>
242
</variablelist></refsect2>
245
<refsect1 id="GeditPanel.property-details" role="property_details">
246
<title role="property_details.title">Property Details</title>
247
<refsect2 id="GeditPanel--orientation" role="property"><title>The <literal>"orientation"</literal> property</title>
248
<indexterm zone="GeditPanel--orientation"><primary sortas="GeditPanel:orientation">GeditPanel:orientation</primary></indexterm><programlisting> "orientation" <link linkend="GtkOrientation">GtkOrientation</link> : Read / Write / Construct Only</programlisting>
249
<para>The panel's orientation.</para><para>Default value: GTK_ORIENTATION_VERTICAL</para>
253
<refsect1 id="GeditPanel.signal-details" role="signals">
254
<title role="signals.title">Signal Details</title>
255
<refsect2 id="GeditPanel-close" role="signal"><title>The <literal>"close"</literal> signal</title>
256
<indexterm zone="GeditPanel-close"><primary sortas="GeditPanel::close">GeditPanel::close</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GeditPanel">GeditPanel</link> *geditpanel,
257
<link linkend="gpointer">gpointer</link> user_data) : Run Last / Action</programlisting>
259
</para><variablelist role="params">
260
<varlistentry><term><parameter>geditpanel</parameter> :</term>
261
<listitem><simpara>the object which received the signal.
262
</simpara></listitem></varlistentry>
263
<varlistentry><term><parameter>user_data</parameter> :</term>
264
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
265
</variablelist></refsect2><refsect2 id="GeditPanel-focus-document" role="signal"><title>The <literal>"focus-document"</literal> signal</title>
266
<indexterm zone="GeditPanel-focus-document"><primary sortas="GeditPanel::focus-document">GeditPanel::focus-document</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GeditPanel">GeditPanel</link> *geditpanel,
267
<link linkend="gpointer">gpointer</link> user_data) : Run Last / Action</programlisting>
269
</para><variablelist role="params">
270
<varlistentry><term><parameter>geditpanel</parameter> :</term>
271
<listitem><simpara>the object which received the signal.
272
</simpara></listitem></varlistentry>
273
<varlistentry><term><parameter>user_data</parameter> :</term>
274
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
275
</variablelist></refsect2><refsect2 id="GeditPanel-item-added" role="signal"><title>The <literal>"item-added"</literal> signal</title>
276
<indexterm zone="GeditPanel-item-added"><primary sortas="GeditPanel::item-added">GeditPanel::item-added</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GeditPanel">GeditPanel</link> *geditpanel,
277
<link linkend="GtkWidget">GtkWidget</link> *widget,
278
<link linkend="gpointer">gpointer</link> user_data) : Run First</programlisting>
280
</para><variablelist role="params">
281
<varlistentry><term><parameter>geditpanel</parameter> :</term>
282
<listitem><simpara>the object which received the signal.
283
</simpara></listitem></varlistentry>
284
<varlistentry><term><parameter>widget</parameter> :</term>
286
</simpara></listitem></varlistentry>
287
<varlistentry><term><parameter>user_data</parameter> :</term>
288
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
289
</variablelist></refsect2><refsect2 id="GeditPanel-item-removed" role="signal"><title>The <literal>"item-removed"</literal> signal</title>
290
<indexterm zone="GeditPanel-item-removed"><primary sortas="GeditPanel::item-removed">GeditPanel::item-removed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GeditPanel">GeditPanel</link> *geditpanel,
291
<link linkend="GtkWidget">GtkWidget</link> *widget,
292
<link linkend="gpointer">gpointer</link> user_data) : Run First</programlisting>
294
</para><variablelist role="params">
295
<varlistentry><term><parameter>geditpanel</parameter> :</term>
296
<listitem><simpara>the object which received the signal.
297
</simpara></listitem></varlistentry>
298
<varlistentry><term><parameter>widget</parameter> :</term>
300
</simpara></listitem></varlistentry>
301
<varlistentry><term><parameter>user_data</parameter> :</term>
302
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
303
</variablelist></refsect2>