← Back to branch summary

~ubuntu-branches/ubuntu/lucid/gedit/lucid-proposed

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Chris Coulson
  • Date: 2010-03-03 22:44:53 UTC
  • mfrom: (1.1.75 upstream)
  • Revision ID: james.westby@ubuntu.com-20100303224453-cv1q4se7d0xgibqg
Tags: 2.29.8-0ubuntu1
* New upstream version
  - Rework encoding validation
  - Misc bugfixes
* Refreshed patches:
  - 01_gedit-bugreport-location.patch
  - 01_lpi.patch
  - 03_python_path.patch
  - 80_not_using_localmodlibs.patch
  - 90_autoconf.patch
  - 99_ltmain_as-needed.patch

Show diffs side-by-side

added added

removed removed

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