← Back to branch summary

~ubuntu-branches/ubuntu/intrepid/gedit/intrepid-proposed

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2008-09-08 21:33:44 UTC
  • mfrom: (1.1.48 upstream)
  • Revision ID: james.westby@ubuntu.com-20080908213344-eiv4gvnuily7unti
Tags: 2.23.92-0ubuntu1
https://launchpad.net/bugs/236953
https://launchpad.net/bugs/262007
* New upstream version:
  - Bugfixes related to the gio port (lp: #236953, #262007)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/xml/gedit-tab.xml
11
11
<refnamediv>
12
12
<refname>GeditTab</refname>
13
13
<refpurpose></refpurpose>
14
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
15
14
</refnamediv>
16
15
 
17
16
<refsynopsisdiv id="GeditTab.synopsis" role="synopsis">
21
20
enum                <link linkend="GeditTabState">GeditTabState</link>;
22
21
                    <link linkend="GeditTabPrivate">GeditTabPrivate</link>;
23
22
                    <link linkend="GeditTab-struct">GeditTab</link>;
24
 
<link linkend="GeditView">GeditView</link>*          <link linkend="gedit-tab-get-view">gedit_tab_get_view</link>                  (<link linkend="GeditTab">GeditTab</link> *tab);
25
 
<link linkend="GeditDocument">GeditDocument</link>*      <link linkend="gedit-tab-get-document">gedit_tab_get_document</link>              (<link linkend="GeditTab">GeditTab</link> *tab);
26
 
<link linkend="GeditTab">GeditTab</link>*           <link linkend="gedit-tab-get-from-document">gedit_tab_get_from_document</link>         (<link linkend="GeditDocument">GeditDocument</link> *doc);
 
23
<link linkend="GeditView">GeditView</link> *         <link linkend="gedit-tab-get-view">gedit_tab_get_view</link>                  (<link linkend="GeditTab">GeditTab</link> *tab);
 
24
<link linkend="GeditDocument">GeditDocument</link> *     <link linkend="gedit-tab-get-document">gedit_tab_get_document</link>              (<link linkend="GeditTab">GeditTab</link> *tab);
 
25
<link linkend="GeditTab">GeditTab</link> *          <link linkend="gedit-tab-get-from-document">gedit_tab_get_from_document</link>         (<link linkend="GeditDocument">GeditDocument</link> *doc);
27
26
<link linkend="GeditTabState">GeditTabState</link>       <link linkend="gedit-tab-get-state">gedit_tab_get_state</link>                 (<link linkend="GeditTab">GeditTab</link> *tab);
28
27
<link linkend="gboolean">gboolean</link>            <link linkend="gedit-tab-get-auto-save-enabled">gedit_tab_get_auto_save_enabled</link>     (<link linkend="GeditTab">GeditTab</link> *tab);
29
28
<link linkend="void">void</link>                <link linkend="gedit-tab-set-auto-save-enabled">gedit_tab_set_auto_save_enabled</link>     (<link linkend="GeditTab">GeditTab</link> *tab,
46
45
                                 +----<link linkend="GtkVBox">GtkVBox</link>
47
46
                                       +----GeditTab
48
47
</synopsis>
49
 
 
50
48
</refsect1>
51
49
 
52
50
 
56
54
<para>
57
55
GeditTab implements
58
56
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>
59
 
 
60
57
</refsect1>
61
58
 
62
59
 
75
72
<refsect1 id="GeditTab.description" role="desc">
76
73
<title role="desc.title">Description</title>
77
74
<para>
78
 
 
79
75
</para>
80
76
</refsect1>
81
77
 
83
79
<title role="details.title">Details</title>
84
80
<refsect2 id="GeditTabState" role="enum">
85
81
<title>enum GeditTabState</title>
86
 
<indexterm zone="GeditTabState"><primary>GeditTabState</primary></indexterm><programlisting>typedef enum
 
82
<indexterm zone="GeditTabState"><primary sortas="GeditTabState">GeditTabState</primary></indexterm><programlisting>typedef enum
87
83
{
88
84
        GEDIT_TAB_STATE_NORMAL = 0,
89
85
        GEDIT_TAB_STATE_LOADING,
103
99
} GeditTabState;
104
100
</programlisting>
105
101
<para>
106
 
 
107
102
</para></refsect2>
108
103
<refsect2 id="GeditTabPrivate" role="struct">
109
104
<title>GeditTabPrivate</title>
110
 
<indexterm zone="GeditTabPrivate"><primary>GeditTabPrivate</primary></indexterm><programlisting>typedef struct _GeditTabPrivate GeditTabPrivate;</programlisting>
 
105
<indexterm zone="GeditTabPrivate"><primary sortas="GeditTabPrivate">GeditTabPrivate</primary></indexterm><programlisting>typedef struct _GeditTabPrivate GeditTabPrivate;</programlisting>
111
106
<para>
112
 
 
113
107
</para></refsect2>
114
108
<refsect2 id="GeditTab-struct" role="struct">
115
109
<title>GeditTab</title>
116
 
<indexterm zone="GeditTab-struct"><primary>GeditTab</primary></indexterm><programlisting>typedef struct _GeditTab GeditTab;</programlisting>
 
110
<indexterm zone="GeditTab-struct"><primary sortas="GeditTab">GeditTab</primary></indexterm><programlisting>typedef struct _GeditTab GeditTab;</programlisting>
117
111
<para>
118
 
 
119
112
</para></refsect2>
120
113
<refsect2 id="gedit-tab-get-view" role="function">
121
114
<title>gedit_tab_get_view ()</title>
122
 
<indexterm zone="gedit-tab-get-view"><primary>gedit_tab_get_view</primary></indexterm><programlisting><link linkend="GeditView">GeditView</link>*          gedit_tab_get_view                  (<link linkend="GeditTab">GeditTab</link> *tab);</programlisting>
 
115
<indexterm zone="gedit-tab-get-view"><primary sortas="gedit_tab_get_view">gedit_tab_get_view</primary></indexterm><programlisting><link linkend="GeditView">GeditView</link> *         gedit_tab_get_view                  (<link linkend="GeditTab">GeditTab</link> *tab);</programlisting>
123
116
<para>
124
 
 
125
117
</para><variablelist role="params">
126
 
<varlistentry><term><parameter>tab</parameter>&nbsp;:</term>
 
118
<varlistentry><term><parameter>tab</parameter>&#160;:</term>
127
119
<listitem><simpara>
128
120
</simpara></listitem></varlistentry>
129
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
130
 
 
131
 
 
 
121
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
132
122
</simpara></listitem></varlistentry>
133
123
</variablelist></refsect2>
134
124
<refsect2 id="gedit-tab-get-document" role="function">
135
125
<title>gedit_tab_get_document ()</title>
136
 
<indexterm zone="gedit-tab-get-document"><primary>gedit_tab_get_document</primary></indexterm><programlisting><link linkend="GeditDocument">GeditDocument</link>*      gedit_tab_get_document              (<link linkend="GeditTab">GeditTab</link> *tab);</programlisting>
 
126
<indexterm zone="gedit-tab-get-document"><primary sortas="gedit_tab_get_document">gedit_tab_get_document</primary></indexterm><programlisting><link linkend="GeditDocument">GeditDocument</link> *     gedit_tab_get_document              (<link linkend="GeditTab">GeditTab</link> *tab);</programlisting>
137
127
<para>
138
 
 
139
128
</para><variablelist role="params">
140
 
<varlistentry><term><parameter>tab</parameter>&nbsp;:</term>
 
129
<varlistentry><term><parameter>tab</parameter>&#160;:</term>
141
130
<listitem><simpara>
142
131
</simpara></listitem></varlistentry>
143
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
144
 
 
145
 
 
 
132
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
146
133
</simpara></listitem></varlistentry>
147
134
</variablelist></refsect2>
148
135
<refsect2 id="gedit-tab-get-from-document" role="function">
149
136
<title>gedit_tab_get_from_document ()</title>
150
 
<indexterm zone="gedit-tab-get-from-document"><primary>gedit_tab_get_from_document</primary></indexterm><programlisting><link linkend="GeditTab">GeditTab</link>*           gedit_tab_get_from_document         (<link linkend="GeditDocument">GeditDocument</link> *doc);</programlisting>
 
137
<indexterm zone="gedit-tab-get-from-document"><primary sortas="gedit_tab_get_from_document">gedit_tab_get_from_document</primary></indexterm><programlisting><link linkend="GeditTab">GeditTab</link> *          gedit_tab_get_from_document         (<link linkend="GeditDocument">GeditDocument</link> *doc);</programlisting>
151
138
<para>
152
 
 
153
139
</para><variablelist role="params">
154
 
<varlistentry><term><parameter>doc</parameter>&nbsp;:</term>
 
140
<varlistentry><term><parameter>doc</parameter>&#160;:</term>
155
141
<listitem><simpara>
156
142
</simpara></listitem></varlistentry>
157
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
158
 
 
159
 
 
 
143
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
160
144
</simpara></listitem></varlistentry>
161
145
</variablelist></refsect2>
162
146
<refsect2 id="gedit-tab-get-state" role="function">
163
147
<title>gedit_tab_get_state ()</title>
164
 
<indexterm zone="gedit-tab-get-state"><primary>gedit_tab_get_state</primary></indexterm><programlisting><link linkend="GeditTabState">GeditTabState</link>       gedit_tab_get_state                 (<link linkend="GeditTab">GeditTab</link> *tab);</programlisting>
 
148
<indexterm zone="gedit-tab-get-state"><primary sortas="gedit_tab_get_state">gedit_tab_get_state</primary></indexterm><programlisting><link linkend="GeditTabState">GeditTabState</link>       gedit_tab_get_state                 (<link linkend="GeditTab">GeditTab</link> *tab);</programlisting>
165
149
<para>
166
 
 
167
150
</para><variablelist role="params">
168
 
<varlistentry><term><parameter>tab</parameter>&nbsp;:</term>
 
151
<varlistentry><term><parameter>tab</parameter>&#160;:</term>
169
152
<listitem><simpara>
170
153
</simpara></listitem></varlistentry>
171
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
172
 
 
173
 
 
 
154
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
174
155
</simpara></listitem></varlistentry>
175
156
</variablelist></refsect2>
176
157
<refsect2 id="gedit-tab-get-auto-save-enabled" role="function">
177
158
<title>gedit_tab_get_auto_save_enabled ()</title>
178
 
<indexterm zone="gedit-tab-get-auto-save-enabled"><primary>gedit_tab_get_auto_save_enabled</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gedit_tab_get_auto_save_enabled     (<link linkend="GeditTab">GeditTab</link> *tab);</programlisting>
 
159
<indexterm zone="gedit-tab-get-auto-save-enabled"><primary sortas="gedit_tab_get_auto_save_enabled">gedit_tab_get_auto_save_enabled</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gedit_tab_get_auto_save_enabled     (<link linkend="GeditTab">GeditTab</link> *tab);</programlisting>
179
160
<para>
180
161
Gets the current state for the autosave feature</para>
181
162
<para>
182
 
 
183
163
</para><variablelist role="params">
184
 
<varlistentry><term><parameter>tab</parameter>&nbsp;:</term>
 
164
<varlistentry><term><parameter>tab</parameter>&#160;:</term>
185
165
<listitem><simpara> 
186
166
</simpara></listitem></varlistentry>
187
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if the autosave is enabled, else FALSE
 
167
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the autosave is enabled, else FALSE
188
168
</simpara></listitem></varlistentry>
189
169
</variablelist></refsect2>
190
170
<refsect2 id="gedit-tab-set-auto-save-enabled" role="function">
191
171
<title>gedit_tab_set_auto_save_enabled ()</title>
192
 
<indexterm zone="gedit-tab-set-auto-save-enabled"><primary>gedit_tab_set_auto_save_enabled</primary></indexterm><programlisting><link linkend="void">void</link>                gedit_tab_set_auto_save_enabled     (<link linkend="GeditTab">GeditTab</link> *tab,
 
172
<indexterm zone="gedit-tab-set-auto-save-enabled"><primary sortas="gedit_tab_set_auto_save_enabled">gedit_tab_set_auto_save_enabled</primary></indexterm><programlisting><link linkend="void">void</link>                gedit_tab_set_auto_save_enabled     (<link linkend="GeditTab">GeditTab</link> *tab,
193
173
                                                         <link linkend="gboolean">gboolean</link> enable);</programlisting>
194
174
<para>
195
175
Enables or disables the autosave feature. It does not install an
196
176
autosave timeout if the document is new or is read-only</para>
197
177
<para>
198
 
 
199
178
</para><variablelist role="params">
200
 
<varlistentry><term><parameter>tab</parameter>&nbsp;:</term>
 
179
<varlistentry><term><parameter>tab</parameter>&#160;:</term>
201
180
<listitem><simpara> a <link linkend="GeditTab"><type>GeditTab</type></link>
202
181
</simpara></listitem></varlistentry>
203
 
<varlistentry><term><parameter>enable</parameter>&nbsp;:</term>
 
182
<varlistentry><term><parameter>enable</parameter>&#160;:</term>
204
183
<listitem><simpara> enable (TRUE) or disable (FALSE) auto save
205
184
</simpara></listitem></varlistentry>
206
185
</variablelist></refsect2>
207
186
<refsect2 id="gedit-tab-get-auto-save-interval" role="function">
208
187
<title>gedit_tab_get_auto_save_interval ()</title>
209
 
<indexterm zone="gedit-tab-get-auto-save-interval"><primary>gedit_tab_get_auto_save_interval</primary></indexterm><programlisting><link linkend="gint">gint</link>                gedit_tab_get_auto_save_interval    (<link linkend="GeditTab">GeditTab</link> *tab);</programlisting>
 
188
<indexterm zone="gedit-tab-get-auto-save-interval"><primary sortas="gedit_tab_get_auto_save_interval">gedit_tab_get_auto_save_interval</primary></indexterm><programlisting><link linkend="gint">gint</link>                gedit_tab_get_auto_save_interval    (<link linkend="GeditTab">GeditTab</link> *tab);</programlisting>
210
189
<para>
211
190
Gets the current interval for the autosaves</para>
212
191
<para>
213
 
 
214
192
</para><variablelist role="params">
215
 
<varlistentry><term><parameter>tab</parameter>&nbsp;:</term>
 
193
<varlistentry><term><parameter>tab</parameter>&#160;:</term>
216
194
<listitem><simpara> 
217
195
</simpara></listitem></varlistentry>
218
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the value of the autosave
 
196
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the value of the autosave
219
197
</simpara></listitem></varlistentry>
220
198
</variablelist></refsect2>
221
199
<refsect2 id="gedit-tab-set-auto-save-interval" role="function">
222
200
<title>gedit_tab_set_auto_save_interval ()</title>
223
 
<indexterm zone="gedit-tab-set-auto-save-interval"><primary>gedit_tab_set_auto_save_interval</primary></indexterm><programlisting><link linkend="void">void</link>                gedit_tab_set_auto_save_interval    (<link linkend="GeditTab">GeditTab</link> *tab,
 
201
<indexterm zone="gedit-tab-set-auto-save-interval"><primary sortas="gedit_tab_set_auto_save_interval">gedit_tab_set_auto_save_interval</primary></indexterm><programlisting><link linkend="void">void</link>                gedit_tab_set_auto_save_interval    (<link linkend="GeditTab">GeditTab</link> *tab,
224
202
                                                         <link linkend="gint">gint</link> interval);</programlisting>
225
203
<para>
226
204
Sets the interval for the autosave feature. It does nothing if the
228
206
interval timeout and adds a new one with the autosave passed as
229
207
argument.</para>
230
208
<para>
231
 
 
232
209
</para><variablelist role="params">
233
 
<varlistentry><term><parameter>tab</parameter>&nbsp;:</term>
 
210
<varlistentry><term><parameter>tab</parameter>&#160;:</term>
234
211
<listitem><simpara> a <link linkend="GeditTab"><type>GeditTab</type></link>
235
212
</simpara></listitem></varlistentry>
236
 
<varlistentry><term><parameter>interval</parameter>&nbsp;:</term>
 
213
<varlistentry><term><parameter>interval</parameter>&#160;:</term>
237
214
<listitem><simpara> the new interval
238
215
</simpara></listitem></varlistentry>
239
216
</variablelist></refsect2>
242
219
<refsect1 id="GeditTab.property-details" role="property_details">
243
220
<title role="property_details.title">Property Details</title>
244
221
<refsect2 id="GeditTab--autosave"><title>The <literal>&quot;autosave&quot;</literal> property</title>
245
 
<indexterm zone="GeditTab--autosave"><primary>GeditTab:autosave</primary></indexterm><programlisting>  &quot;autosave&quot;                 <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
 
222
<indexterm zone="GeditTab--autosave"><primary sortas="GeditTab:autosave">GeditTab:autosave</primary></indexterm><programlisting>  &quot;autosave&quot;                 <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
246
223
<para>Autosave feature.</para><para>Default value: TRUE</para>
247
224
</refsect2>
248
225
<refsect2 id="GeditTab--autosave-interval"><title>The <literal>&quot;autosave-interval&quot;</literal> property</title>
249
 
<indexterm zone="GeditTab--autosave-interval"><primary>GeditTab:autosave-interval</primary></indexterm><programlisting>  &quot;autosave-interval&quot;        <link linkend="gint">gint</link>                  : Read / Write</programlisting>
 
226
<indexterm zone="GeditTab--autosave-interval"><primary sortas="GeditTab:autosave-interval">GeditTab:autosave-interval</primary></indexterm><programlisting>  &quot;autosave-interval&quot;        <link linkend="gint">gint</link>                  : Read / Write</programlisting>
250
227
<para>Time between two autosaves.</para><para>Allowed values: &gt;= 0</para>
251
228
<para>Default value: 0</para>
252
229
</refsect2>
253
230
<refsect2 id="GeditTab--name"><title>The <literal>&quot;name&quot;</literal> property</title>
254
 
<indexterm zone="GeditTab--name"><primary>GeditTab:name</primary></indexterm><programlisting>  &quot;name&quot;                     <link linkend="gchar">gchar</link>*                : Read</programlisting>
 
231
<indexterm zone="GeditTab--name"><primary sortas="GeditTab:name">GeditTab:name</primary></indexterm><programlisting>  &quot;name&quot;                     <link linkend="gchar">gchar</link>*                : Read</programlisting>
255
232
<para>The tab's name.</para><para>Default value: NULL</para>
256
233
</refsect2>
257
234
<refsect2 id="GeditTab--state"><title>The <literal>&quot;state&quot;</literal> property</title>
258
 
<indexterm zone="GeditTab--state"><primary>GeditTab:state</primary></indexterm><programlisting>  &quot;state&quot;                    <link linkend="GeditTabState">GeditTabState</link>         : Read</programlisting>
 
235
<indexterm zone="GeditTab--state"><primary sortas="GeditTab:state">GeditTab:state</primary></indexterm><programlisting>  &quot;state&quot;                    <link linkend="GeditTabState">GeditTabState</link>         : Read</programlisting>
259
236
<para>The tab's state.</para><para>Default value: GEDIT_TAB_STATE_NORMAL</para>
260
237
</refsect2>
261
 
 
262
238
</refsect1>
263
239
 
264
240