« back to all changes in this revision
Viewing changes to docs/reference/xml/gedit-document.xml
- browse files at revision 95
- compare with another revision
- download diff
- download tarball
- view history from revision 95
- 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
* New upstream version:
- Misc bugfixes (lp: #421221)
- Misc bugfixes (lp: #421221)
- files added:
- docs/reference/html/GeditMessageArea.html
- docs/reference/xml
- files removed:
- docs/reference/tmpl/gedit-enum-types.sgml
- files modified:
- ChangeLog
added
removed
docs/reference/xml/gedit-document.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="GeditDocument">
5
<refmeta>
6
<refentrytitle role="top_of_page" id="GeditDocument.top_of_page">GeditDocument</refentrytitle>
7
<manvolnum>3</manvolnum>
8
<refmiscinfo>GEDIT Library</refmiscinfo>
9
</refmeta>
10
11
<refnamediv>
12
<refname>GeditDocument</refname>
13
<refpurpose></refpurpose>
14
</refnamediv>
15
16
<refsynopsisdiv id="GeditDocument.synopsis" role="synopsis">
17
<title role="synopsis.title">Synopsis</title>
18
19
<synopsis>
20
enum <link linkend="GeditSearchFlags">GeditSearchFlags</link>;
21
<link linkend="GeditDocumentPrivate">GeditDocumentPrivate</link>;
22
<link linkend="GeditDocument-struct">GeditDocument</link>;
23
enum <link linkend="GeditDocumentSaveFlags">GeditDocumentSaveFlags</link>;
24
#define <link linkend="GEDIT-DOCUMENT-ERROR--CAPS">GEDIT_DOCUMENT_ERROR</link>
25
<link linkend="GQuark">GQuark</link> <link linkend="gedit-document-error-quark">gedit_document_error_quark</link> (void);
26
<link linkend="GeditDocument">GeditDocument</link> * <link linkend="gedit-document-new">gedit_document_new</link> (void);
27
<link linkend="gchar">gchar</link> * <link linkend="gedit-document-get-uri">gedit_document_get_uri</link> (<link linkend="GeditDocument">GeditDocument</link> *doc);
28
<link linkend="gchar">gchar</link> * <link linkend="gedit-document-get-uri-for-display">gedit_document_get_uri_for_display</link> (<link linkend="GeditDocument">GeditDocument</link> *doc);
29
<link linkend="gchar">gchar</link> * <link linkend="gedit-document-get-short-name-for-display">gedit_document_get_short_name_for_display</link>
30
(<link linkend="GeditDocument">GeditDocument</link> *doc);
31
<link linkend="gchar">gchar</link> * <link linkend="gedit-document-get-mime-type">gedit_document_get_mime_type</link> (<link linkend="GeditDocument">GeditDocument</link> *doc);
32
<link linkend="gboolean">gboolean</link> <link linkend="gedit-document-get-readonly">gedit_document_get_readonly</link> (<link linkend="GeditDocument">GeditDocument</link> *doc);
33
<link linkend="void">void</link> <link linkend="gedit-document-load">gedit_document_load</link> (<link linkend="GeditDocument">GeditDocument</link> *doc,
34
const <link linkend="gchar">gchar</link> *uri,
35
const <link linkend="GeditEncoding">GeditEncoding</link> *encoding,
36
<link linkend="gint">gint</link> line_pos,
37
<link linkend="gboolean">gboolean</link> create);
38
<link linkend="gboolean">gboolean</link> <link linkend="gedit-document-insert-file">gedit_document_insert_file</link> (<link linkend="GeditDocument">GeditDocument</link> *doc,
39
<link linkend="GtkTextIter">GtkTextIter</link> *iter,
40
const <link linkend="gchar">gchar</link> *uri,
41
const <link linkend="GeditEncoding">GeditEncoding</link> *encoding);
42
<link linkend="gboolean">gboolean</link> <link linkend="gedit-document-load-cancel">gedit_document_load_cancel</link> (<link linkend="GeditDocument">GeditDocument</link> *doc);
43
<link linkend="void">void</link> <link linkend="gedit-document-save">gedit_document_save</link> (<link linkend="GeditDocument">GeditDocument</link> *doc,
44
<link linkend="GeditDocumentSaveFlags">GeditDocumentSaveFlags</link> flags);
45
<link linkend="void">void</link> <link linkend="gedit-document-save-as">gedit_document_save_as</link> (<link linkend="GeditDocument">GeditDocument</link> *doc,
46
const <link linkend="gchar">gchar</link> *uri,
47
const <link linkend="GeditEncoding">GeditEncoding</link> *encoding,
48
<link linkend="GeditDocumentSaveFlags">GeditDocumentSaveFlags</link> flags);
49
<link linkend="gboolean">gboolean</link> <link linkend="gedit-document-is-untouched">gedit_document_is_untouched</link> (<link linkend="GeditDocument">GeditDocument</link> *doc);
50
<link linkend="gboolean">gboolean</link> <link linkend="gedit-document-is-untitled">gedit_document_is_untitled</link> (<link linkend="GeditDocument">GeditDocument</link> *doc);
51
<link linkend="gboolean">gboolean</link> <link linkend="gedit-document-get-deleted">gedit_document_get_deleted</link> (<link linkend="GeditDocument">GeditDocument</link> *doc);
52
<link linkend="gboolean">gboolean</link> <link linkend="gedit-document-goto-line">gedit_document_goto_line</link> (<link linkend="GeditDocument">GeditDocument</link> *doc,
53
<link linkend="gint">gint</link> line);
54
<link linkend="void">void</link> <link linkend="gedit-document-set-search-text">gedit_document_set_search_text</link> (<link linkend="GeditDocument">GeditDocument</link> *doc,
55
const <link linkend="gchar">gchar</link> *text,
56
<link linkend="guint">guint</link> flags);
57
<link linkend="gchar">gchar</link> * <link linkend="gedit-document-get-search-text">gedit_document_get_search_text</link> (<link linkend="GeditDocument">GeditDocument</link> *doc,
58
<link linkend="guint">guint</link> *flags);
59
<link linkend="gboolean">gboolean</link> <link linkend="gedit-document-get-can-search-again">gedit_document_get_can_search_again</link> (<link linkend="GeditDocument">GeditDocument</link> *doc);
60
<link linkend="gboolean">gboolean</link> <link linkend="gedit-document-search-forward">gedit_document_search_forward</link> (<link linkend="GeditDocument">GeditDocument</link> *doc,
61
const <link linkend="GtkTextIter">GtkTextIter</link> *start,
62
const <link linkend="GtkTextIter">GtkTextIter</link> *end,
63
<link linkend="GtkTextIter">GtkTextIter</link> *match_start,
64
<link linkend="GtkTextIter">GtkTextIter</link> *match_end);
65
<link linkend="gboolean">gboolean</link> <link linkend="gedit-document-search-backward">gedit_document_search_backward</link> (<link linkend="GeditDocument">GeditDocument</link> *doc,
66
const <link linkend="GtkTextIter">GtkTextIter</link> *start,
67
const <link linkend="GtkTextIter">GtkTextIter</link> *end,
68
<link linkend="GtkTextIter">GtkTextIter</link> *match_start,
69
<link linkend="GtkTextIter">GtkTextIter</link> *match_end);
70
<link linkend="gint">gint</link> <link linkend="gedit-document-replace-all">gedit_document_replace_all</link> (<link linkend="GeditDocument">GeditDocument</link> *doc,
71
const <link linkend="gchar">gchar</link> *find,
72
const <link linkend="gchar">gchar</link> *replace,
73
<link linkend="guint">guint</link> flags);
74
<link linkend="void">void</link> <link linkend="gedit-document-set-language">gedit_document_set_language</link> (<link linkend="GeditDocument">GeditDocument</link> *doc,
75
<link linkend="GtkSourceLanguage">GtkSourceLanguage</link> *lang);
76
<link linkend="void">void</link> <link linkend="gedit-document-set-enable-search-highlighting">gedit_document_set_enable_search_highlighting</link>
77
(<link linkend="GeditDocument">GeditDocument</link> *doc,
78
<link linkend="gboolean">gboolean</link> enable);
79
<link linkend="gboolean">gboolean</link> <link linkend="gedit-document-get-enable-search-highlighting">gedit_document_get_enable_search_highlighting</link>
80
(<link linkend="GeditDocument">GeditDocument</link> *doc);
81
#define <link linkend="GEDIT-SEARCH-IS-DONT-SET-FLAGS--CAPS">GEDIT_SEARCH_IS_DONT_SET_FLAGS</link> (sflags)
82
#define <link linkend="GEDIT-SEARCH-SET-DONT-SET-FLAGS--CAPS">GEDIT_SEARCH_SET_DONT_SET_FLAGS</link> (sflags,state)
83
#define <link linkend="GEDIT-SEARCH-IS-ENTIRE-WORD--CAPS">GEDIT_SEARCH_IS_ENTIRE_WORD</link> (sflags)
84
#define <link linkend="GEDIT-SEARCH-SET-ENTIRE-WORD--CAPS">GEDIT_SEARCH_SET_ENTIRE_WORD</link> (sflags,state)
85
#define <link linkend="GEDIT-SEARCH-IS-CASE-SENSITIVE--CAPS">GEDIT_SEARCH_IS_CASE_SENSITIVE</link> (sflags)
86
#define <link linkend="GEDIT-SEARCH-SET-CASE-SENSITIVE--CAPS">GEDIT_SEARCH_SET_CASE_SENSITIVE</link> (sflags,state)
87
</synopsis>
88
</refsynopsisdiv>
89
90
<refsect1 id="GeditDocument.object-hierarchy" role="object_hierarchy">
91
<title role="object_hierarchy.title">Object Hierarchy</title>
92
<synopsis>
93
<link linkend="GObject">GObject</link>
94
+----<link linkend="GtkTextBuffer">GtkTextBuffer</link>
95
+----<link linkend="GtkSourceBuffer">GtkSourceBuffer</link>
96
+----GeditDocument
97
</synopsis>
98
</refsect1>
99
100
101
102
103
104
<refsect1 id="GeditDocument.properties" role="properties">
105
<title role="properties.title">Properties</title>
106
<synopsis>
107
"<link linkend="GeditDocument--can-search-again">can-search-again</link>" <link linkend="gboolean">gboolean</link> : Read
108
"<link linkend="GeditDocument--content-type">content-type</link>" <link linkend="gchar">gchar</link>* : Read
109
"<link linkend="GeditDocument--enable-search-highlighting">enable-search-highlighting</link>" <link linkend="gboolean">gboolean</link> : Read / Write
110
"<link linkend="GeditDocument--encoding">encoding</link>" <link linkend="GeditEncoding">GeditEncoding</link>* : Read
111
"<link linkend="GeditDocument--mime-type">mime-type</link>" <link linkend="gchar">gchar</link>* : Read
112
"<link linkend="GeditDocument--read-only">read-only</link>" <link linkend="gboolean">gboolean</link> : Read
113
"<link linkend="GeditDocument--shortname">shortname</link>" <link linkend="gchar">gchar</link>* : Read
114
"<link linkend="GeditDocument--uri">uri</link>" <link linkend="gchar">gchar</link>* : Read
115
</synopsis>
116
</refsect1>
117
118
<refsect1 id="GeditDocument.signals" role="signal_proto">
119
<title role="signal_proto.title">Signals</title>
120
<synopsis>
121
"<link linkend="GeditDocument-cursor-moved">cursor-moved</link>" : Run Last
122
"<link linkend="GeditDocument-load">load</link>" : Run Last
123
"<link linkend="GeditDocument-loaded">loaded</link>" : Run Last
124
"<link linkend="GeditDocument-loading">loading</link>" : Run Last
125
"<link linkend="GeditDocument-save">save</link>" : Run Last
126
"<link linkend="GeditDocument-saved">saved</link>" : Run Last
127
"<link linkend="GeditDocument-saving">saving</link>" : Run Last
128
"<link linkend="GeditDocument-search-highlight-updated">search-highlight-updated</link>" : Run Last
129
</synopsis>
130
</refsect1>
131
132
133
<refsect1 id="GeditDocument.description" role="desc">
134
<title role="desc.title">Description</title>
135
<para>
136
</para>
137
</refsect1>
138
139
<refsect1 id="GeditDocument.details" role="details">
140
<title role="details.title">Details</title>
141
<refsect2 id="GeditSearchFlags" role="enum">
142
<title>enum GeditSearchFlags</title>
143
<indexterm zone="GeditSearchFlags"><primary sortas="GeditSearchFlags">GeditSearchFlags</primary></indexterm><programlisting>typedef enum
144
{
145
GEDIT_SEARCH_DONT_SET_FLAGS = 1 << 0,
146
GEDIT_SEARCH_ENTIRE_WORD = 1 << 1,
147
GEDIT_SEARCH_CASE_SENSITIVE = 1 << 2
148
149
} GeditSearchFlags;
150
</programlisting>
151
<para>
152
</para></refsect2>
153
<refsect2 id="GeditDocumentPrivate" role="struct">
154
<title>GeditDocumentPrivate</title>
155
<indexterm zone="GeditDocumentPrivate"><primary sortas="GeditDocumentPrivate">GeditDocumentPrivate</primary></indexterm><programlisting>typedef struct _GeditDocumentPrivate GeditDocumentPrivate;</programlisting>
156
<para>
157
</para></refsect2>
158
<refsect2 id="GeditDocument-struct" role="struct">
159
<title>GeditDocument</title>
160
<indexterm zone="GeditDocument-struct"><primary sortas="GeditDocument">GeditDocument</primary></indexterm><programlisting>typedef struct _GeditDocument GeditDocument;</programlisting>
161
<para>
162
</para></refsect2>
163
<refsect2 id="GeditDocumentSaveFlags" role="enum">
164
<title>enum GeditDocumentSaveFlags</title>
165
<indexterm zone="GeditDocumentSaveFlags"><primary sortas="GeditDocumentSaveFlags">GeditDocumentSaveFlags</primary></indexterm><programlisting>typedef enum
166
{
167
GEDIT_DOCUMENT_SAVE_IGNORE_MTIME = 1 << 0,
168
GEDIT_DOCUMENT_SAVE_IGNORE_BACKUP = 1 << 1,
169
GEDIT_DOCUMENT_SAVE_PRESERVE_BACKUP = 1 << 2
170
} GeditDocumentSaveFlags;
171
</programlisting>
172
<para>
173
</para>
174
<para>
175
</para><variablelist role="enum">
176
<varlistentry id="GEDIT-DOCUMENT-SAVE-IGNORE-MTIME--CAPS" role="constant">
177
<term><literal>GEDIT_DOCUMENT_SAVE_IGNORE_MTIME</literal></term>
178
<listitem><simpara> save file despite external modifications.
179
</simpara></listitem>
180
</varlistentry>
181
<varlistentry id="GEDIT-DOCUMENT-SAVE-IGNORE-BACKUP--CAPS" role="constant">
182
<term><literal>GEDIT_DOCUMENT_SAVE_IGNORE_BACKUP</literal></term>
183
<listitem><simpara> write the file directly without attempting to backup.
184
</simpara></listitem>
185
</varlistentry>
186
<varlistentry id="GEDIT-DOCUMENT-SAVE-PRESERVE-BACKUP--CAPS" role="constant">
187
<term><literal>GEDIT_DOCUMENT_SAVE_PRESERVE_BACKUP</literal></term>
188
<listitem><simpara> preserve previous backup file, needed to support autosaving.
189
</simpara></listitem>
190
</varlistentry>
191
</variablelist></refsect2>
192
<refsect2 id="GEDIT-DOCUMENT-ERROR--CAPS" role="macro">
193
<title>GEDIT_DOCUMENT_ERROR</title>
194
<indexterm zone="GEDIT-DOCUMENT-ERROR--CAPS"><primary sortas="GEDIT_DOCUMENT_ERROR">GEDIT_DOCUMENT_ERROR</primary></indexterm><programlisting>#define GEDIT_DOCUMENT_ERROR gedit_document_error_quark ()
195
</programlisting>
196
<para>
197
</para></refsect2>
198
<refsect2 id="gedit-document-error-quark" role="function">
199
<title>gedit_document_error_quark ()</title>
200
<indexterm zone="gedit-document-error-quark"><primary sortas="gedit_document_error_quark">gedit_document_error_quark</primary></indexterm><programlisting><link linkend="GQuark">GQuark</link> gedit_document_error_quark (void);</programlisting>
201
<para>
202
</para><variablelist role="params">
203
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
204
</simpara></listitem></varlistentry>
205
</variablelist></refsect2>
206
<refsect2 id="gedit-document-new" role="function">
207
<title>gedit_document_new ()</title>
208
<indexterm zone="gedit-document-new"><primary sortas="gedit_document_new">gedit_document_new</primary></indexterm><programlisting><link linkend="GeditDocument">GeditDocument</link> * gedit_document_new (void);</programlisting>
209
<para>
210
</para><variablelist role="params">
211
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
212
</simpara></listitem></varlistentry>
213
</variablelist></refsect2>
214
<refsect2 id="gedit-document-get-uri" role="function">
215
<title>gedit_document_get_uri ()</title>
216
<indexterm zone="gedit-document-get-uri"><primary sortas="gedit_document_get_uri">gedit_document_get_uri</primary></indexterm><programlisting><link linkend="gchar">gchar</link> * gedit_document_get_uri (<link linkend="GeditDocument">GeditDocument</link> *doc);</programlisting>
217
<para>
218
</para><variablelist role="params">
219
<varlistentry><term><parameter>doc</parameter> :</term>
220
<listitem><simpara>
221
</simpara></listitem></varlistentry>
222
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
223
</simpara></listitem></varlistentry>
224
</variablelist></refsect2>
225
<refsect2 id="gedit-document-get-uri-for-display" role="function">
226
<title>gedit_document_get_uri_for_display ()</title>
227
<indexterm zone="gedit-document-get-uri-for-display"><primary sortas="gedit_document_get_uri_for_display">gedit_document_get_uri_for_display</primary></indexterm><programlisting><link linkend="gchar">gchar</link> * gedit_document_get_uri_for_display (<link linkend="GeditDocument">GeditDocument</link> *doc);</programlisting>
228
<para>
229
</para><variablelist role="params">
230
<varlistentry><term><parameter>doc</parameter> :</term>
231
<listitem><simpara>
232
</simpara></listitem></varlistentry>
233
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
234
</simpara></listitem></varlistentry>
235
</variablelist></refsect2>
236
<refsect2 id="gedit-document-get-short-name-for-display" role="function">
237
<title>gedit_document_get_short_name_for_display ()</title>
238
<indexterm zone="gedit-document-get-short-name-for-display"><primary sortas="gedit_document_get_short_name_for_display">gedit_document_get_short_name_for_display</primary></indexterm><programlisting><link linkend="gchar">gchar</link> * gedit_document_get_short_name_for_display
239
(<link linkend="GeditDocument">GeditDocument</link> *doc);</programlisting>
240
<para>
241
</para><variablelist role="params">
242
<varlistentry><term><parameter>doc</parameter> :</term>
243
<listitem><simpara>
244
</simpara></listitem></varlistentry>
245
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
246
</simpara></listitem></varlistentry>
247
</variablelist></refsect2>
248
<refsect2 id="gedit-document-get-mime-type" role="function">
249
<title>gedit_document_get_mime_type ()</title>
250
<indexterm zone="gedit-document-get-mime-type"><primary sortas="gedit_document_get_mime_type">gedit_document_get_mime_type</primary></indexterm><programlisting><link linkend="gchar">gchar</link> * gedit_document_get_mime_type (<link linkend="GeditDocument">GeditDocument</link> *doc);</programlisting>
251
<para>
252
</para><variablelist role="params">
253
<varlistentry><term><parameter>doc</parameter> :</term>
254
<listitem><simpara>
255
</simpara></listitem></varlistentry>
256
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
257
</simpara></listitem></varlistentry>
258
</variablelist></refsect2>
259
<refsect2 id="gedit-document-get-readonly" role="function">
260
<title>gedit_document_get_readonly ()</title>
261
<indexterm zone="gedit-document-get-readonly"><primary sortas="gedit_document_get_readonly">gedit_document_get_readonly</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gedit_document_get_readonly (<link linkend="GeditDocument">GeditDocument</link> *doc);</programlisting>
262
<para>
263
</para><variablelist role="params">
264
<varlistentry><term><parameter>doc</parameter> :</term>
265
<listitem><simpara>
266
</simpara></listitem></varlistentry>
267
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
268
</simpara></listitem></varlistentry>
269
</variablelist></refsect2>
270
<refsect2 id="gedit-document-load" role="function">
271
<title>gedit_document_load ()</title>
272
<indexterm zone="gedit-document-load"><primary sortas="gedit_document_load">gedit_document_load</primary></indexterm><programlisting><link linkend="void">void</link> gedit_document_load (<link linkend="GeditDocument">GeditDocument</link> *doc,
273
const <link linkend="gchar">gchar</link> *uri,
274
const <link linkend="GeditEncoding">GeditEncoding</link> *encoding,
275
<link linkend="gint">gint</link> line_pos,
276
<link linkend="gboolean">gboolean</link> create);</programlisting>
277
<para>
278
Load a document. This results in the "load" signal to be emitted.</para>
279
<para>
280
</para><variablelist role="params">
281
<varlistentry><term><parameter>doc</parameter> :</term>
282
<listitem><simpara> the <link linkend="GeditDocument"><type>GeditDocument</type></link>.
283
</simpara></listitem></varlistentry>
284
<varlistentry><term><parameter>uri</parameter> :</term>
285
<listitem><simpara> the uri where to load the document from.
286
</simpara></listitem></varlistentry>
287
<varlistentry><term><parameter>encoding</parameter> :</term>
288
<listitem><simpara> the <link linkend="GeditEncoding"><type>GeditEncoding</type></link> to encode the document.
289
</simpara></listitem></varlistentry>
290
<varlistentry><term><parameter>line_pos</parameter> :</term>
291
<listitem><simpara> the line to show.
292
</simpara></listitem></varlistentry>
293
<varlistentry><term><parameter>create</parameter> :</term>
294
<listitem><simpara> whether the document should be created if it doesn't exist.
295
</simpara></listitem></varlistentry>
296
</variablelist></refsect2>
297
<refsect2 id="gedit-document-insert-file" role="function">
298
<title>gedit_document_insert_file ()</title>
299
<indexterm zone="gedit-document-insert-file"><primary sortas="gedit_document_insert_file">gedit_document_insert_file</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gedit_document_insert_file (<link linkend="GeditDocument">GeditDocument</link> *doc,
300
<link linkend="GtkTextIter">GtkTextIter</link> *iter,
301
const <link linkend="gchar">gchar</link> *uri,
302
const <link linkend="GeditEncoding">GeditEncoding</link> *encoding);</programlisting>
303
<para>
304
</para><variablelist role="params">
305
<varlistentry><term><parameter>doc</parameter> :</term>
306
<listitem><simpara>
307
</simpara></listitem></varlistentry>
308
<varlistentry><term><parameter>iter</parameter> :</term>
309
<listitem><simpara>
310
</simpara></listitem></varlistentry>
311
<varlistentry><term><parameter>uri</parameter> :</term>
312
<listitem><simpara>
313
</simpara></listitem></varlistentry>
314
<varlistentry><term><parameter>encoding</parameter> :</term>
315
<listitem><simpara>
316
</simpara></listitem></varlistentry>
317
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
318
</simpara></listitem></varlistentry>
319
</variablelist></refsect2>
320
<refsect2 id="gedit-document-load-cancel" role="function">
321
<title>gedit_document_load_cancel ()</title>
322
<indexterm zone="gedit-document-load-cancel"><primary sortas="gedit_document_load_cancel">gedit_document_load_cancel</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gedit_document_load_cancel (<link linkend="GeditDocument">GeditDocument</link> *doc);</programlisting>
323
<para>
324
Cancel load of a document.</para>
325
<para>
326
</para><variablelist role="params">
327
<varlistentry><term><parameter>doc</parameter> :</term>
328
<listitem><simpara> the <link linkend="GeditDocument"><type>GeditDocument</type></link>.
329
</simpara></listitem></varlistentry>
330
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
331
</simpara></listitem></varlistentry>
332
</variablelist></refsect2>
333
<refsect2 id="gedit-document-save" role="function">
334
<title>gedit_document_save ()</title>
335
<indexterm zone="gedit-document-save"><primary sortas="gedit_document_save">gedit_document_save</primary></indexterm><programlisting><link linkend="void">void</link> gedit_document_save (<link linkend="GeditDocument">GeditDocument</link> *doc,
336
<link linkend="GeditDocumentSaveFlags">GeditDocumentSaveFlags</link> flags);</programlisting>
337
<para>
338
Save the document to its previous location. This results in the "save"
339
signal to be emitted.</para>
340
<para>
341
</para><variablelist role="params">
342
<varlistentry><term><parameter>doc</parameter> :</term>
343
<listitem><simpara> the <link linkend="GeditDocument"><type>GeditDocument</type></link>.
344
</simpara></listitem></varlistentry>
345
<varlistentry><term><parameter>flags</parameter> :</term>
346
<listitem><simpara> optionnal <link linkend="GeditDocumentSaveFlags"><type>GeditDocumentSaveFlags</type></link>.
347
</simpara></listitem></varlistentry>
348
</variablelist></refsect2>
349
<refsect2 id="gedit-document-save-as" role="function">
350
<title>gedit_document_save_as ()</title>
351
<indexterm zone="gedit-document-save-as"><primary sortas="gedit_document_save_as">gedit_document_save_as</primary></indexterm><programlisting><link linkend="void">void</link> gedit_document_save_as (<link linkend="GeditDocument">GeditDocument</link> *doc,
352
const <link linkend="gchar">gchar</link> *uri,
353
const <link linkend="GeditEncoding">GeditEncoding</link> *encoding,
354
<link linkend="GeditDocumentSaveFlags">GeditDocumentSaveFlags</link> flags);</programlisting>
355
<para>
356
Save the document to a new location. This results in the "save" signal
357
to be emitted.</para>
358
<para>
359
</para><variablelist role="params">
360
<varlistentry><term><parameter>doc</parameter> :</term>
361
<listitem><simpara> the <link linkend="GeditDocument"><type>GeditDocument</type></link>.
362
</simpara></listitem></varlistentry>
363
<varlistentry><term><parameter>uri</parameter> :</term>
364
<listitem><simpara> the uri where to save the document.
365
</simpara></listitem></varlistentry>
366
<varlistentry><term><parameter>encoding</parameter> :</term>
367
<listitem><simpara> the <link linkend="GeditEncoding"><type>GeditEncoding</type></link> to encode the document.
368
</simpara></listitem></varlistentry>
369
<varlistentry><term><parameter>flags</parameter> :</term>
370
<listitem><simpara> optionnal <link linkend="GeditDocumentSaveFlags"><type>GeditDocumentSaveFlags</type></link>.
371
</simpara></listitem></varlistentry>
372
</variablelist></refsect2>
373
<refsect2 id="gedit-document-is-untouched" role="function">
374
<title>gedit_document_is_untouched ()</title>
375
<indexterm zone="gedit-document-is-untouched"><primary sortas="gedit_document_is_untouched">gedit_document_is_untouched</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gedit_document_is_untouched (<link linkend="GeditDocument">GeditDocument</link> *doc);</programlisting>
376
<para>
377
</para><variablelist role="params">
378
<varlistentry><term><parameter>doc</parameter> :</term>
379
<listitem><simpara>
380
</simpara></listitem></varlistentry>
381
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
382
</simpara></listitem></varlistentry>
383
</variablelist></refsect2>
384
<refsect2 id="gedit-document-is-untitled" role="function">
385
<title>gedit_document_is_untitled ()</title>
386
<indexterm zone="gedit-document-is-untitled"><primary sortas="gedit_document_is_untitled">gedit_document_is_untitled</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gedit_document_is_untitled (<link linkend="GeditDocument">GeditDocument</link> *doc);</programlisting>
387
<para>
388
</para><variablelist role="params">
389
<varlistentry><term><parameter>doc</parameter> :</term>
390
<listitem><simpara>
391
</simpara></listitem></varlistentry>
392
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
393
</simpara></listitem></varlistentry>
394
</variablelist></refsect2>
395
<refsect2 id="gedit-document-get-deleted" role="function">
396
<title>gedit_document_get_deleted ()</title>
397
<indexterm zone="gedit-document-get-deleted"><primary sortas="gedit_document_get_deleted">gedit_document_get_deleted</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gedit_document_get_deleted (<link linkend="GeditDocument">GeditDocument</link> *doc);</programlisting>
398
<para>
399
</para><variablelist role="params">
400
<varlistentry><term><parameter>doc</parameter> :</term>
401
<listitem><simpara>
402
</simpara></listitem></varlistentry>
403
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
404
</simpara></listitem></varlistentry>
405
</variablelist></refsect2>
406
<refsect2 id="gedit-document-goto-line" role="function">
407
<title>gedit_document_goto_line ()</title>
408
<indexterm zone="gedit-document-goto-line"><primary sortas="gedit_document_goto_line">gedit_document_goto_line</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gedit_document_goto_line (<link linkend="GeditDocument">GeditDocument</link> *doc,
409
<link linkend="gint">gint</link> line);</programlisting>
410
<para>
411
</para><variablelist role="params">
412
<varlistentry><term><parameter>doc</parameter> :</term>
413
<listitem><simpara>
414
</simpara></listitem></varlistentry>
415
<varlistentry><term><parameter>line</parameter> :</term>
416
<listitem><simpara>
417
</simpara></listitem></varlistentry>
418
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
419
</simpara></listitem></varlistentry>
420
</variablelist></refsect2>
421
<refsect2 id="gedit-document-set-search-text" role="function">
422
<title>gedit_document_set_search_text ()</title>
423
<indexterm zone="gedit-document-set-search-text"><primary sortas="gedit_document_set_search_text">gedit_document_set_search_text</primary></indexterm><programlisting><link linkend="void">void</link> gedit_document_set_search_text (<link linkend="GeditDocument">GeditDocument</link> *doc,
424
const <link linkend="gchar">gchar</link> *text,
425
<link linkend="guint">guint</link> flags);</programlisting>
426
<para>
427
</para><variablelist role="params">
428
<varlistentry><term><parameter>doc</parameter> :</term>
429
<listitem><simpara>
430
</simpara></listitem></varlistentry>
431
<varlistentry><term><parameter>text</parameter> :</term>
432
<listitem><simpara>
433
</simpara></listitem></varlistentry>
434
<varlistentry><term><parameter>flags</parameter> :</term>
435
<listitem><simpara>
436
</simpara></listitem></varlistentry>
437
</variablelist></refsect2>
438
<refsect2 id="gedit-document-get-search-text" role="function">
439
<title>gedit_document_get_search_text ()</title>
440
<indexterm zone="gedit-document-get-search-text"><primary sortas="gedit_document_get_search_text">gedit_document_get_search_text</primary></indexterm><programlisting><link linkend="gchar">gchar</link> * gedit_document_get_search_text (<link linkend="GeditDocument">GeditDocument</link> *doc,
441
<link linkend="guint">guint</link> *flags);</programlisting>
442
<para>
443
</para><variablelist role="params">
444
<varlistentry><term><parameter>doc</parameter> :</term>
445
<listitem><simpara>
446
</simpara></listitem></varlistentry>
447
<varlistentry><term><parameter>flags</parameter> :</term>
448
<listitem><simpara>
449
</simpara></listitem></varlistentry>
450
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
451
</simpara></listitem></varlistentry>
452
</variablelist></refsect2>
453
<refsect2 id="gedit-document-get-can-search-again" role="function">
454
<title>gedit_document_get_can_search_again ()</title>
455
<indexterm zone="gedit-document-get-can-search-again"><primary sortas="gedit_document_get_can_search_again">gedit_document_get_can_search_again</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gedit_document_get_can_search_again (<link linkend="GeditDocument">GeditDocument</link> *doc);</programlisting>
456
<para>
457
</para><variablelist role="params">
458
<varlistentry><term><parameter>doc</parameter> :</term>
459
<listitem><simpara>
460
</simpara></listitem></varlistentry>
461
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
462
</simpara></listitem></varlistentry>
463
</variablelist></refsect2>
464
<refsect2 id="gedit-document-search-forward" role="function">
465
<title>gedit_document_search_forward ()</title>
466
<indexterm zone="gedit-document-search-forward"><primary sortas="gedit_document_search_forward">gedit_document_search_forward</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gedit_document_search_forward (<link linkend="GeditDocument">GeditDocument</link> *doc,
467
const <link linkend="GtkTextIter">GtkTextIter</link> *start,
468
const <link linkend="GtkTextIter">GtkTextIter</link> *end,
469
<link linkend="GtkTextIter">GtkTextIter</link> *match_start,
470
<link linkend="GtkTextIter">GtkTextIter</link> *match_end);</programlisting>
471
<para>
472
</para><variablelist role="params">
473
<varlistentry><term><parameter>doc</parameter> :</term>
474
<listitem><simpara>
475
</simpara></listitem></varlistentry>
476
<varlistentry><term><parameter>start</parameter> :</term>
477
<listitem><simpara>
478
</simpara></listitem></varlistentry>
479
<varlistentry><term><parameter>end</parameter> :</term>
480
<listitem><simpara>
481
</simpara></listitem></varlistentry>
482
<varlistentry><term><parameter>match_start</parameter> :</term>
483
<listitem><simpara>
484
</simpara></listitem></varlistentry>
485
<varlistentry><term><parameter>match_end</parameter> :</term>
486
<listitem><simpara>
487
</simpara></listitem></varlistentry>
488
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
489
</simpara></listitem></varlistentry>
490
</variablelist></refsect2>
491
<refsect2 id="gedit-document-search-backward" role="function">
492
<title>gedit_document_search_backward ()</title>
493
<indexterm zone="gedit-document-search-backward"><primary sortas="gedit_document_search_backward">gedit_document_search_backward</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gedit_document_search_backward (<link linkend="GeditDocument">GeditDocument</link> *doc,
494
const <link linkend="GtkTextIter">GtkTextIter</link> *start,
495
const <link linkend="GtkTextIter">GtkTextIter</link> *end,
496
<link linkend="GtkTextIter">GtkTextIter</link> *match_start,
497
<link linkend="GtkTextIter">GtkTextIter</link> *match_end);</programlisting>
498
<para>
499
</para><variablelist role="params">
500
<varlistentry><term><parameter>doc</parameter> :</term>
501
<listitem><simpara>
502
</simpara></listitem></varlistentry>
503
<varlistentry><term><parameter>start</parameter> :</term>
504
<listitem><simpara>
505
</simpara></listitem></varlistentry>
506
<varlistentry><term><parameter>end</parameter> :</term>
507
<listitem><simpara>
508
</simpara></listitem></varlistentry>
509
<varlistentry><term><parameter>match_start</parameter> :</term>
510
<listitem><simpara>
511
</simpara></listitem></varlistentry>
512
<varlistentry><term><parameter>match_end</parameter> :</term>
513
<listitem><simpara>
514
</simpara></listitem></varlistentry>
515
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
516
</simpara></listitem></varlistentry>
517
</variablelist></refsect2>
518
<refsect2 id="gedit-document-replace-all" role="function">
519
<title>gedit_document_replace_all ()</title>
520
<indexterm zone="gedit-document-replace-all"><primary sortas="gedit_document_replace_all">gedit_document_replace_all</primary></indexterm><programlisting><link linkend="gint">gint</link> gedit_document_replace_all (<link linkend="GeditDocument">GeditDocument</link> *doc,
521
const <link linkend="gchar">gchar</link> *find,
522
const <link linkend="gchar">gchar</link> *replace,
523
<link linkend="guint">guint</link> flags);</programlisting>
524
<para>
525
</para><variablelist role="params">
526
<varlistentry><term><parameter>doc</parameter> :</term>
527
<listitem><simpara>
528
</simpara></listitem></varlistentry>
529
<varlistentry><term><parameter>find</parameter> :</term>
530
<listitem><simpara>
531
</simpara></listitem></varlistentry>
532
<varlistentry><term><parameter>replace</parameter> :</term>
533
<listitem><simpara>
534
</simpara></listitem></varlistentry>
535
<varlistentry><term><parameter>flags</parameter> :</term>
536
<listitem><simpara>
537
</simpara></listitem></varlistentry>
538
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
539
</simpara></listitem></varlistentry>
540
</variablelist></refsect2>
541
<refsect2 id="gedit-document-set-language" role="function">
542
<title>gedit_document_set_language ()</title>
543
<indexterm zone="gedit-document-set-language"><primary sortas="gedit_document_set_language">gedit_document_set_language</primary></indexterm><programlisting><link linkend="void">void</link> gedit_document_set_language (<link linkend="GeditDocument">GeditDocument</link> *doc,
544
<link linkend="GtkSourceLanguage">GtkSourceLanguage</link> *lang);</programlisting>
545
<para>
546
</para><variablelist role="params">
547
<varlistentry><term><parameter>doc</parameter> :</term>
548
<listitem><simpara>
549
</simpara></listitem></varlistentry>
550
<varlistentry><term><parameter>lang</parameter> :</term>
551
<listitem><simpara>
552
</simpara></listitem></varlistentry>
553
</variablelist></refsect2>
554
<refsect2 id="gedit-document-set-enable-search-highlighting" role="function">
555
<title>gedit_document_set_enable_search_highlighting ()</title>
556
<indexterm zone="gedit-document-set-enable-search-highlighting"><primary sortas="gedit_document_set_enable_search_highlighting">gedit_document_set_enable_search_highlighting</primary></indexterm><programlisting><link linkend="void">void</link> gedit_document_set_enable_search_highlighting
557
(<link linkend="GeditDocument">GeditDocument</link> *doc,
558
<link linkend="gboolean">gboolean</link> enable);</programlisting>
559
<para>
560
</para><variablelist role="params">
561
<varlistentry><term><parameter>doc</parameter> :</term>
562
<listitem><simpara>
563
</simpara></listitem></varlistentry>
564
<varlistentry><term><parameter>enable</parameter> :</term>
565
<listitem><simpara>
566
</simpara></listitem></varlistentry>
567
</variablelist></refsect2>
568
<refsect2 id="gedit-document-get-enable-search-highlighting" role="function">
569
<title>gedit_document_get_enable_search_highlighting ()</title>
570
<indexterm zone="gedit-document-get-enable-search-highlighting"><primary sortas="gedit_document_get_enable_search_highlighting">gedit_document_get_enable_search_highlighting</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gedit_document_get_enable_search_highlighting
571
(<link linkend="GeditDocument">GeditDocument</link> *doc);</programlisting>
572
<para>
573
</para><variablelist role="params">
574
<varlistentry><term><parameter>doc</parameter> :</term>
575
<listitem><simpara>
576
</simpara></listitem></varlistentry>
577
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
578
</simpara></listitem></varlistentry>
579
</variablelist></refsect2>
580
<refsect2 id="GEDIT-SEARCH-IS-DONT-SET-FLAGS--CAPS" role="macro">
581
<title>GEDIT_SEARCH_IS_DONT_SET_FLAGS()</title>
582
<indexterm zone="GEDIT-SEARCH-IS-DONT-SET-FLAGS--CAPS"><primary sortas="GEDIT_SEARCH_IS_DONT_SET_FLAGS">GEDIT_SEARCH_IS_DONT_SET_FLAGS</primary></indexterm><programlisting>#define GEDIT_SEARCH_IS_DONT_SET_FLAGS(sflags) ((sflags & GEDIT_SEARCH_DONT_SET_FLAGS) != 0)
583
</programlisting>
584
<para>
585
</para><variablelist role="params">
586
<varlistentry><term><parameter>sflags</parameter> :</term>
587
<listitem><simpara>
588
</simpara></listitem></varlistentry>
589
</variablelist></refsect2>
590
<refsect2 id="GEDIT-SEARCH-SET-DONT-SET-FLAGS--CAPS" role="macro">
591
<title>GEDIT_SEARCH_SET_DONT_SET_FLAGS()</title>
592
<indexterm zone="GEDIT-SEARCH-SET-DONT-SET-FLAGS--CAPS"><primary sortas="GEDIT_SEARCH_SET_DONT_SET_FLAGS">GEDIT_SEARCH_SET_DONT_SET_FLAGS</primary></indexterm><programlisting>#define GEDIT_SEARCH_SET_DONT_SET_FLAGS(sflags,state)</programlisting>
593
<para>
594
</para><variablelist role="params">
595
<varlistentry><term><parameter>sflags</parameter> :</term>
596
<listitem><simpara>
597
</simpara></listitem></varlistentry>
598
<varlistentry><term><parameter>state</parameter> :</term>
599
<listitem><simpara>
600
</simpara></listitem></varlistentry>
601
</variablelist></refsect2>
602
<refsect2 id="GEDIT-SEARCH-IS-ENTIRE-WORD--CAPS" role="macro">
603
<title>GEDIT_SEARCH_IS_ENTIRE_WORD()</title>
604
<indexterm zone="GEDIT-SEARCH-IS-ENTIRE-WORD--CAPS"><primary sortas="GEDIT_SEARCH_IS_ENTIRE_WORD">GEDIT_SEARCH_IS_ENTIRE_WORD</primary></indexterm><programlisting>#define GEDIT_SEARCH_IS_ENTIRE_WORD(sflags) ((sflags & GEDIT_SEARCH_ENTIRE_WORD) != 0)
605
</programlisting>
606
<para>
607
</para><variablelist role="params">
608
<varlistentry><term><parameter>sflags</parameter> :</term>
609
<listitem><simpara>
610
</simpara></listitem></varlistentry>
611
</variablelist></refsect2>
612
<refsect2 id="GEDIT-SEARCH-SET-ENTIRE-WORD--CAPS" role="macro">
613
<title>GEDIT_SEARCH_SET_ENTIRE_WORD()</title>
614
<indexterm zone="GEDIT-SEARCH-SET-ENTIRE-WORD--CAPS"><primary sortas="GEDIT_SEARCH_SET_ENTIRE_WORD">GEDIT_SEARCH_SET_ENTIRE_WORD</primary></indexterm><programlisting>#define GEDIT_SEARCH_SET_ENTIRE_WORD(sflags,state)</programlisting>
615
<para>
616
</para><variablelist role="params">
617
<varlistentry><term><parameter>sflags</parameter> :</term>
618
<listitem><simpara>
619
</simpara></listitem></varlistentry>
620
<varlistentry><term><parameter>state</parameter> :</term>
621
<listitem><simpara>
622
</simpara></listitem></varlistentry>
623
</variablelist></refsect2>
624
<refsect2 id="GEDIT-SEARCH-IS-CASE-SENSITIVE--CAPS" role="macro">
625
<title>GEDIT_SEARCH_IS_CASE_SENSITIVE()</title>
626
<indexterm zone="GEDIT-SEARCH-IS-CASE-SENSITIVE--CAPS"><primary sortas="GEDIT_SEARCH_IS_CASE_SENSITIVE">GEDIT_SEARCH_IS_CASE_SENSITIVE</primary></indexterm><programlisting>#define GEDIT_SEARCH_IS_CASE_SENSITIVE(sflags) ((sflags & GEDIT_SEARCH_CASE_SENSITIVE) != 0)
627
</programlisting>
628
<para>
629
</para><variablelist role="params">
630
<varlistentry><term><parameter>sflags</parameter> :</term>
631
<listitem><simpara>
632
</simpara></listitem></varlistentry>
633
</variablelist></refsect2>
634
<refsect2 id="GEDIT-SEARCH-SET-CASE-SENSITIVE--CAPS" role="macro">
635
<title>GEDIT_SEARCH_SET_CASE_SENSITIVE()</title>
636
<indexterm zone="GEDIT-SEARCH-SET-CASE-SENSITIVE--CAPS"><primary sortas="GEDIT_SEARCH_SET_CASE_SENSITIVE">GEDIT_SEARCH_SET_CASE_SENSITIVE</primary></indexterm><programlisting>#define GEDIT_SEARCH_SET_CASE_SENSITIVE(sflags,state)</programlisting>
637
<para>
638
</para><variablelist role="params">
639
<varlistentry><term><parameter>sflags</parameter> :</term>
640
<listitem><simpara>
641
</simpara></listitem></varlistentry>
642
<varlistentry><term><parameter>state</parameter> :</term>
643
<listitem><simpara>
644
</simpara></listitem></varlistentry>
645
</variablelist></refsect2>
646
647
</refsect1>
648
<refsect1 id="GeditDocument.property-details" role="property_details">
649
<title role="property_details.title">Property Details</title>
650
<refsect2 id="GeditDocument--can-search-again" role="property"><title>The <literal>"can-search-again"</literal> property</title>
651
<indexterm zone="GeditDocument--can-search-again"><primary sortas="GeditDocument:can-search-again">GeditDocument:can-search-again</primary></indexterm><programlisting> "can-search-again" <link linkend="gboolean">gboolean</link> : Read</programlisting>
652
<para>Wheter it's possible to search again in the document.</para><para>Default value: FALSE</para>
653
</refsect2>
654
<refsect2 id="GeditDocument--content-type" role="property"><title>The <literal>"content-type"</literal> property</title>
655
<indexterm zone="GeditDocument--content-type"><primary sortas="GeditDocument:content-type">GeditDocument:content-type</primary></indexterm><programlisting> "content-type" <link linkend="gchar">gchar</link>* : Read</programlisting>
656
<para>The document's Content Type.</para><para>Default value: NULL</para>
657
</refsect2>
658
<refsect2 id="GeditDocument--enable-search-highlighting" role="property"><title>The <literal>"enable-search-highlighting"</literal> property</title>
659
<indexterm zone="GeditDocument--enable-search-highlighting"><primary sortas="GeditDocument:enable-search-highlighting">GeditDocument:enable-search-highlighting</primary></indexterm><programlisting> "enable-search-highlighting" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
660
<para>Whether all the occurences of the searched string must be highlighted.</para><para>Default value: FALSE</para>
661
</refsect2>
662
<refsect2 id="GeditDocument--encoding" role="property"><title>The <literal>"encoding"</literal> property</title>
663
<indexterm zone="GeditDocument--encoding"><primary sortas="GeditDocument:encoding">GeditDocument:encoding</primary></indexterm><programlisting> "encoding" <link linkend="GeditEncoding">GeditEncoding</link>* : Read</programlisting>
664
<para>The GeditEncoding used for the document.</para></refsect2>
665
<refsect2 id="GeditDocument--mime-type" role="property"><title>The <literal>"mime-type"</literal> property</title>
666
<indexterm zone="GeditDocument--mime-type"><primary sortas="GeditDocument:mime-type">GeditDocument:mime-type</primary></indexterm><programlisting> "mime-type" <link linkend="gchar">gchar</link>* : Read</programlisting>
667
<para>The document's MIME Type.</para><para>Default value: "text/plain"</para>
668
</refsect2>
669
<refsect2 id="GeditDocument--read-only" role="property"><title>The <literal>"read-only"</literal> property</title>
670
<indexterm zone="GeditDocument--read-only"><primary sortas="GeditDocument:read-only">GeditDocument:read-only</primary></indexterm><programlisting> "read-only" <link linkend="gboolean">gboolean</link> : Read</programlisting>
671
<para>Whether the document is read only or not.</para><para>Default value: FALSE</para>
672
</refsect2>
673
<refsect2 id="GeditDocument--shortname" role="property"><title>The <literal>"shortname"</literal> property</title>
674
<indexterm zone="GeditDocument--shortname"><primary sortas="GeditDocument:shortname">GeditDocument:shortname</primary></indexterm><programlisting> "shortname" <link linkend="gchar">gchar</link>* : Read</programlisting>
675
<para>The document's short name.</para><para>Default value: NULL</para>
676
</refsect2>
677
<refsect2 id="GeditDocument--uri" role="property"><title>The <literal>"uri"</literal> property</title>
678
<indexterm zone="GeditDocument--uri"><primary sortas="GeditDocument:uri">GeditDocument:uri</primary></indexterm><programlisting> "uri" <link linkend="gchar">gchar</link>* : Read</programlisting>
679
<para>The document's URI.</para><para>Default value: NULL</para>
680
</refsect2>
681
</refsect1>
682
683
<refsect1 id="GeditDocument.signal-details" role="signals">
684
<title role="signals.title">Signal Details</title>
685
<refsect2 id="GeditDocument-cursor-moved" role="signal"><title>The <literal>"cursor-moved"</literal> signal</title>
686
<indexterm zone="GeditDocument-cursor-moved"><primary sortas="GeditDocument::cursor-moved">GeditDocument::cursor-moved</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GeditDocument">GeditDocument</link> *geditdocument,
687
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
688
<para>
689
</para><variablelist role="params">
690
<varlistentry><term><parameter>geditdocument</parameter> :</term>
691
<listitem><simpara>the object which received the signal.
692
</simpara></listitem></varlistentry>
693
<varlistentry><term><parameter>user_data</parameter> :</term>
694
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
695
</variablelist></refsect2><refsect2 id="GeditDocument-load" role="signal"><title>The <literal>"load"</literal> signal</title>
696
<indexterm zone="GeditDocument-load" role="2.22"><primary sortas="GeditDocument::load">GeditDocument::load</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GeditDocument">GeditDocument</link> *document,
697
<link linkend="gchar">gchar</link> *uri,
698
<link linkend="GeditEncoding">GeditEncoding</link> *encoding,
699
<link linkend="gint">gint</link> line_pos,
700
<link linkend="gboolean">gboolean</link> create,
701
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
702
<para>
703
The "load" signal is emitted when a document is loaded.</para>
704
<para>
705
</para><variablelist role="params">
706
<varlistentry><term><parameter>document</parameter> :</term>
707
<listitem><simpara> the <link linkend="GeditDocument"><type>GeditDocument</type></link>.
708
</simpara></listitem></varlistentry>
709
<varlistentry><term><parameter>uri</parameter> :</term>
710
<listitem><simpara> the uri where to load the document from.
711
</simpara></listitem></varlistentry>
712
<varlistentry><term><parameter>encoding</parameter> :</term>
713
<listitem><simpara> the <link linkend="GeditEncoding"><type>GeditEncoding</type></link> to encode the document.
714
</simpara></listitem></varlistentry>
715
<varlistentry><term><parameter>line_pos</parameter> :</term>
716
<listitem><simpara> the line to show.
717
</simpara></listitem></varlistentry>
718
<varlistentry><term><parameter>create</parameter> :</term>
719
<listitem><simpara> whether the document should be created if it doesn't exist.
720
</simpara></listitem></varlistentry>
721
<varlistentry><term><parameter>user_data</parameter> :</term>
722
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
723
</variablelist><para>Since 2.22</para></refsect2><refsect2 id="GeditDocument-loaded" role="signal"><title>The <literal>"loaded"</literal> signal</title>
724
<indexterm zone="GeditDocument-loaded"><primary sortas="GeditDocument::loaded">GeditDocument::loaded</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GeditDocument">GeditDocument</link> *geditdocument,
725
<link linkend="gpointer">gpointer</link> arg1,
726
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
727
<para>
728
</para><variablelist role="params">
729
<varlistentry><term><parameter>geditdocument</parameter> :</term>
730
<listitem><simpara>the object which received the signal.
731
</simpara></listitem></varlistentry>
732
<varlistentry><term><parameter>arg1</parameter> :</term>
733
<listitem><simpara>
734
</simpara></listitem></varlistentry>
735
<varlistentry><term><parameter>user_data</parameter> :</term>
736
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
737
</variablelist></refsect2><refsect2 id="GeditDocument-loading" role="signal"><title>The <literal>"loading"</literal> signal</title>
738
<indexterm zone="GeditDocument-loading"><primary sortas="GeditDocument::loading">GeditDocument::loading</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GeditDocument">GeditDocument</link> *geditdocument,
739
<link linkend="guint64">guint64</link> arg1,
740
<link linkend="guint64">guint64</link> arg2,
741
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
742
<para>
743
</para><variablelist role="params">
744
<varlistentry><term><parameter>geditdocument</parameter> :</term>
745
<listitem><simpara>the object which received the signal.
746
</simpara></listitem></varlistentry>
747
<varlistentry><term><parameter>arg1</parameter> :</term>
748
<listitem><simpara>
749
</simpara></listitem></varlistentry>
750
<varlistentry><term><parameter>arg2</parameter> :</term>
751
<listitem><simpara>
752
</simpara></listitem></varlistentry>
753
<varlistentry><term><parameter>user_data</parameter> :</term>
754
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
755
</variablelist></refsect2><refsect2 id="GeditDocument-save" role="signal"><title>The <literal>"save"</literal> signal</title>
756
<indexterm zone="GeditDocument-save" role="2.20"><primary sortas="GeditDocument::save">GeditDocument::save</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GeditDocument">GeditDocument</link> *document,
757
<link linkend="gchar">gchar</link> *uri,
758
<link linkend="GeditEncoding">GeditEncoding</link> *encoding,
759
<link linkend="GeditDocumentSaveFlags">GeditDocumentSaveFlags</link> flags,
760
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
761
<para>
762
The "save" signal is emitted when the document is saved.</para>
763
<para>
764
</para><variablelist role="params">
765
<varlistentry><term><parameter>document</parameter> :</term>
766
<listitem><simpara> the <link linkend="GeditDocument"><type>GeditDocument</type></link>.
767
</simpara></listitem></varlistentry>
768
<varlistentry><term><parameter>uri</parameter> :</term>
769
<listitem><simpara> the uri where the document is about to be saved.
770
</simpara></listitem></varlistentry>
771
<varlistentry><term><parameter>encoding</parameter> :</term>
772
<listitem><simpara> the <link linkend="GeditEncoding"><type>GeditEncoding</type></link> used to save the document.
773
</simpara></listitem></varlistentry>
774
<varlistentry><term><parameter>flags</parameter> :</term>
775
<listitem><simpara> the <link linkend="GeditDocumentSaveFlags"><type>GeditDocumentSaveFlags</type></link> for the save operation.
776
</simpara></listitem></varlistentry>
777
<varlistentry><term><parameter>user_data</parameter> :</term>
778
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
779
</variablelist><para>Since 2.20</para></refsect2><refsect2 id="GeditDocument-saved" role="signal"><title>The <literal>"saved"</literal> signal</title>
780
<indexterm zone="GeditDocument-saved"><primary sortas="GeditDocument::saved">GeditDocument::saved</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GeditDocument">GeditDocument</link> *geditdocument,
781
<link linkend="gpointer">gpointer</link> arg1,
782
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
783
<para>
784
</para><variablelist role="params">
785
<varlistentry><term><parameter>geditdocument</parameter> :</term>
786
<listitem><simpara>the object which received the signal.
787
</simpara></listitem></varlistentry>
788
<varlistentry><term><parameter>arg1</parameter> :</term>
789
<listitem><simpara>
790
</simpara></listitem></varlistentry>
791
<varlistentry><term><parameter>user_data</parameter> :</term>
792
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
793
</variablelist></refsect2><refsect2 id="GeditDocument-saving" role="signal"><title>The <literal>"saving"</literal> signal</title>
794
<indexterm zone="GeditDocument-saving"><primary sortas="GeditDocument::saving">GeditDocument::saving</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GeditDocument">GeditDocument</link> *geditdocument,
795
<link linkend="guint64">guint64</link> arg1,
796
<link linkend="guint64">guint64</link> arg2,
797
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
798
<para>
799
</para><variablelist role="params">
800
<varlistentry><term><parameter>geditdocument</parameter> :</term>
801
<listitem><simpara>the object which received the signal.
802
</simpara></listitem></varlistentry>
803
<varlistentry><term><parameter>arg1</parameter> :</term>
804
<listitem><simpara>
805
</simpara></listitem></varlistentry>
806
<varlistentry><term><parameter>arg2</parameter> :</term>
807
<listitem><simpara>
808
</simpara></listitem></varlistentry>
809
<varlistentry><term><parameter>user_data</parameter> :</term>
810
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
811
</variablelist></refsect2><refsect2 id="GeditDocument-search-highlight-updated" role="signal"><title>The <literal>"search-highlight-updated"</literal> signal</title>
812
<indexterm zone="GeditDocument-search-highlight-updated"><primary sortas="GeditDocument::search-highlight-updated">GeditDocument::search-highlight-updated</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GeditDocument">GeditDocument</link> *geditdocument,
813
<link linkend="GtkTextIter">GtkTextIter</link> *arg1,
814
<link linkend="GtkTextIter">GtkTextIter</link> *arg2,
815
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
816
<para>
817
</para><variablelist role="params">
818
<varlistentry><term><parameter>geditdocument</parameter> :</term>
819
<listitem><simpara>the object which received the signal.
820
</simpara></listitem></varlistentry>
821
<varlistentry><term><parameter>arg1</parameter> :</term>
822
<listitem><simpara>
823
</simpara></listitem></varlistentry>
824
<varlistentry><term><parameter>arg2</parameter> :</term>
825
<listitem><simpara>
826
</simpara></listitem></varlistentry>
827
<varlistentry><term><parameter>user_data</parameter> :</term>
828
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
829
</variablelist></refsect2>
830
</refsect1>
831
832
833
834
</refentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.1