← Back to branch summary

~ubuntu-branches/ubuntu/karmic/gedit/karmic

« back to all changes in this revision

Viewing changes to docs/reference/xml/gedit-window.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2009-09-21 17:46:38 UTC
  • mfrom: (1.1.68 upstream)
  • Revision ID: james.westby@ubuntu.com-20090921174638-umsgmvz3cd1bwhtr
Tags: 2.28.0-0ubuntu1
https://launchpad.net/bugs/421221
* New upstream version:
  - Misc bugfixes (lp: #421221)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/xml/gedit-window.xml
 
1
<?xml version="1.0"?>
 
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="GeditWindow">
 
5
<refmeta>
 
6
<refentrytitle role="top_of_page" id="GeditWindow.top_of_page">GeditWindow</refentrytitle>
 
7
<manvolnum>3</manvolnum>
 
8
<refmiscinfo>GEDIT Library</refmiscinfo>
 
9
</refmeta>
 
10
 
 
11
<refnamediv>
 
12
<refname>GeditWindow</refname>
 
13
<refpurpose></refpurpose>
 
14
</refnamediv>
 
15
 
 
16
<refsynopsisdiv id="GeditWindow.synopsis" role="synopsis">
 
17
<title role="synopsis.title">Synopsis</title>
 
18
 
 
19
<synopsis>
 
20
enum                <link linkend="GeditWindowState">GeditWindowState</link>;
 
21
                    <link linkend="GeditWindowPrivate">GeditWindowPrivate</link>;
 
22
                    <link linkend="GeditWindow-struct">GeditWindow</link>;
 
23
<link linkend="GeditTab">GeditTab</link> *          <link linkend="gedit-window-create-tab">gedit_window_create_tab</link>             (<link linkend="GeditWindow">GeditWindow</link> *window,
 
24
                                                         <link linkend="gboolean">gboolean</link> jump_to);
 
25
<link linkend="GeditTab">GeditTab</link> *          <link linkend="gedit-window-create-tab-from-uri">gedit_window_create_tab_from_uri</link>    (<link linkend="GeditWindow">GeditWindow</link> *window,
 
26
                                                         const <link linkend="gchar">gchar</link> *uri,
 
27
                                                         const <link linkend="GeditEncoding">GeditEncoding</link> *encoding,
 
28
                                                         <link linkend="gint">gint</link> line_pos,
 
29
                                                         <link linkend="gboolean">gboolean</link> create,
 
30
                                                         <link linkend="gboolean">gboolean</link> jump_to);
 
31
<link linkend="void">void</link>                <link linkend="gedit-window-close-tab">gedit_window_close_tab</link>              (<link linkend="GeditWindow">GeditWindow</link> *window,
 
32
                                                         <link linkend="GeditTab">GeditTab</link> *tab);
 
33
<link linkend="void">void</link>                <link linkend="gedit-window-close-all-tabs">gedit_window_close_all_tabs</link>         (<link linkend="GeditWindow">GeditWindow</link> *window);
 
34
<link linkend="void">void</link>                <link linkend="gedit-window-close-tabs">gedit_window_close_tabs</link>             (<link linkend="GeditWindow">GeditWindow</link> *window,
 
35
                                                         const <link linkend="GList">GList</link> *tabs);
 
36
<link linkend="GeditTab">GeditTab</link> *          <link linkend="gedit-window-get-active-tab">gedit_window_get_active_tab</link>         (<link linkend="GeditWindow">GeditWindow</link> *window);
 
37
<link linkend="void">void</link>                <link linkend="gedit-window-set-active-tab">gedit_window_set_active_tab</link>         (<link linkend="GeditWindow">GeditWindow</link> *window,
 
38
                                                         <link linkend="GeditTab">GeditTab</link> *tab);
 
39
<link linkend="GeditView">GeditView</link> *         <link linkend="gedit-window-get-active-view">gedit_window_get_active_view</link>        (<link linkend="GeditWindow">GeditWindow</link> *window);
 
40
<link linkend="GeditDocument">GeditDocument</link> *     <link linkend="gedit-window-get-active-document">gedit_window_get_active_document</link>    (<link linkend="GeditWindow">GeditWindow</link> *window);
 
41
<link linkend="GList">GList</link> *             <link linkend="gedit-window-get-documents">gedit_window_get_documents</link>          (<link linkend="GeditWindow">GeditWindow</link> *window);
 
42
<link linkend="GList">GList</link> *             <link linkend="gedit-window-get-unsaved-documents">gedit_window_get_unsaved_documents</link>  (<link linkend="GeditWindow">GeditWindow</link> *window);
 
43
<link linkend="GList">GList</link> *             <link linkend="gedit-window-get-views">gedit_window_get_views</link>              (<link linkend="GeditWindow">GeditWindow</link> *window);
 
44
<link linkend="GtkWindowGroup">GtkWindowGroup</link> *    <link linkend="gedit-window-get-group">gedit_window_get_group</link>              (<link linkend="GeditWindow">GeditWindow</link> *window);
 
45
<link linkend="GeditPanel">GeditPanel</link> *        <link linkend="gedit-window-get-side-panel">gedit_window_get_side_panel</link>         (<link linkend="GeditWindow">GeditWindow</link> *window);
 
46
<link linkend="GeditPanel">GeditPanel</link> *        <link linkend="gedit-window-get-bottom-panel">gedit_window_get_bottom_panel</link>       (<link linkend="GeditWindow">GeditWindow</link> *window);
 
47
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gedit-window-get-statusbar">gedit_window_get_statusbar</link>          (<link linkend="GeditWindow">GeditWindow</link> *window);
 
48
<link linkend="GtkUIManager">GtkUIManager</link> *      <link linkend="gedit-window-get-ui-manager">gedit_window_get_ui_manager</link>         (<link linkend="GeditWindow">GeditWindow</link> *window);
 
49
<link linkend="GeditWindowState">GeditWindowState</link>    <link linkend="gedit-window-get-state">gedit_window_get_state</link>              (<link linkend="GeditWindow">GeditWindow</link> *window);
 
50
<link linkend="GeditTab">GeditTab</link> *          <link linkend="gedit-window-get-tab-from-location">gedit_window_get_tab_from_location</link>  (<link linkend="GeditWindow">GeditWindow</link> *window,
 
51
                                                         <link linkend="GFile">GFile</link> *location);
 
52
<link linkend="GeditTab">GeditTab</link> *          <link linkend="gedit-window-get-tab-from-uri">gedit_window_get_tab_from_uri</link>       (<link linkend="GeditWindow">GeditWindow</link> *window,
 
53
                                                         const <link linkend="gchar">gchar</link> *uri);
 
54
<link linkend="GeditMessageBus">GeditMessageBus</link> *   <link linkend="gedit-window-get-message-bus">gedit_window_get_message_bus</link>        (<link linkend="GeditWindow">GeditWindow</link> *window);
 
55
</synopsis>
 
56
</refsynopsisdiv>
 
57
 
 
58
<refsect1 id="GeditWindow.object-hierarchy" role="object_hierarchy">
 
59
<title role="object_hierarchy.title">Object Hierarchy</title>
 
60
<synopsis>
 
61
  <link linkend="GObject">GObject</link>
 
62
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
 
63
         +----<link linkend="GtkObject">GtkObject</link>
 
64
               +----<link linkend="GtkWidget">GtkWidget</link>
 
65
                     +----<link linkend="GtkContainer">GtkContainer</link>
 
66
                           +----<link linkend="GtkBin">GtkBin</link>
 
67
                                 +----<link linkend="GtkWindow">GtkWindow</link>
 
68
                                       +----GeditWindow
 
69
</synopsis>
 
70
</refsect1>
 
71
 
 
72
 
 
73
 
 
74
<refsect1 id="GeditWindow.implemented-interfaces" role="impl_interfaces">
 
75
<title role="impl_interfaces.title">Implemented Interfaces</title>
 
76
<para>
 
77
GeditWindow implements
 
78
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>
 
79
</refsect1>
 
80
 
 
81
 
 
82
<refsect1 id="GeditWindow.properties" role="properties">
 
83
<title role="properties.title">Properties</title>
 
84
<synopsis>
 
85
  &quot;<link linkend="GeditWindow--state">state</link>&quot;                    <link linkend="GeditWindowState">GeditWindowState</link>      : Read
 
86
</synopsis>
 
87
</refsect1>
 
88
 
 
89
<refsect1 id="GeditWindow.signals" role="signal_proto">
 
90
<title role="signal_proto.title">Signals</title>
 
91
<synopsis>
 
92
  &quot;<link linkend="GeditWindow-active-tab-changed">active-tab-changed</link>&quot;                             : Run First
 
93
  &quot;<link linkend="GeditWindow-active-tab-state-changed">active-tab-state-changed</link>&quot;                       : Run First
 
94
  &quot;<link linkend="GeditWindow-tab-added">tab-added</link>&quot;                                      : Run First
 
95
  &quot;<link linkend="GeditWindow-tab-removed">tab-removed</link>&quot;                                    : Run First
 
96
  &quot;<link linkend="GeditWindow-tabs-reordered">tabs-reordered</link>&quot;                                 : Run First
 
97
</synopsis>
 
98
</refsect1>
 
99
 
 
100
 
 
101
<refsect1 id="GeditWindow.description" role="desc">
 
102
<title role="desc.title">Description</title>
 
103
<para>
 
104
</para>
 
105
</refsect1>
 
106
 
 
107
<refsect1 id="GeditWindow.details" role="details">
 
108
<title role="details.title">Details</title>
 
109
<refsect2 id="GeditWindowState" role="enum">
 
110
<title>enum GeditWindowState</title>
 
111
<indexterm zone="GeditWindowState"><primary sortas="GeditWindowState">GeditWindowState</primary></indexterm><programlisting>typedef enum
 
112
{
 
113
        GEDIT_WINDOW_STATE_NORMAL               = 0,
 
114
        GEDIT_WINDOW_STATE_SAVING               = 1 &lt;&lt; 1,
 
115
        GEDIT_WINDOW_STATE_PRINTING             = 1 &lt;&lt; 2,
 
116
        GEDIT_WINDOW_STATE_LOADING              = 1 &lt;&lt; 3,
 
117
        GEDIT_WINDOW_STATE_ERROR                = 1 &lt;&lt; 4,
 
118
        GEDIT_WINDOW_STATE_SAVING_SESSION       = 1 &lt;&lt; 5
 
119
} GeditWindowState;
 
120
</programlisting>
 
121
<para>
 
122
</para></refsect2>
 
123
<refsect2 id="GeditWindowPrivate" role="struct">
 
124
<title>GeditWindowPrivate</title>
 
125
<indexterm zone="GeditWindowPrivate"><primary sortas="GeditWindowPrivate">GeditWindowPrivate</primary></indexterm><programlisting>typedef struct _GeditWindowPrivate GeditWindowPrivate;</programlisting>
 
126
<para>
 
127
</para></refsect2>
 
128
<refsect2 id="GeditWindow-struct" role="struct">
 
129
<title>GeditWindow</title>
 
130
<indexterm zone="GeditWindow-struct"><primary sortas="GeditWindow">GeditWindow</primary></indexterm><programlisting>typedef struct _GeditWindow GeditWindow;</programlisting>
 
131
<para>
 
132
</para></refsect2>
 
133
<refsect2 id="gedit-window-create-tab" role="function">
 
134
<title>gedit_window_create_tab ()</title>
 
135
<indexterm zone="gedit-window-create-tab"><primary sortas="gedit_window_create_tab">gedit_window_create_tab</primary></indexterm><programlisting><link linkend="GeditTab">GeditTab</link> *          gedit_window_create_tab             (<link linkend="GeditWindow">GeditWindow</link> *window,
 
136
                                                         <link linkend="gboolean">gboolean</link> jump_to);</programlisting>
 
137
<para>
 
138
Creates a new <link linkend="GeditTab"><type>GeditTab</type></link> and adds the new tab to the <link linkend="GeditNotebook"><type>GeditNotebook</type></link>.
 
139
In case <parameter>jump_to</parameter> is <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> the <link linkend="GeditNotebook"><type>GeditNotebook</type></link> switches to that new <link linkend="GeditTab"><type>GeditTab</type></link>.</para>
 
140
<para>
 
141
</para><variablelist role="params">
 
142
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
143
<listitem><simpara> a <link linkend="GeditWindow"><type>GeditWindow</type></link>
 
144
</simpara></listitem></varlistentry>
 
145
<varlistentry><term><parameter>jump_to</parameter>&#160;:</term>
 
146
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> to set the new <link linkend="GeditTab"><type>GeditTab</type></link> as active
 
147
</simpara></listitem></varlistentry>
 
148
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GeditTab"><type>GeditTab</type></link>
 
149
</simpara></listitem></varlistentry>
 
150
</variablelist></refsect2>
 
151
<refsect2 id="gedit-window-create-tab-from-uri" role="function">
 
152
<title>gedit_window_create_tab_from_uri ()</title>
 
153
<indexterm zone="gedit-window-create-tab-from-uri"><primary sortas="gedit_window_create_tab_from_uri">gedit_window_create_tab_from_uri</primary></indexterm><programlisting><link linkend="GeditTab">GeditTab</link> *          gedit_window_create_tab_from_uri    (<link linkend="GeditWindow">GeditWindow</link> *window,
 
154
                                                         const <link linkend="gchar">gchar</link> *uri,
 
155
                                                         const <link linkend="GeditEncoding">GeditEncoding</link> *encoding,
 
156
                                                         <link linkend="gint">gint</link> line_pos,
 
157
                                                         <link linkend="gboolean">gboolean</link> create,
 
158
                                                         <link linkend="gboolean">gboolean</link> jump_to);</programlisting>
 
159
<para>
 
160
Creates a new <link linkend="GeditTab"><type>GeditTab</type></link> loading the document specified by <parameter>uri</parameter>.
 
161
In case <parameter>jump_to</parameter> is <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> the <link linkend="GeditNotebook"><type>GeditNotebook</type></link> swithes to that new <link linkend="GeditTab"><type>GeditTab</type></link>.
 
162
Whether <parameter>create</parameter> is <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>, creates a new empty document if location does 
 
163
not refer to an existing file</para>
 
164
<para>
 
165
</para><variablelist role="params">
 
166
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
167
<listitem><simpara> a <link linkend="GeditWindow"><type>GeditWindow</type></link>
 
168
</simpara></listitem></varlistentry>
 
169
<varlistentry><term><parameter>uri</parameter>&#160;:</term>
 
170
<listitem><simpara> the uri of the document
 
171
</simpara></listitem></varlistentry>
 
172
<varlistentry><term><parameter>encoding</parameter>&#160;:</term>
 
173
<listitem><simpara> a <link linkend="GeditEncoding"><type>GeditEncoding</type></link>
 
174
</simpara></listitem></varlistentry>
 
175
<varlistentry><term><parameter>line_pos</parameter>&#160;:</term>
 
176
<listitem><simpara> the line position to visualize
 
177
</simpara></listitem></varlistentry>
 
178
<varlistentry><term><parameter>create</parameter>&#160;:</term>
 
179
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> to create a new document in case <parameter>uri</parameter> does exist
 
180
</simpara></listitem></varlistentry>
 
181
<varlistentry><term><parameter>jump_to</parameter>&#160;:</term>
 
182
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> to set the new <link linkend="GeditTab"><type>GeditTab</type></link> as active
 
183
</simpara></listitem></varlistentry>
 
184
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GeditTab"><type>GeditTab</type></link>
 
185
</simpara></listitem></varlistentry>
 
186
</variablelist></refsect2>
 
187
<refsect2 id="gedit-window-close-tab" role="function">
 
188
<title>gedit_window_close_tab ()</title>
 
189
<indexterm zone="gedit-window-close-tab"><primary sortas="gedit_window_close_tab">gedit_window_close_tab</primary></indexterm><programlisting><link linkend="void">void</link>                gedit_window_close_tab              (<link linkend="GeditWindow">GeditWindow</link> *window,
 
190
                                                         <link linkend="GeditTab">GeditTab</link> *tab);</programlisting>
 
191
<para>
 
192
Closes the <parameter>tab</parameter>.</para>
 
193
<para>
 
194
</para><variablelist role="params">
 
195
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
196
<listitem><simpara> a <link linkend="GeditWindow"><type>GeditWindow</type></link>
 
197
</simpara></listitem></varlistentry>
 
198
<varlistentry><term><parameter>tab</parameter>&#160;:</term>
 
199
<listitem><simpara> the <link linkend="GeditTab"><type>GeditTab</type></link> to close
 
200
</simpara></listitem></varlistentry>
 
201
</variablelist></refsect2>
 
202
<refsect2 id="gedit-window-close-all-tabs" role="function">
 
203
<title>gedit_window_close_all_tabs ()</title>
 
204
<indexterm zone="gedit-window-close-all-tabs"><primary sortas="gedit_window_close_all_tabs">gedit_window_close_all_tabs</primary></indexterm><programlisting><link linkend="void">void</link>                gedit_window_close_all_tabs         (<link linkend="GeditWindow">GeditWindow</link> *window);</programlisting>
 
205
<para>
 
206
Closes all opened tabs.</para>
 
207
<para>
 
208
</para><variablelist role="params">
 
209
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
210
<listitem><simpara> a <link linkend="GeditWindow"><type>GeditWindow</type></link>
 
211
</simpara></listitem></varlistentry>
 
212
</variablelist></refsect2>
 
213
<refsect2 id="gedit-window-close-tabs" role="function">
 
214
<title>gedit_window_close_tabs ()</title>
 
215
<indexterm zone="gedit-window-close-tabs"><primary sortas="gedit_window_close_tabs">gedit_window_close_tabs</primary></indexterm><programlisting><link linkend="void">void</link>                gedit_window_close_tabs             (<link linkend="GeditWindow">GeditWindow</link> *window,
 
216
                                                         const <link linkend="GList">GList</link> *tabs);</programlisting>
 
217
<para>
 
218
Closes all tabs specified by <parameter>tabs</parameter>.</para>
 
219
<para>
 
220
</para><variablelist role="params">
 
221
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
222
<listitem><simpara> a <link linkend="GeditWindow"><type>GeditWindow</type></link>
 
223
</simpara></listitem></varlistentry>
 
224
<varlistentry><term><parameter>tabs</parameter>&#160;:</term>
 
225
<listitem><simpara> a list of <link linkend="GeditTab"><type>GeditTab</type></link>
 
226
</simpara></listitem></varlistentry>
 
227
</variablelist></refsect2>
 
228
<refsect2 id="gedit-window-get-active-tab" role="function">
 
229
<title>gedit_window_get_active_tab ()</title>
 
230
<indexterm zone="gedit-window-get-active-tab"><primary sortas="gedit_window_get_active_tab">gedit_window_get_active_tab</primary></indexterm><programlisting><link linkend="GeditTab">GeditTab</link> *          gedit_window_get_active_tab         (<link linkend="GeditWindow">GeditWindow</link> *window);</programlisting>
 
231
<para>
 
232
Gets the active <link linkend="GeditTab"><type>GeditTab</type></link> in the <parameter>window</parameter>.</para>
 
233
<para>
 
234
</para><variablelist role="params">
 
235
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
236
<listitem><simpara> a GeditWindow
 
237
</simpara></listitem></varlistentry>
 
238
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the active <link linkend="GeditTab"><type>GeditTab</type></link> in the <parameter>window</parameter>.
 
239
</simpara></listitem></varlistentry>
 
240
</variablelist></refsect2>
 
241
<refsect2 id="gedit-window-set-active-tab" role="function">
 
242
<title>gedit_window_set_active_tab ()</title>
 
243
<indexterm zone="gedit-window-set-active-tab"><primary sortas="gedit_window_set_active_tab">gedit_window_set_active_tab</primary></indexterm><programlisting><link linkend="void">void</link>                gedit_window_set_active_tab         (<link linkend="GeditWindow">GeditWindow</link> *window,
 
244
                                                         <link linkend="GeditTab">GeditTab</link> *tab);</programlisting>
 
245
<para>
 
246
Switches to the tab that matches with <parameter>tab</parameter>.</para>
 
247
<para>
 
248
</para><variablelist role="params">
 
249
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
250
<listitem><simpara> a <link linkend="GeditWindow"><type>GeditWindow</type></link>
 
251
</simpara></listitem></varlistentry>
 
252
<varlistentry><term><parameter>tab</parameter>&#160;:</term>
 
253
<listitem><simpara> a <link linkend="GeditTab"><type>GeditTab</type></link>
 
254
</simpara></listitem></varlistentry>
 
255
</variablelist></refsect2>
 
256
<refsect2 id="gedit-window-get-active-view" role="function">
 
257
<title>gedit_window_get_active_view ()</title>
 
258
<indexterm zone="gedit-window-get-active-view"><primary sortas="gedit_window_get_active_view">gedit_window_get_active_view</primary></indexterm><programlisting><link linkend="GeditView">GeditView</link> *         gedit_window_get_active_view        (<link linkend="GeditWindow">GeditWindow</link> *window);</programlisting>
 
259
<para>
 
260
Gets the active <link linkend="GeditView"><type>GeditView</type></link>.</para>
 
261
<para>
 
262
</para><variablelist role="params">
 
263
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
264
<listitem><simpara> a <link linkend="GeditWindow"><type>GeditWindow</type></link>
 
265
</simpara></listitem></varlistentry>
 
266
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the active <link linkend="GeditView"><type>GeditView</type></link>
 
267
</simpara></listitem></varlistentry>
 
268
</variablelist></refsect2>
 
269
<refsect2 id="gedit-window-get-active-document" role="function">
 
270
<title>gedit_window_get_active_document ()</title>
 
271
<indexterm zone="gedit-window-get-active-document"><primary sortas="gedit_window_get_active_document">gedit_window_get_active_document</primary></indexterm><programlisting><link linkend="GeditDocument">GeditDocument</link> *     gedit_window_get_active_document    (<link linkend="GeditWindow">GeditWindow</link> *window);</programlisting>
 
272
<para>
 
273
Gets the active <link linkend="GeditDocument"><type>GeditDocument</type></link>.</para>
 
274
<para>
 
275
</para><variablelist role="params">
 
276
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
277
<listitem><simpara> a <link linkend="GeditWindow"><type>GeditWindow</type></link>
 
278
</simpara></listitem></varlistentry>
 
279
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the active <link linkend="GeditDocument"><type>GeditDocument</type></link>
 
280
</simpara></listitem></varlistentry>
 
281
</variablelist></refsect2>
 
282
<refsect2 id="gedit-window-get-documents" role="function">
 
283
<title>gedit_window_get_documents ()</title>
 
284
<indexterm zone="gedit-window-get-documents"><primary sortas="gedit_window_get_documents">gedit_window_get_documents</primary></indexterm><programlisting><link linkend="GList">GList</link> *             gedit_window_get_documents          (<link linkend="GeditWindow">GeditWindow</link> *window);</programlisting>
 
285
<para>
 
286
Gets a newly allocated list with all the documents in the window.
 
287
This list must be freed.</para>
 
288
<para>
 
289
</para><variablelist role="params">
 
290
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
291
<listitem><simpara> a <link linkend="GeditWindow"><type>GeditWindow</type></link>
 
292
</simpara></listitem></varlistentry>
 
293
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a newly allocated list with all the documents in the window
 
294
</simpara></listitem></varlistentry>
 
295
</variablelist></refsect2>
 
296
<refsect2 id="gedit-window-get-unsaved-documents" role="function">
 
297
<title>gedit_window_get_unsaved_documents ()</title>
 
298
<indexterm zone="gedit-window-get-unsaved-documents"><primary sortas="gedit_window_get_unsaved_documents">gedit_window_get_unsaved_documents</primary></indexterm><programlisting><link linkend="GList">GList</link> *             gedit_window_get_unsaved_documents  (<link linkend="GeditWindow">GeditWindow</link> *window);</programlisting>
 
299
<para>
 
300
Gets the list of documents that need to be saved before closing the window.</para>
 
301
<para>
 
302
</para><variablelist role="params">
 
303
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
304
<listitem><simpara> a <link linkend="GeditWindow"><type>GeditWindow</type></link>
 
305
</simpara></listitem></varlistentry>
 
306
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a list of <link linkend="GeditDocument"><type>GeditDocument</type></link> that need to be saved before closing the window
 
307
</simpara></listitem></varlistentry>
 
308
</variablelist></refsect2>
 
309
<refsect2 id="gedit-window-get-views" role="function">
 
310
<title>gedit_window_get_views ()</title>
 
311
<indexterm zone="gedit-window-get-views"><primary sortas="gedit_window_get_views">gedit_window_get_views</primary></indexterm><programlisting><link linkend="GList">GList</link> *             gedit_window_get_views              (<link linkend="GeditWindow">GeditWindow</link> *window);</programlisting>
 
312
<para>
 
313
Gets a list with all the views in the window. This list must be freed.</para>
 
314
<para>
 
315
</para><variablelist role="params">
 
316
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
317
<listitem><simpara> a <link linkend="GeditWindow"><type>GeditWindow</type></link>
 
318
</simpara></listitem></varlistentry>
 
319
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a newly allocated list with all the views in the window
 
320
</simpara></listitem></varlistentry>
 
321
</variablelist></refsect2>
 
322
<refsect2 id="gedit-window-get-group" role="function">
 
323
<title>gedit_window_get_group ()</title>
 
324
<indexterm zone="gedit-window-get-group"><primary sortas="gedit_window_get_group">gedit_window_get_group</primary></indexterm><programlisting><link linkend="GtkWindowGroup">GtkWindowGroup</link> *    gedit_window_get_group              (<link linkend="GeditWindow">GeditWindow</link> *window);</programlisting>
 
325
<para>
 
326
Gets the <link linkend="GtkWindowGroup"><type>GtkWindowGroup</type></link> in which <parameter>window</parameter> resides.</para>
 
327
<para>
 
328
</para><variablelist role="params">
 
329
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
330
<listitem><simpara> a <link linkend="GeditWindow"><type>GeditWindow</type></link>
 
331
</simpara></listitem></varlistentry>
 
332
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the <link linkend="GtkWindowGroup"><type>GtkWindowGroup</type></link>
 
333
</simpara></listitem></varlistentry>
 
334
</variablelist></refsect2>
 
335
<refsect2 id="gedit-window-get-side-panel" role="function">
 
336
<title>gedit_window_get_side_panel ()</title>
 
337
<indexterm zone="gedit-window-get-side-panel"><primary sortas="gedit_window_get_side_panel">gedit_window_get_side_panel</primary></indexterm><programlisting><link linkend="GeditPanel">GeditPanel</link> *        gedit_window_get_side_panel         (<link linkend="GeditWindow">GeditWindow</link> *window);</programlisting>
 
338
<para>
 
339
Gets the side <link linkend="GeditPanel"><type>GeditPanel</type></link> of the <parameter>window</parameter>.</para>
 
340
<para>
 
341
</para><variablelist role="params">
 
342
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
343
<listitem><simpara> a <link linkend="GeditWindow"><type>GeditWindow</type></link>
 
344
</simpara></listitem></varlistentry>
 
345
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the side <link linkend="GeditPanel"><type>GeditPanel</type></link>.
 
346
</simpara></listitem></varlistentry>
 
347
</variablelist></refsect2>
 
348
<refsect2 id="gedit-window-get-bottom-panel" role="function">
 
349
<title>gedit_window_get_bottom_panel ()</title>
 
350
<indexterm zone="gedit-window-get-bottom-panel"><primary sortas="gedit_window_get_bottom_panel">gedit_window_get_bottom_panel</primary></indexterm><programlisting><link linkend="GeditPanel">GeditPanel</link> *        gedit_window_get_bottom_panel       (<link linkend="GeditWindow">GeditWindow</link> *window);</programlisting>
 
351
<para>
 
352
Gets the bottom <link linkend="GeditPanel"><type>GeditPanel</type></link> of the <parameter>window</parameter>.</para>
 
353
<para>
 
354
</para><variablelist role="params">
 
355
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
356
<listitem><simpara> a <link linkend="GeditWindow"><type>GeditWindow</type></link>
 
357
</simpara></listitem></varlistentry>
 
358
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the bottom <link linkend="GeditPanel"><type>GeditPanel</type></link>.
 
359
</simpara></listitem></varlistentry>
 
360
</variablelist></refsect2>
 
361
<refsect2 id="gedit-window-get-statusbar" role="function">
 
362
<title>gedit_window_get_statusbar ()</title>
 
363
<indexterm zone="gedit-window-get-statusbar"><primary sortas="gedit_window_get_statusbar">gedit_window_get_statusbar</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gedit_window_get_statusbar          (<link linkend="GeditWindow">GeditWindow</link> *window);</programlisting>
 
364
<para>
 
365
Gets the <link linkend="GeditStatusbar"><type>GeditStatusbar</type></link> of the <parameter>window</parameter>.</para>
 
366
<para>
 
367
</para><variablelist role="params">
 
368
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
369
<listitem><simpara> a <link linkend="GeditWindow"><type>GeditWindow</type></link>
 
370
</simpara></listitem></varlistentry>
 
371
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the <link linkend="GeditStatusbar"><type>GeditStatusbar</type></link> of the <parameter>window</parameter>.
 
372
</simpara></listitem></varlistentry>
 
373
</variablelist></refsect2>
 
374
<refsect2 id="gedit-window-get-ui-manager" role="function">
 
375
<title>gedit_window_get_ui_manager ()</title>
 
376
<indexterm zone="gedit-window-get-ui-manager"><primary sortas="gedit_window_get_ui_manager">gedit_window_get_ui_manager</primary></indexterm><programlisting><link linkend="GtkUIManager">GtkUIManager</link> *      gedit_window_get_ui_manager         (<link linkend="GeditWindow">GeditWindow</link> *window);</programlisting>
 
377
<para>
 
378
Gets the <link linkend="GtkUIManager"><type>GtkUIManager</type></link> associated with the <parameter>window</parameter>.</para>
 
379
<para>
 
380
</para><variablelist role="params">
 
381
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
382
<listitem><simpara> a <link linkend="GeditWindow"><type>GeditWindow</type></link>
 
383
</simpara></listitem></varlistentry>
 
384
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the <link linkend="GtkUIManager"><type>GtkUIManager</type></link> of the <parameter>window</parameter>.
 
385
</simpara></listitem></varlistentry>
 
386
</variablelist></refsect2>
 
387
<refsect2 id="gedit-window-get-state" role="function">
 
388
<title>gedit_window_get_state ()</title>
 
389
<indexterm zone="gedit-window-get-state"><primary sortas="gedit_window_get_state">gedit_window_get_state</primary></indexterm><programlisting><link linkend="GeditWindowState">GeditWindowState</link>    gedit_window_get_state              (<link linkend="GeditWindow">GeditWindow</link> *window);</programlisting>
 
390
<para>
 
391
Retrieves the state of the <parameter>window</parameter>.</para>
 
392
<para>
 
393
</para><variablelist role="params">
 
394
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
395
<listitem><simpara> a <link linkend="GeditWindow"><type>GeditWindow</type></link>
 
396
</simpara></listitem></varlistentry>
 
397
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the current <link linkend="GeditWindowState"><type>GeditWindowState</type></link> of the <parameter>window</parameter>.
 
398
</simpara></listitem></varlistentry>
 
399
</variablelist></refsect2>
 
400
<refsect2 id="gedit-window-get-tab-from-location" role="function">
 
401
<title>gedit_window_get_tab_from_location ()</title>
 
402
<indexterm zone="gedit-window-get-tab-from-location"><primary sortas="gedit_window_get_tab_from_location">gedit_window_get_tab_from_location</primary></indexterm><programlisting><link linkend="GeditTab">GeditTab</link> *          gedit_window_get_tab_from_location  (<link linkend="GeditWindow">GeditWindow</link> *window,
 
403
                                                         <link linkend="GFile">GFile</link> *location);</programlisting>
 
404
<para>
 
405
Gets the <link linkend="GeditTab"><type>GeditTab</type></link> that matches with the given <parameter>location</parameter>.</para>
 
406
<para>
 
407
</para><variablelist role="params">
 
408
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
409
<listitem><simpara> a <link linkend="GeditWindow"><type>GeditWindow</type></link>
 
410
</simpara></listitem></varlistentry>
 
411
<varlistentry><term><parameter>location</parameter>&#160;:</term>
 
412
<listitem><simpara> a <link linkend="GFile"><type>GFile</type></link>
 
413
</simpara></listitem></varlistentry>
 
414
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the <link linkend="GeditTab"><type>GeditTab</type></link> that matches with the given <parameter>location</parameter>.
 
415
</simpara></listitem></varlistentry>
 
416
</variablelist></refsect2>
 
417
<refsect2 id="gedit-window-get-tab-from-uri" role="function" condition="deprecated:2.24: Use gedit_window_get_tab_from_location() instead.">
 
418
<title>gedit_window_get_tab_from_uri ()</title>
 
419
<indexterm zone="gedit-window-get-tab-from-uri" role="deprecated"><primary sortas="gedit_window_get_tab_from_uri">gedit_window_get_tab_from_uri</primary></indexterm><programlisting><link linkend="GeditTab">GeditTab</link> *          gedit_window_get_tab_from_uri       (<link linkend="GeditWindow">GeditWindow</link> *window,
 
420
                                                         const <link linkend="gchar">gchar</link> *uri);</programlisting>
 
421
<warning><para><literal>gedit_window_get_tab_from_uri</literal> has been deprecated since version 2.24 and should not be used in newly-written code. Use <link linkend="gedit-window-get-tab-from-location"><function>gedit_window_get_tab_from_location()</function></link> instead.</para></warning>
 
422
<para>
 
423
Gets the <link linkend="GeditTab"><type>GeditTab</type></link> that matches <parameter>uri</parameter>.</para>
 
424
<para>
 
425
</para><variablelist role="params">
 
426
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
427
<listitem><simpara> a <link linkend="GeditWindow"><type>GeditWindow</type></link>
 
428
</simpara></listitem></varlistentry>
 
429
<varlistentry><term><parameter>uri</parameter>&#160;:</term>
 
430
<listitem><simpara> the uri to get the <link linkend="GeditTab"><type>GeditTab</type></link>
 
431
</simpara></listitem></varlistentry>
 
432
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the <link linkend="GeditTab"><type>GeditTab</type></link> associated with <parameter>uri</parameter>.
 
433
 
 
434
</simpara></listitem></varlistentry>
 
435
</variablelist></refsect2>
 
436
<refsect2 id="gedit-window-get-message-bus" role="function">
 
437
<title>gedit_window_get_message_bus ()</title>
 
438
<indexterm zone="gedit-window-get-message-bus"><primary sortas="gedit_window_get_message_bus">gedit_window_get_message_bus</primary></indexterm><programlisting><link linkend="GeditMessageBus">GeditMessageBus</link> *   gedit_window_get_message_bus        (<link linkend="GeditWindow">GeditWindow</link> *window);</programlisting>
 
439
<para>
 
440
Gets the <link linkend="GeditMessageBus"><type>GeditMessageBus</type></link> associated with <parameter>window</parameter>. The returned reference
 
441
is owned by the window and should not be unreffed.</para>
 
442
<para>
 
443
</para><variablelist role="params">
 
444
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
445
<listitem><simpara> a <link linkend="GeditWindow"><type>GeditWindow</type></link>
 
446
</simpara></listitem></varlistentry>
 
447
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the <link linkend="GeditMessageBus"><type>GeditMessageBus</type></link> associated with <parameter>window</parameter>
 
448
</simpara></listitem></varlistentry>
 
449
</variablelist></refsect2>
 
450
 
 
451
</refsect1>
 
452
<refsect1 id="GeditWindow.property-details" role="property_details">
 
453
<title role="property_details.title">Property Details</title>
 
454
<refsect2 id="GeditWindow--state" role="property"><title>The <literal>&quot;state&quot;</literal> property</title>
 
455
<indexterm zone="GeditWindow--state"><primary sortas="GeditWindow:state">GeditWindow:state</primary></indexterm><programlisting>  &quot;state&quot;                    <link linkend="GeditWindowState">GeditWindowState</link>      : Read</programlisting>
 
456
<para>The window's state.</para></refsect2>
 
457
</refsect1>
 
458
 
 
459
<refsect1 id="GeditWindow.signal-details" role="signals">
 
460
<title role="signals.title">Signal Details</title>
 
461
<refsect2 id="GeditWindow-active-tab-changed" role="signal"><title>The <literal>&quot;active-tab-changed&quot;</literal> signal</title>
 
462
<indexterm zone="GeditWindow-active-tab-changed"><primary sortas="GeditWindow::active-tab-changed">GeditWindow::active-tab-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GeditWindow">GeditWindow</link> *geditwindow,
 
463
                                                        <link linkend="GeditTab">GeditTab</link>    *arg1,
 
464
                                                        <link linkend="gpointer">gpointer</link>     user_data)        : Run First</programlisting>
 
465
<para>
 
466
</para><variablelist role="params">
 
467
<varlistentry><term><parameter>geditwindow</parameter>&#160;:</term>
 
468
<listitem><simpara>the object which received the signal.
 
469
</simpara></listitem></varlistentry>
 
470
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
 
471
<listitem><simpara>
 
472
</simpara></listitem></varlistentry>
 
473
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
 
474
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
475
</variablelist></refsect2><refsect2 id="GeditWindow-active-tab-state-changed" role="signal"><title>The <literal>&quot;active-tab-state-changed&quot;</literal> signal</title>
 
476
<indexterm zone="GeditWindow-active-tab-state-changed"><primary sortas="GeditWindow::active-tab-state-changed">GeditWindow::active-tab-state-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GeditWindow">GeditWindow</link> *geditwindow,
 
477
                                                        <link linkend="gpointer">gpointer</link>     user_data)        : Run First</programlisting>
 
478
<para>
 
479
</para><variablelist role="params">
 
480
<varlistentry><term><parameter>geditwindow</parameter>&#160;:</term>
 
481
<listitem><simpara>the object which received the signal.
 
482
</simpara></listitem></varlistentry>
 
483
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
 
484
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
485
</variablelist></refsect2><refsect2 id="GeditWindow-tab-added" role="signal"><title>The <literal>&quot;tab-added&quot;</literal> signal</title>
 
486
<indexterm zone="GeditWindow-tab-added"><primary sortas="GeditWindow::tab-added">GeditWindow::tab-added</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GeditWindow">GeditWindow</link> *geditwindow,
 
487
                                                        <link linkend="GeditTab">GeditTab</link>    *arg1,
 
488
                                                        <link linkend="gpointer">gpointer</link>     user_data)        : Run First</programlisting>
 
489
<para>
 
490
</para><variablelist role="params">
 
491
<varlistentry><term><parameter>geditwindow</parameter>&#160;:</term>
 
492
<listitem><simpara>the object which received the signal.
 
493
</simpara></listitem></varlistentry>
 
494
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
 
495
<listitem><simpara>
 
496
</simpara></listitem></varlistentry>
 
497
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
 
498
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
499
</variablelist></refsect2><refsect2 id="GeditWindow-tab-removed" role="signal"><title>The <literal>&quot;tab-removed&quot;</literal> signal</title>
 
500
<indexterm zone="GeditWindow-tab-removed"><primary sortas="GeditWindow::tab-removed">GeditWindow::tab-removed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GeditWindow">GeditWindow</link> *geditwindow,
 
501
                                                        <link linkend="GeditTab">GeditTab</link>    *arg1,
 
502
                                                        <link linkend="gpointer">gpointer</link>     user_data)        : Run First</programlisting>
 
503
<para>
 
504
</para><variablelist role="params">
 
505
<varlistentry><term><parameter>geditwindow</parameter>&#160;:</term>
 
506
<listitem><simpara>the object which received the signal.
 
507
</simpara></listitem></varlistentry>
 
508
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
 
509
<listitem><simpara>
 
510
</simpara></listitem></varlistentry>
 
511
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
 
512
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
513
</variablelist></refsect2><refsect2 id="GeditWindow-tabs-reordered" role="signal"><title>The <literal>&quot;tabs-reordered&quot;</literal> signal</title>
 
514
<indexterm zone="GeditWindow-tabs-reordered"><primary sortas="GeditWindow::tabs-reordered">GeditWindow::tabs-reordered</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GeditWindow">GeditWindow</link> *geditwindow,
 
515
                                                        <link linkend="gpointer">gpointer</link>     user_data)        : Run First</programlisting>
 
516
<para>
 
517
</para><variablelist role="params">
 
518
<varlistentry><term><parameter>geditwindow</parameter>&#160;:</term>
 
519
<listitem><simpara>the object which received the signal.
 
520
</simpara></listitem></varlistentry>
 
521
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
 
522
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
523
</variablelist></refsect2>
 
524
</refsect1>
 
525
 
 
526
 
 
527
 
 
528
</refentry>