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>GeditTab</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="GeditStatusbar.html" title="GeditStatusbar">
10
<link rel="next" href="GeditView.html" title="GeditView">
11
<meta name="generator" content="GTK-Doc V1.11 (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="GeditStatusbar.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="GeditView.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="#GeditTab.synopsis" class="shortcut">Top</a>
27
<a href="#GeditTab.description" class="shortcut">Description</a>
29
<a href="#GeditTab.object-hierarchy" class="shortcut">Object Hierarchy</a>
31
<a href="#GeditTab.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
33
<a href="#GeditTab.properties" class="shortcut">Properties</a>
36
<div class="refentry" title="GeditTab">
37
<a name="GeditTab"></a><div class="titlepage"></div>
38
<div class="refnamediv"><table width="100%"><tr>
40
<h2><span class="refentrytitle"><a name="GeditTab.top_of_page"></a>GeditTab</span></h2>
43
<td valign="top" align="right"></td>
45
<div class="refsynopsisdiv" title="Synopsis">
46
<a name="GeditTab.synopsis"></a><h2>Synopsis</h2>
47
<pre class="synopsis">
48
enum <a class="link" href="GeditTab.html#GeditTabState" title="enum GeditTabState">GeditTabState</a>;
49
<a class="link" href="GeditTab.html#GeditTabPrivate" title="GeditTabPrivate">GeditTabPrivate</a>;
50
<a class="link" href="GeditTab.html#GeditTab-struct" title="GeditTab">GeditTab</a>;
51
<a class="link" href="GeditView.html" title="GeditView">GeditView</a> * <a class="link" href="GeditTab.html#gedit-tab-get-view" title="gedit_tab_get_view ()">gedit_tab_get_view</a> (<a class="link" href="GeditTab.html" title="GeditTab">GeditTab</a> *tab);
52
<a class="link" href="GeditDocument.html" title="GeditDocument">GeditDocument</a> * <a class="link" href="GeditTab.html#gedit-tab-get-document" title="gedit_tab_get_document ()">gedit_tab_get_document</a> (<a class="link" href="GeditTab.html" title="GeditTab">GeditTab</a> *tab);
53
<a class="link" href="GeditTab.html" title="GeditTab">GeditTab</a> * <a class="link" href="GeditTab.html#gedit-tab-get-from-document" title="gedit_tab_get_from_document ()">gedit_tab_get_from_document</a> (<a class="link" href="GeditDocument.html" title="GeditDocument">GeditDocument</a> *doc);
54
<a class="link" href="GeditTab.html#GeditTabState" title="enum GeditTabState">GeditTabState</a> <a class="link" href="GeditTab.html#gedit-tab-get-state" title="gedit_tab_get_state ()">gedit_tab_get_state</a> (<a class="link" href="GeditTab.html" title="GeditTab">GeditTab</a> *tab);
56
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
57
>gboolean</a> <a class="link" href="GeditTab.html#gedit-tab-get-auto-save-enabled" title="gedit_tab_get_auto_save_enabled ()">gedit_tab_get_auto_save_enabled</a> (<a class="link" href="GeditTab.html" title="GeditTab">GeditTab</a> *tab);
58
void <a class="link" href="GeditTab.html#gedit-tab-set-auto-save-enabled" title="gedit_tab_set_auto_save_enabled ()">gedit_tab_set_auto_save_enabled</a> (<a class="link" href="GeditTab.html" title="GeditTab">GeditTab</a> *tab,
60
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
61
>gboolean</a> enable);
63
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
64
>gint</a> <a class="link" href="GeditTab.html#gedit-tab-get-auto-save-interval" title="gedit_tab_get_auto_save_interval ()">gedit_tab_get_auto_save_interval</a> (<a class="link" href="GeditTab.html" title="GeditTab">GeditTab</a> *tab);
65
void <a class="link" href="GeditTab.html#gedit-tab-set-auto-save-interval" title="gedit_tab_set_auto_save_interval ()">gedit_tab_set_auto_save_interval</a> (<a class="link" href="GeditTab.html" title="GeditTab">GeditTab</a> *tab,
67
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
71
<div class="refsect1" title="Object Hierarchy">
72
<a name="GeditTab.object-hierarchy"></a><h2>Object Hierarchy</h2>
73
<pre class="synopsis">
75
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
78
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
79
>GInitiallyUnowned</a>
81
href="http://library.gnome.org/devel/gtk/unstable/GtkObject.html"
84
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
87
href="http://library.gnome.org/devel/gtk/unstable/GtkContainer.html"
90
href="http://library.gnome.org/devel/gtk/unstable/GtkBox.html"
93
href="http://library.gnome.org/devel/gtk/unstable/GtkVBox.html"
98
<div class="refsect1" title="Implemented Interfaces">
99
<a name="GeditTab.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
102
AtkImplementorIface, <a
103
href="http://library.gnome.org/devel/gtk/unstable/gtk-gtkbuildable.html#GtkBuildable"
104
>GtkBuildable</a> and <a
105
href="http://library.gnome.org/devel/gtk/unstable/gtk-Orientable.html#GtkOrientable"
106
>GtkOrientable</a>.</p>
108
<div class="refsect1" title="Properties">
109
<a name="GeditTab.properties"></a><h2>Properties</h2>
110
<pre class="synopsis">
111
"<a class="link" href="GeditTab.html#GeditTab--autosave" title='The "autosave" property'>autosave</a>" <a
112
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
113
>gboolean</a> : Read / Write
114
"<a class="link" href="GeditTab.html#GeditTab--autosave-interval" title='The "autosave-interval" property'>autosave-interval</a>" <a
115
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
116
>gint</a> : Read / Write
117
"<a class="link" href="GeditTab.html#GeditTab--name" title='The "name" property'>name</a>" <a
118
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
120
"<a class="link" href="GeditTab.html#GeditTab--state" title='The "state" property'>state</a>" <a class="link" href="GeditTab.html#GeditTabState" title="enum GeditTabState">GeditTabState</a> : Read
123
<div class="refsect1" title="Description">
124
<a name="GeditTab.description"></a><h2>Description</h2>
128
<div class="refsect1" title="Details">
129
<a name="GeditTab.details"></a><h2>Details</h2>
130
<div class="refsect2" title="enum GeditTabState">
131
<a name="GeditTabState"></a><h3>enum GeditTabState</h3>
132
<pre class="programlisting">typedef enum
134
GEDIT_TAB_STATE_NORMAL = 0,
135
GEDIT_TAB_STATE_LOADING,
136
GEDIT_TAB_STATE_REVERTING,
137
GEDIT_TAB_STATE_SAVING,
138
GEDIT_TAB_STATE_PRINTING,
139
GEDIT_TAB_STATE_PRINT_PREVIEWING,
140
GEDIT_TAB_STATE_SHOWING_PRINT_PREVIEW,
141
GEDIT_TAB_STATE_GENERIC_NOT_EDITABLE,
142
GEDIT_TAB_STATE_LOADING_ERROR,
143
GEDIT_TAB_STATE_REVERTING_ERROR,
144
GEDIT_TAB_STATE_SAVING_ERROR,
145
GEDIT_TAB_STATE_GENERIC_ERROR,
146
GEDIT_TAB_STATE_CLOSING,
147
GEDIT_TAB_STATE_EXTERNALLY_MODIFIED_NOTIFICATION,
148
GEDIT_TAB_NUM_OF_STATES /* This is not a valid state */
155
<div class="refsect2" title="GeditTabPrivate">
156
<a name="GeditTabPrivate"></a><h3>GeditTabPrivate</h3>
157
<pre class="programlisting">typedef struct _GeditTabPrivate GeditTabPrivate;</pre>
162
<div class="refsect2" title="GeditTab">
163
<a name="GeditTab-struct"></a><h3>GeditTab</h3>
164
<pre class="programlisting">typedef struct _GeditTab GeditTab;</pre>
169
<div class="refsect2" title="gedit_tab_get_view ()">
170
<a name="gedit-tab-get-view"></a><h3>gedit_tab_get_view ()</h3>
171
<pre class="programlisting"><a class="link" href="GeditView.html" title="GeditView">GeditView</a> * gedit_tab_get_view (<a class="link" href="GeditTab.html" title="GeditTab">GeditTab</a> *tab);</pre>
173
Gets the <a class="link" href="GeditView.html" title="GeditView"><span class="type">GeditView</span></a> inside <em class="parameter"><code>tab</code></em>.</p>
176
<div class="variablelist"><table border="0">
177
<col align="left" valign="top">
180
<td><p><span class="term"><em class="parameter"><code>tab</code></em> :</span></p></td>
181
<td> a <a class="link" href="GeditTab.html" title="GeditTab"><span class="type">GeditTab</span></a>
185
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
186
<td> the <a class="link" href="GeditView.html" title="GeditView"><span class="type">GeditView</span></a> inside <em class="parameter"><code>tab</code></em>
193
<div class="refsect2" title="gedit_tab_get_document ()">
194
<a name="gedit-tab-get-document"></a><h3>gedit_tab_get_document ()</h3>
195
<pre class="programlisting"><a class="link" href="GeditDocument.html" title="GeditDocument">GeditDocument</a> * gedit_tab_get_document (<a class="link" href="GeditTab.html" title="GeditTab">GeditTab</a> *tab);</pre>
197
Gets the <a class="link" href="GeditDocument.html" title="GeditDocument"><span class="type">GeditDocument</span></a> associated to <em class="parameter"><code>tab</code></em>.</p>
200
<div class="variablelist"><table border="0">
201
<col align="left" valign="top">
204
<td><p><span class="term"><em class="parameter"><code>tab</code></em> :</span></p></td>
205
<td> a <a class="link" href="GeditTab.html" title="GeditTab"><span class="type">GeditTab</span></a>
209
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
210
<td> the <a class="link" href="GeditDocument.html" title="GeditDocument"><span class="type">GeditDocument</span></a> associated to <em class="parameter"><code>tab</code></em>
217
<div class="refsect2" title="gedit_tab_get_from_document ()">
218
<a name="gedit-tab-get-from-document"></a><h3>gedit_tab_get_from_document ()</h3>
219
<pre class="programlisting"><a class="link" href="GeditTab.html" title="GeditTab">GeditTab</a> * gedit_tab_get_from_document (<a class="link" href="GeditDocument.html" title="GeditDocument">GeditDocument</a> *doc);</pre>
221
Gets the <a class="link" href="GeditTab.html" title="GeditTab"><span class="type">GeditTab</span></a> associated with <em class="parameter"><code>doc</code></em>.</p>
224
<div class="variablelist"><table border="0">
225
<col align="left" valign="top">
228
<td><p><span class="term"><em class="parameter"><code>doc</code></em> :</span></p></td>
229
<td> a <a class="link" href="GeditDocument.html" title="GeditDocument"><span class="type">GeditDocument</span></a>
233
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
234
<td> the <a class="link" href="GeditTab.html" title="GeditTab"><span class="type">GeditTab</span></a> associated with <em class="parameter"><code>doc</code></em>
241
<div class="refsect2" title="gedit_tab_get_state ()">
242
<a name="gedit-tab-get-state"></a><h3>gedit_tab_get_state ()</h3>
243
<pre class="programlisting"><a class="link" href="GeditTab.html#GeditTabState" title="enum GeditTabState">GeditTabState</a> gedit_tab_get_state (<a class="link" href="GeditTab.html" title="GeditTab">GeditTab</a> *tab);</pre>
245
Gets the <a class="link" href="GeditTab.html#GeditTabState" title="enum GeditTabState"><span class="type">GeditTabState</span></a> of <em class="parameter"><code>tab</code></em>.</p>
248
<div class="variablelist"><table border="0">
249
<col align="left" valign="top">
252
<td><p><span class="term"><em class="parameter"><code>tab</code></em> :</span></p></td>
253
<td> a <a class="link" href="GeditTab.html" title="GeditTab"><span class="type">GeditTab</span></a>
257
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
258
<td> the <a class="link" href="GeditTab.html#GeditTabState" title="enum GeditTabState"><span class="type">GeditTabState</span></a> of <em class="parameter"><code>tab</code></em>
265
<div class="refsect2" title="gedit_tab_get_auto_save_enabled ()">
266
<a name="gedit-tab-get-auto-save-enabled"></a><h3>gedit_tab_get_auto_save_enabled ()</h3>
267
<pre class="programlisting"><a
268
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
269
>gboolean</a> gedit_tab_get_auto_save_enabled (<a class="link" href="GeditTab.html" title="GeditTab">GeditTab</a> *tab);</pre>
271
Gets the current state for the autosave feature</p>
274
<div class="variablelist"><table border="0">
275
<col align="left" valign="top">
278
<td><p><span class="term"><em class="parameter"><code>tab</code></em> :</span></p></td>
279
<td> a <a class="link" href="GeditTab.html" title="GeditTab"><span class="type">GeditTab</span></a>
283
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
284
<td> <code class="literal">TRUE</code> if the autosave is enabled, else <code class="literal">FALSE</code>
291
<div class="refsect2" title="gedit_tab_set_auto_save_enabled ()">
292
<a name="gedit-tab-set-auto-save-enabled"></a><h3>gedit_tab_set_auto_save_enabled ()</h3>
293
<pre class="programlisting">void gedit_tab_set_auto_save_enabled (<a class="link" href="GeditTab.html" title="GeditTab">GeditTab</a> *tab,
295
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
296
>gboolean</a> enable);</pre>
298
Enables or disables the autosave feature. It does not install an
299
autosave timeout if the document is new or is read-only</p>
302
<div class="variablelist"><table border="0">
303
<col align="left" valign="top">
306
<td><p><span class="term"><em class="parameter"><code>tab</code></em> :</span></p></td>
307
<td> a <a class="link" href="GeditTab.html" title="GeditTab"><span class="type">GeditTab</span></a>
311
<td><p><span class="term"><em class="parameter"><code>enable</code></em> :</span></p></td>
312
<td> enable (<code class="literal">TRUE</code>) or disable (<code class="literal">FALSE</code>) auto save
319
<div class="refsect2" title="gedit_tab_get_auto_save_interval ()">
320
<a name="gedit-tab-get-auto-save-interval"></a><h3>gedit_tab_get_auto_save_interval ()</h3>
321
<pre class="programlisting"><a
322
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
323
>gint</a> gedit_tab_get_auto_save_interval (<a class="link" href="GeditTab.html" title="GeditTab">GeditTab</a> *tab);</pre>
325
Gets the current interval for the autosaves</p>
328
<div class="variablelist"><table border="0">
329
<col align="left" valign="top">
332
<td><p><span class="term"><em class="parameter"><code>tab</code></em> :</span></p></td>
333
<td> a <a class="link" href="GeditTab.html" title="GeditTab"><span class="type">GeditTab</span></a>
337
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
338
<td> the value of the autosave
345
<div class="refsect2" title="gedit_tab_set_auto_save_interval ()">
346
<a name="gedit-tab-set-auto-save-interval"></a><h3>gedit_tab_set_auto_save_interval ()</h3>
347
<pre class="programlisting">void gedit_tab_set_auto_save_interval (<a class="link" href="GeditTab.html" title="GeditTab">GeditTab</a> *tab,
349
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
350
>gint</a> interval);</pre>
352
Sets the interval for the autosave feature. It does nothing if the
353
interval is the same as the one already present. It removes the old
354
interval timeout and adds a new one with the autosave passed as
358
<div class="variablelist"><table border="0">
359
<col align="left" valign="top">
362
<td><p><span class="term"><em class="parameter"><code>tab</code></em> :</span></p></td>
363
<td> a <a class="link" href="GeditTab.html" title="GeditTab"><span class="type">GeditTab</span></a>
367
<td><p><span class="term"><em class="parameter"><code>interval</code></em> :</span></p></td>
368
<td> the new interval
375
<div class="refsect1" title="Property Details">
376
<a name="GeditTab.property-details"></a><h2>Property Details</h2>
377
<div class="refsect2" title='The "autosave" property'>
378
<a name="GeditTab--autosave"></a><h3>The <code class="literal">"autosave"</code> property</h3>
379
<pre class="programlisting"> "autosave" <a
380
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
381
>gboolean</a> : Read / Write</pre>
382
<p>Autosave feature.</p>
383
<p>Default value: TRUE</p>
386
<div class="refsect2" title='The "autosave-interval" property'>
387
<a name="GeditTab--autosave-interval"></a><h3>The <code class="literal">"autosave-interval"</code> property</h3>
388
<pre class="programlisting"> "autosave-interval" <a
389
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
390
>gint</a> : Read / Write</pre>
391
<p>Time between two autosaves.</p>
392
<p>Allowed values: >= 0</p>
393
<p>Default value: 0</p>
396
<div class="refsect2" title='The "name" property'>
397
<a name="GeditTab--name"></a><h3>The <code class="literal">"name"</code> property</h3>
398
<pre class="programlisting"> "name" <a
399
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
400
>gchar</a>* : Read</pre>
401
<p>The tab's name.</p>
402
<p>Default value: NULL</p>
405
<div class="refsect2" title='The "state" property'>
406
<a name="GeditTab--state"></a><h3>The <code class="literal">"state"</code> property</h3>
407
<pre class="programlisting"> "state" <a class="link" href="GeditTab.html#GeditTabState" title="enum GeditTabState">GeditTabState</a> : Read</pre>
408
<p>The tab's state.</p>
409
<p>Default value: GEDIT_TAB_STATE_NORMAL</p>
415
Generated by GTK-Doc V1.11</div>