← Back to branch summary

~ubuntu-branches/ubuntu/vivid/gedit/vivid

« back to all changes in this revision

Viewing changes to docs/reference/html/gedit-gedit-tab.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-06-21 15:14:19 UTC
  • mfrom: (1.1.80 upstream)
  • Revision ID: james.westby@ubuntu.com-20100621151419-j79nqokj12vpw9u3
Tags: 2.30.3-0ubuntu1
https://launchpad.net/bugs/586848
* New upstream version
  - Misc bugfixes
  - Handle empty input gracefully (lp: #586848)
  - Translations update

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/gedit-gedit-tab.html
50
50
<a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="returnvalue">GeditDocument</span></a> *     <a class="link" href="gedit-gedit-tab.html#gedit-tab-get-document" title="gedit_tab_get_document ()">gedit_tab_get_document</a>              (<em class="parameter"><code><a class="link" href="gedit-gedit-tab.html#GeditTab"><span class="type">GeditTab</span></a> *tab</code></em>);
51
51
<a class="link" href="gedit-gedit-tab.html#GeditTab"><span class="returnvalue">GeditTab</span></a> *          <a class="link" href="gedit-gedit-tab.html#gedit-tab-get-from-document" title="gedit_tab_get_from_document ()">gedit_tab_get_from_document</a>         (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>);
52
52
<a class="link" href="gedit-gedit-tab.html#GeditTabState" title="enum GeditTabState"><span class="returnvalue">GeditTabState</span></a>       <a class="link" href="gedit-gedit-tab.html#gedit-tab-get-state" title="gedit_tab_get_state ()">gedit_tab_get_state</a>                 (<em class="parameter"><code><a class="link" href="gedit-gedit-tab.html#GeditTab"><span class="type">GeditTab</span></a> *tab</code></em>);
53
 
<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-tab.html#gedit-tab-get-auto-save-enabled" title="gedit_tab_get_auto_save_enabled ()">gedit_tab_get_auto_save_enabled</a>     (<em class="parameter"><code><a class="link" href="gedit-gedit-tab.html#GeditTab"><span class="type">GeditTab</span></a> *tab</code></em>);
 
53
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gedit-gedit-tab.html#gedit-tab-get-auto-save-enabled" title="gedit_tab_get_auto_save_enabled ()">gedit_tab_get_auto_save_enabled</a>     (<em class="parameter"><code><a class="link" href="gedit-gedit-tab.html#GeditTab"><span class="type">GeditTab</span></a> *tab</code></em>);
54
54
<span class="returnvalue">void</span>                <a class="link" href="gedit-gedit-tab.html#gedit-tab-set-auto-save-enabled" title="gedit_tab_set_auto_save_enabled ()">gedit_tab_set_auto_save_enabled</a>     (<em class="parameter"><code><a class="link" href="gedit-gedit-tab.html#GeditTab"><span class="type">GeditTab</span></a> *tab</code></em>,
55
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> enable</code></em>);
56
 
<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-tab.html#gedit-tab-get-auto-save-interval" title="gedit_tab_get_auto_save_interval ()">gedit_tab_get_auto_save_interval</a>    (<em class="parameter"><code><a class="link" href="gedit-gedit-tab.html#GeditTab"><span class="type">GeditTab</span></a> *tab</code></em>);
 
55
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> enable</code></em>);
 
56
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="gedit-gedit-tab.html#gedit-tab-get-auto-save-interval" title="gedit_tab_get_auto_save_interval ()">gedit_tab_get_auto_save_interval</a>    (<em class="parameter"><code><a class="link" href="gedit-gedit-tab.html#GeditTab"><span class="type">GeditTab</span></a> *tab</code></em>);
57
57
<span class="returnvalue">void</span>                <a class="link" href="gedit-gedit-tab.html#gedit-tab-set-auto-save-interval" title="gedit_tab_set_auto_save_interval ()">gedit_tab_set_auto_save_interval</a>    (<em class="parameter"><code><a class="link" href="gedit-gedit-tab.html#GeditTab"><span class="type">GeditTab</span></a> *tab</code></em>,
58
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> interval</code></em>);
 
58
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> interval</code></em>);
59
59
</pre>
60
60
</div>
61
61
<div class="refsect1" title="Object Hierarchy">
62
62
<a name="gedit-gedit-tab.object-hierarchy"></a><h2>Object Hierarchy</h2>
63
63
<pre class="synopsis">
64
 
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
65
 
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
66
 
         +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkObject.html">GtkObject</a>
67
 
               +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html">GtkWidget</a>
68
 
                     +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkContainer.html">GtkContainer</a>
69
 
                           +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkBox.html">GtkBox</a>
70
 
                                 +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkVBox.html">GtkVBox</a>
 
64
  <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
65
   +----<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
 
66
         +----<a href="/usr/share/gtk-doc/html/gtk/GtkObject.html">GtkObject</a>
 
67
               +----<a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html">GtkWidget</a>
 
68
                     +----<a href="/usr/share/gtk-doc/html/gtk/GtkContainer.html">GtkContainer</a>
 
69
                           +----<a href="/usr/share/gtk-doc/html/gtk/GtkBox.html">GtkBox</a>
 
70
                                 +----<a href="/usr/share/gtk-doc/html/gtk/GtkVBox.html">GtkVBox</a>
71
71
                                       +----GeditTab
72
72
</pre>
73
73
</div>
75
75
<a name="gedit-gedit-tab.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
76
76
<p>
77
77
GeditTab implements
78
 
 AtkImplementorIface,  <a href="http://library.gnome.org/devel/gtk/unstable/gtk-gtkbuildable.html#GtkBuildable">GtkBuildable</a> and  <a href="http://library.gnome.org/devel/gtk/unstable/gtk-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
 
78
 AtkImplementorIface,  <a href="/usr/share/gtk-doc/html/gtk/gtk-gtkbuildable.html#GtkBuildable">GtkBuildable</a> and  <a href="/usr/share/gtk-doc/html/gtk/gtk-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
79
79
</div>
80
80
<div class="refsect1" title="Properties">
81
81
<a name="gedit-gedit-tab.properties"></a><h2>Properties</h2>
82
82
<pre class="synopsis">
83
 
  "<a class="link" href="gedit-gedit-tab.html#GeditTab--autosave" title='The "autosave" property'>autosave</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
84
 
  "<a class="link" href="gedit-gedit-tab.html#GeditTab--autosave-interval" title='The "autosave-interval" property'>autosave-interval</a>"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
85
 
  "<a class="link" href="gedit-gedit-tab.html#GeditTab--name" title='The "name" property'>name</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
 
83
  "<a class="link" href="gedit-gedit-tab.html#GeditTab--autosave" title='The "autosave" property'>autosave</a>"                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
 
84
  "<a class="link" href="gedit-gedit-tab.html#GeditTab--autosave-interval" title='The "autosave-interval" property'>autosave-interval</a>"        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
 
85
  "<a class="link" href="gedit-gedit-tab.html#GeditTab--name" title='The "name" property'>name</a>"                     <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
86
86
  "<a class="link" href="gedit-gedit-tab.html#GeditTab--state" title='The "state" property'>state</a>"                    <a class="link" href="gedit-gedit-tab.html#GeditTabState" title="enum GeditTabState"><span class="type">GeditTabState</span></a>         : Read
87
87
</pre>
88
88
</div>
89
89
<div class="refsect1" title="Description">
90
90
<a name="gedit-gedit-tab.description"></a><h2>Description</h2>
91
 
<p>
92
 
</p>
93
91
</div>
94
92
<div class="refsect1" title="Details">
95
93
<a name="gedit-gedit-tab.details"></a><h2>Details</h2>
114
112
        GEDIT_TAB_NUM_OF_STATES /* This is not a valid state */
115
113
} GeditTabState;
116
114
</pre>
117
 
<p>
118
 
</p>
119
115
</div>
120
116
<hr>
121
117
<div class="refsect2" title="GeditTabPrivate">
122
118
<a name="GeditTabPrivate"></a><h3>GeditTabPrivate</h3>
123
119
<pre class="programlisting">typedef struct _GeditTabPrivate GeditTabPrivate;</pre>
124
 
<p>
125
 
</p>
126
120
</div>
127
121
<hr>
128
122
<div class="refsect2" title="GeditTab">
129
123
<a name="GeditTab-struct"></a><h3>GeditTab</h3>
130
124
<pre class="programlisting">typedef struct _GeditTab GeditTab;</pre>
131
 
<p>
132
 
</p>
133
125
</div>
134
126
<hr>
135
127
<div class="refsect2" title="gedit_tab_get_view ()">
226
218
<hr>
227
219
<div class="refsect2" title="gedit_tab_get_auto_save_enabled ()">
228
220
<a name="gedit-tab-get-auto-save-enabled"></a><h3>gedit_tab_get_auto_save_enabled ()</h3>
229
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gedit_tab_get_auto_save_enabled     (<em class="parameter"><code><a class="link" href="gedit-gedit-tab.html#GeditTab"><span class="type">GeditTab</span></a> *tab</code></em>);</pre>
 
221
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gedit_tab_get_auto_save_enabled     (<em class="parameter"><code><a class="link" href="gedit-gedit-tab.html#GeditTab"><span class="type">GeditTab</span></a> *tab</code></em>);</pre>
230
222
<p>
231
223
Gets the current state for the autosave feature
232
224
</p>
240
232
</tr>
241
233
<tr>
242
234
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
243
 
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the autosave is enabled, else <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
 
235
<td> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the autosave is enabled, else <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
244
236
</td>
245
237
</tr>
246
238
</tbody>
250
242
<div class="refsect2" title="gedit_tab_set_auto_save_enabled ()">
251
243
<a name="gedit-tab-set-auto-save-enabled"></a><h3>gedit_tab_set_auto_save_enabled ()</h3>
252
244
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_tab_set_auto_save_enabled     (<em class="parameter"><code><a class="link" href="gedit-gedit-tab.html#GeditTab"><span class="type">GeditTab</span></a> *tab</code></em>,
253
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> enable</code></em>);</pre>
 
245
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> enable</code></em>);</pre>
254
246
<p>
255
247
Enables or disables the autosave feature. It does not install an
256
248
autosave timeout if the document is new or is read-only
265
257
</tr>
266
258
<tr>
267
259
<td><p><span class="term"><em class="parameter"><code>enable</code></em> :</span></p></td>
268
 
<td>enable (<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>) or disable (<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>) auto save
 
260
<td>enable (<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>) or disable (<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>) auto save
269
261
</td>
270
262
</tr>
271
263
</tbody>
274
266
<hr>
275
267
<div class="refsect2" title="gedit_tab_get_auto_save_interval ()">
276
268
<a name="gedit-tab-get-auto-save-interval"></a><h3>gedit_tab_get_auto_save_interval ()</h3>
277
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                gedit_tab_get_auto_save_interval    (<em class="parameter"><code><a class="link" href="gedit-gedit-tab.html#GeditTab"><span class="type">GeditTab</span></a> *tab</code></em>);</pre>
 
269
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                gedit_tab_get_auto_save_interval    (<em class="parameter"><code><a class="link" href="gedit-gedit-tab.html#GeditTab"><span class="type">GeditTab</span></a> *tab</code></em>);</pre>
278
270
<p>
279
271
Gets the current interval for the autosaves
280
272
</p>
298
290
<div class="refsect2" title="gedit_tab_set_auto_save_interval ()">
299
291
<a name="gedit-tab-set-auto-save-interval"></a><h3>gedit_tab_set_auto_save_interval ()</h3>
300
292
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_tab_set_auto_save_interval    (<em class="parameter"><code><a class="link" href="gedit-gedit-tab.html#GeditTab"><span class="type">GeditTab</span></a> *tab</code></em>,
301
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> interval</code></em>);</pre>
 
293
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> interval</code></em>);</pre>
302
294
<p>
303
295
Sets the interval for the autosave feature. It does nothing if the
304
296
interval is the same as the one already present. It removes the old
326
318
<a name="gedit-gedit-tab.property-details"></a><h2>Property Details</h2>
327
319
<div class="refsect2" title='The "autosave" property'>
328
320
<a name="GeditTab--autosave"></a><h3>The <code class="literal">"autosave"</code> property</h3>
329
 
<pre class="programlisting">  "autosave"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 
321
<pre class="programlisting">  "autosave"                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
330
322
<p>Autosave feature.</p>
331
323
<p>Default value: TRUE</p>
332
324
</div>
333
325
<hr>
334
326
<div class="refsect2" title='The "autosave-interval" property'>
335
327
<a name="GeditTab--autosave-interval"></a><h3>The <code class="literal">"autosave-interval"</code> property</h3>
336
 
<pre class="programlisting">  "autosave-interval"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 
328
<pre class="programlisting">  "autosave-interval"        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
337
329
<p>Time between two autosaves.</p>
338
330
<p>Allowed values: &gt;= 0</p>
339
331
<p>Default value: 0</p>
341
333
<hr>
342
334
<div class="refsect2" title='The "name" property'>
343
335
<a name="GeditTab--name"></a><h3>The <code class="literal">"name"</code> property</h3>
344
 
<pre class="programlisting">  "name"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
 
336
<pre class="programlisting">  "name"                     <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
345
337
<p>The tab's name.</p>
346
338
<p>Default value: NULL</p>
347
339
</div>