1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>GeditDocument</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
<link rel="home" href="index.html" title="gedit Reference Manual">
8
<link rel="up" href="ch01.html" title="gedit">
9
<link rel="prev" href="gedit-gedit-app.html" title="GeditApp">
10
<link rel="next" href="gedit-gedit-encodings-option-menu.html" title="GeditEncodingsOptionMenu">
11
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="chapter" href="ch01.html" title="gedit">
15
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
16
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
18
<td><a accesskey="p" href="gedit-gedit-app.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
19
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
20
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
21
<th width="100%" align="center">gedit Reference Manual</th>
22
<td><a accesskey="n" href="gedit-gedit-encodings-option-menu.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
24
<tr><td colspan="5" class="shortcuts">
25
<a href="#gedit-gedit-document.synopsis" class="shortcut">Top</a>
27
<a href="#gedit-gedit-document.description" class="shortcut">Description</a>
29
<a href="#gedit-gedit-document.object-hierarchy" class="shortcut">Object Hierarchy</a>
31
<a href="#gedit-gedit-document.properties" class="shortcut">Properties</a>
33
<a href="#gedit-gedit-document.signals" class="shortcut">Signals</a>
36
<div class="refentry" title="GeditDocument">
37
<a name="gedit-gedit-document"></a><div class="titlepage"></div>
38
<div class="refnamediv"><table width="100%"><tr>
40
<h2><span class="refentrytitle"><a name="gedit-gedit-document.top_of_page"></a>GeditDocument</span></h2>
43
<td valign="top" align="right"></td>
45
<div class="refsynopsisdiv" title="Synopsis">
46
<a name="gedit-gedit-document.synopsis"></a><h2>Synopsis</h2>
47
<a name="GeditDocument"></a><pre class="synopsis">enum <a class="link" href="gedit-gedit-document.html#GeditSearchFlags" title="enum GeditSearchFlags">GeditSearchFlags</a>;
48
<a class="link" href="gedit-gedit-document.html#GeditDocumentPrivate" title="GeditDocumentPrivate">GeditDocumentPrivate</a>;
49
<a class="link" href="gedit-gedit-document.html#GeditDocument-struct" title="GeditDocument">GeditDocument</a>;
50
enum <a class="link" href="gedit-gedit-document.html#GeditDocumentSaveFlags" title="enum GeditDocumentSaveFlags">GeditDocumentSaveFlags</a>;
51
#define <a class="link" href="gedit-gedit-document.html#GEDIT-DOCUMENT-ERROR:CAPS" title="GEDIT_DOCUMENT_ERROR">GEDIT_DOCUMENT_ERROR</a>
52
<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> <a class="link" href="gedit-gedit-document.html#gedit-document-error-quark" title="gedit_document_error_quark ()">gedit_document_error_quark</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
53
<a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="returnvalue">GeditDocument</span></a> * <a class="link" href="gedit-gedit-document.html#gedit-document-new" title="gedit_document_new ()">gedit_document_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
54
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gedit-gedit-document.html#gedit-document-get-uri" title="gedit_document_get_uri ()">gedit_document_get_uri</a> (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>);
55
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gedit-gedit-document.html#gedit-document-get-uri-for-display" title="gedit_document_get_uri_for_display ()">gedit_document_get_uri_for_display</a> (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>);
56
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gedit-gedit-document.html#gedit-document-get-short-name-for-display" title="gedit_document_get_short_name_for_display ()">gedit_document_get_short_name_for_display</a>
57
(<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>);
58
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gedit-gedit-document.html#gedit-document-get-mime-type" title="gedit_document_get_mime_type ()">gedit_document_get_mime_type</a> (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>);
59
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gedit-gedit-document.html#gedit-document-get-readonly" title="gedit_document_get_readonly ()">gedit_document_get_readonly</a> (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>);
60
<span class="returnvalue">void</span> <a class="link" href="gedit-gedit-document.html#gedit-document-load" title="gedit_document_load ()">gedit_document_load</a> (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>,
61
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>,
62
<em class="parameter"><code>const <a class="link" href="gedit-gedit-encodings.html#GeditEncoding" title="GeditEncoding"><span class="type">GeditEncoding</span></a> *encoding</code></em>,
63
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> line_pos</code></em>,
64
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> create</code></em>);
65
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gedit-gedit-document.html#gedit-document-insert-file" title="gedit_document_insert_file ()">gedit_document_insert_file</a> (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>,
66
<em class="parameter"><code><span class="type">GtkTextIter</span> *iter</code></em>,
67
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>,
68
<em class="parameter"><code>const <a class="link" href="gedit-gedit-encodings.html#GeditEncoding" title="GeditEncoding"><span class="type">GeditEncoding</span></a> *encoding</code></em>);
69
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gedit-gedit-document.html#gedit-document-load-cancel" title="gedit_document_load_cancel ()">gedit_document_load_cancel</a> (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>);
70
<span class="returnvalue">void</span> <a class="link" href="gedit-gedit-document.html#gedit-document-save" title="gedit_document_save ()">gedit_document_save</a> (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>,
71
<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocumentSaveFlags" title="enum GeditDocumentSaveFlags"><span class="type">GeditDocumentSaveFlags</span></a> flags</code></em>);
72
<span class="returnvalue">void</span> <a class="link" href="gedit-gedit-document.html#gedit-document-save-as" title="gedit_document_save_as ()">gedit_document_save_as</a> (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>,
73
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>,
74
<em class="parameter"><code>const <a class="link" href="gedit-gedit-encodings.html#GeditEncoding" title="GeditEncoding"><span class="type">GeditEncoding</span></a> *encoding</code></em>,
75
<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocumentSaveFlags" title="enum GeditDocumentSaveFlags"><span class="type">GeditDocumentSaveFlags</span></a> flags</code></em>);
76
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gedit-gedit-document.html#gedit-document-is-untouched" title="gedit_document_is_untouched ()">gedit_document_is_untouched</a> (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>);
77
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gedit-gedit-document.html#gedit-document-is-untitled" title="gedit_document_is_untitled ()">gedit_document_is_untitled</a> (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>);
78
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gedit-gedit-document.html#gedit-document-get-deleted" title="gedit_document_get_deleted ()">gedit_document_get_deleted</a> (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>);
79
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gedit-gedit-document.html#gedit-document-goto-line" title="gedit_document_goto_line ()">gedit_document_goto_line</a> (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>,
80
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> line</code></em>);
81
<span class="returnvalue">void</span> <a class="link" href="gedit-gedit-document.html#gedit-document-set-search-text" title="gedit_document_set_search_text ()">gedit_document_set_search_text</a> (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>,
82
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>,
83
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> flags</code></em>);
84
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gedit-gedit-document.html#gedit-document-get-search-text" title="gedit_document_get_search_text ()">gedit_document_get_search_text</a> (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>,
85
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *flags</code></em>);
86
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gedit-gedit-document.html#gedit-document-get-can-search-again" title="gedit_document_get_can_search_again ()">gedit_document_get_can_search_again</a> (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>);
87
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gedit-gedit-document.html#gedit-document-search-forward" title="gedit_document_search_forward ()">gedit_document_search_forward</a> (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>,
88
<em class="parameter"><code>const <span class="type">GtkTextIter</span> *start</code></em>,
89
<em class="parameter"><code>const <span class="type">GtkTextIter</span> *end</code></em>,
90
<em class="parameter"><code><span class="type">GtkTextIter</span> *match_start</code></em>,
91
<em class="parameter"><code><span class="type">GtkTextIter</span> *match_end</code></em>);
92
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gedit-gedit-document.html#gedit-document-search-backward" title="gedit_document_search_backward ()">gedit_document_search_backward</a> (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>,
93
<em class="parameter"><code>const <span class="type">GtkTextIter</span> *start</code></em>,
94
<em class="parameter"><code>const <span class="type">GtkTextIter</span> *end</code></em>,
95
<em class="parameter"><code><span class="type">GtkTextIter</span> *match_start</code></em>,
96
<em class="parameter"><code><span class="type">GtkTextIter</span> *match_end</code></em>);
97
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="gedit-gedit-document.html#gedit-document-replace-all" title="gedit_document_replace_all ()">gedit_document_replace_all</a> (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>,
98
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *find</code></em>,
99
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *replace</code></em>,
100
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> flags</code></em>);
101
<span class="returnvalue">void</span> <a class="link" href="gedit-gedit-document.html#gedit-document-set-language" title="gedit_document_set_language ()">gedit_document_set_language</a> (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>,
102
<em class="parameter"><code><a href="/opt/gnome/share/gtk-doc/html/gtksourceview-2.0/GtkSourceLanguage.html"><span class="type">GtkSourceLanguage</span></a> *lang</code></em>);
103
<span class="returnvalue">void</span> <a class="link" href="gedit-gedit-document.html#gedit-document-set-enable-search-highlighting" title="gedit_document_set_enable_search_highlighting ()">gedit_document_set_enable_search_highlighting</a>
104
(<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>,
105
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> enable</code></em>);
106
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gedit-gedit-document.html#gedit-document-get-enable-search-highlighting" title="gedit_document_get_enable_search_highlighting ()">gedit_document_get_enable_search_highlighting</a>
107
(<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>);
108
#define <a class="link" href="gedit-gedit-document.html#GEDIT-SEARCH-IS-DONT-SET-FLAGS:CAPS" title="GEDIT_SEARCH_IS_DONT_SET_FLAGS()">GEDIT_SEARCH_IS_DONT_SET_FLAGS</a> (sflags)
109
#define <a class="link" href="gedit-gedit-document.html#GEDIT-SEARCH-SET-DONT-SET-FLAGS:CAPS" title="GEDIT_SEARCH_SET_DONT_SET_FLAGS()">GEDIT_SEARCH_SET_DONT_SET_FLAGS</a> (sflags,
111
#define <a class="link" href="gedit-gedit-document.html#GEDIT-SEARCH-IS-ENTIRE-WORD:CAPS" title="GEDIT_SEARCH_IS_ENTIRE_WORD()">GEDIT_SEARCH_IS_ENTIRE_WORD</a> (sflags)
112
#define <a class="link" href="gedit-gedit-document.html#GEDIT-SEARCH-SET-ENTIRE-WORD:CAPS" title="GEDIT_SEARCH_SET_ENTIRE_WORD()">GEDIT_SEARCH_SET_ENTIRE_WORD</a> (sflags,
114
#define <a class="link" href="gedit-gedit-document.html#GEDIT-SEARCH-IS-CASE-SENSITIVE:CAPS" title="GEDIT_SEARCH_IS_CASE_SENSITIVE()">GEDIT_SEARCH_IS_CASE_SENSITIVE</a> (sflags)
115
#define <a class="link" href="gedit-gedit-document.html#GEDIT-SEARCH-SET-CASE-SENSITIVE:CAPS" title="GEDIT_SEARCH_SET_CASE_SENSITIVE()">GEDIT_SEARCH_SET_CASE_SENSITIVE</a> (sflags,
119
<div class="refsect1" title="Object Hierarchy">
120
<a name="gedit-gedit-document.object-hierarchy"></a><h2>Object Hierarchy</h2>
121
<pre class="synopsis">
122
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
124
+----<a href="/opt/gnome/share/gtk-doc/html/gtksourceview-2.0/GtkSourceBuffer.html">GtkSourceBuffer</a>
128
<div class="refsect1" title="Properties">
129
<a name="gedit-gedit-document.properties"></a><h2>Properties</h2>
130
<pre class="synopsis">
131
"<a class="link" href="gedit-gedit-document.html#GeditDocument--can-search-again" title='The "can-search-again" property'>can-search-again</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read
132
"<a class="link" href="gedit-gedit-document.html#GeditDocument--content-type" title='The "content-type" property'>content-type</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
133
"<a class="link" href="gedit-gedit-document.html#GeditDocument--enable-search-highlighting" title='The "enable-search-highlighting" property'>enable-search-highlighting</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
134
"<a class="link" href="gedit-gedit-document.html#GeditDocument--encoding" title='The "encoding" property'>encoding</a>" <a class="link" href="gedit-gedit-encodings.html#GeditEncoding" title="GeditEncoding"><span class="type">GeditEncoding</span></a>* : Read
135
"<a class="link" href="gedit-gedit-document.html#GeditDocument--mime-type" title='The "mime-type" property'>mime-type</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read
136
"<a class="link" href="gedit-gedit-document.html#GeditDocument--newline-type" title='The "newline-type" property'>newline-type</a>" <span class="type">GeditDocumentNewlineType</span> : Read / Write
137
"<a class="link" href="gedit-gedit-document.html#GeditDocument--read-only" title='The "read-only" property'>read-only</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read
138
"<a class="link" href="gedit-gedit-document.html#GeditDocument--shortname" title='The "shortname" property'>shortname</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
139
"<a class="link" href="gedit-gedit-document.html#GeditDocument--uri" title='The "uri" property'>uri</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read
142
<div class="refsect1" title="Signals">
143
<a name="gedit-gedit-document.signals"></a><h2>Signals</h2>
144
<pre class="synopsis">
145
"<a class="link" href="gedit-gedit-document.html#GeditDocument-cursor-moved" title='The "cursor-moved" signal'>cursor-moved</a>" : Run Last
146
"<a class="link" href="gedit-gedit-document.html#GeditDocument-load" title='The "load" signal'>load</a>" : Run Last
147
"<a class="link" href="gedit-gedit-document.html#GeditDocument-loaded" title='The "loaded" signal'>loaded</a>" : Run Last
148
"<a class="link" href="gedit-gedit-document.html#GeditDocument-loading" title='The "loading" signal'>loading</a>" : Run Last
149
"<a class="link" href="gedit-gedit-document.html#GeditDocument-save" title='The "save" signal'>save</a>" : Run Last
150
"<a class="link" href="gedit-gedit-document.html#GeditDocument-saved" title='The "saved" signal'>saved</a>" : Run Last
151
"<a class="link" href="gedit-gedit-document.html#GeditDocument-saving" title='The "saving" signal'>saving</a>" : Run Last
152
"<a class="link" href="gedit-gedit-document.html#GeditDocument-search-highlight-updated" title='The "search-highlight-updated" signal'>search-highlight-updated</a>" : Run Last
155
<div class="refsect1" title="Description">
156
<a name="gedit-gedit-document.description"></a><h2>Description</h2>
158
<div class="refsect1" title="Details">
159
<a name="gedit-gedit-document.details"></a><h2>Details</h2>
160
<div class="refsect2" title="enum GeditSearchFlags">
161
<a name="GeditSearchFlags"></a><h3>enum GeditSearchFlags</h3>
162
<pre class="programlisting">typedef enum
164
GEDIT_SEARCH_DONT_SET_FLAGS = 1 << 0,
165
GEDIT_SEARCH_ENTIRE_WORD = 1 << 1,
166
GEDIT_SEARCH_CASE_SENSITIVE = 1 << 2
172
<div class="refsect2" title="GeditDocumentPrivate">
173
<a name="GeditDocumentPrivate"></a><h3>GeditDocumentPrivate</h3>
174
<pre class="programlisting">typedef struct _GeditDocumentPrivate GeditDocumentPrivate;</pre>
177
<div class="refsect2" title="GeditDocument">
178
<a name="GeditDocument-struct"></a><h3>GeditDocument</h3>
179
<pre class="programlisting">typedef struct _GeditDocument GeditDocument;</pre>
182
<div class="refsect2" title="enum GeditDocumentSaveFlags">
183
<a name="GeditDocumentSaveFlags"></a><h3>enum GeditDocumentSaveFlags</h3>
184
<pre class="programlisting">typedef enum
186
GEDIT_DOCUMENT_SAVE_IGNORE_MTIME = 1 << 0,
187
GEDIT_DOCUMENT_SAVE_IGNORE_BACKUP = 1 << 1,
188
GEDIT_DOCUMENT_SAVE_PRESERVE_BACKUP = 1 << 2
189
} GeditDocumentSaveFlags;
191
<div class="variablelist"><table border="0">
192
<col align="left" valign="top">
195
<td><p><a name="GEDIT-DOCUMENT-SAVE-IGNORE-MTIME:CAPS"></a><span class="term"><code class="literal">GEDIT_DOCUMENT_SAVE_IGNORE_MTIME</code></span></p></td>
196
<td>save file despite external modifications.
200
<td><p><a name="GEDIT-DOCUMENT-SAVE-IGNORE-BACKUP:CAPS"></a><span class="term"><code class="literal">GEDIT_DOCUMENT_SAVE_IGNORE_BACKUP</code></span></p></td>
201
<td>write the file directly without attempting to backup.
205
<td><p><a name="GEDIT-DOCUMENT-SAVE-PRESERVE-BACKUP:CAPS"></a><span class="term"><code class="literal">GEDIT_DOCUMENT_SAVE_PRESERVE_BACKUP</code></span></p></td>
206
<td>preserve previous backup file, needed to support autosaving.
213
<div class="refsect2" title="GEDIT_DOCUMENT_ERROR">
214
<a name="GEDIT-DOCUMENT-ERROR:CAPS"></a><h3>GEDIT_DOCUMENT_ERROR</h3>
215
<pre class="programlisting">#define GEDIT_DOCUMENT_ERROR gedit_document_error_quark ()
219
<div class="refsect2" title="gedit_document_error_quark ()">
220
<a name="gedit-document-error-quark"></a><h3>gedit_document_error_quark ()</h3>
221
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a> gedit_document_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
224
<div class="refsect2" title="gedit_document_new ()">
225
<a name="gedit-document-new"></a><h3>gedit_document_new ()</h3>
226
<pre class="programlisting"><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="returnvalue">GeditDocument</span></a> * gedit_document_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
229
<div class="refsect2" title="gedit_document_get_uri ()">
230
<a name="gedit-document-get-uri"></a><h3>gedit_document_get_uri ()</h3>
231
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gedit_document_get_uri (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>);</pre>
234
<div class="refsect2" title="gedit_document_get_uri_for_display ()">
235
<a name="gedit-document-get-uri-for-display"></a><h3>gedit_document_get_uri_for_display ()</h3>
236
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gedit_document_get_uri_for_display (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>);</pre>
239
<div class="refsect2" title="gedit_document_get_short_name_for_display ()">
240
<a name="gedit-document-get-short-name-for-display"></a><h3>gedit_document_get_short_name_for_display ()</h3>
241
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gedit_document_get_short_name_for_display
242
(<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>);</pre>
245
<div class="refsect2" title="gedit_document_get_mime_type ()">
246
<a name="gedit-document-get-mime-type"></a><h3>gedit_document_get_mime_type ()</h3>
247
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gedit_document_get_mime_type (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>);</pre>
250
<div class="refsect2" title="gedit_document_get_readonly ()">
251
<a name="gedit-document-get-readonly"></a><h3>gedit_document_get_readonly ()</h3>
252
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gedit_document_get_readonly (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>);</pre>
255
<div class="refsect2" title="gedit_document_load ()">
256
<a name="gedit-document-load"></a><h3>gedit_document_load ()</h3>
257
<pre class="programlisting"><span class="returnvalue">void</span> gedit_document_load (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>,
258
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>,
259
<em class="parameter"><code>const <a class="link" href="gedit-gedit-encodings.html#GeditEncoding" title="GeditEncoding"><span class="type">GeditEncoding</span></a> *encoding</code></em>,
260
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> line_pos</code></em>,
261
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> create</code></em>);</pre>
263
Load a document. This results in the "load" signal to be emitted.</p>
264
<div class="variablelist"><table border="0">
265
<col align="left" valign="top">
268
<td><p><span class="term"><em class="parameter"><code>doc</code></em> :</span></p></td>
269
<td>the <a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a>.
273
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
274
<td>the uri where to load the document from.
278
<td><p><span class="term"><em class="parameter"><code>encoding</code></em> :</span></p></td>
279
<td>the <a class="link" href="gedit-gedit-encodings.html#GeditEncoding" title="GeditEncoding"><span class="type">GeditEncoding</span></a> to encode the document.
283
<td><p><span class="term"><em class="parameter"><code>line_pos</code></em> :</span></p></td>
284
<td>the line to show.
288
<td><p><span class="term"><em class="parameter"><code>create</code></em> :</span></p></td>
289
<td>whether the document should be created if it doesn't exist.
296
<div class="refsect2" title="gedit_document_insert_file ()">
297
<a name="gedit-document-insert-file"></a><h3>gedit_document_insert_file ()</h3>
298
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gedit_document_insert_file (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>,
299
<em class="parameter"><code><span class="type">GtkTextIter</span> *iter</code></em>,
300
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>,
301
<em class="parameter"><code>const <a class="link" href="gedit-gedit-encodings.html#GeditEncoding" title="GeditEncoding"><span class="type">GeditEncoding</span></a> *encoding</code></em>);</pre>
304
<div class="refsect2" title="gedit_document_load_cancel ()">
305
<a name="gedit-document-load-cancel"></a><h3>gedit_document_load_cancel ()</h3>
306
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gedit_document_load_cancel (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>);</pre>
308
Cancel load of a document.</p>
309
<div class="variablelist"><table border="0">
310
<col align="left" valign="top">
312
<td><p><span class="term"><em class="parameter"><code>doc</code></em> :</span></p></td>
313
<td>the <a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a>.
319
<div class="refsect2" title="gedit_document_save ()">
320
<a name="gedit-document-save"></a><h3>gedit_document_save ()</h3>
321
<pre class="programlisting"><span class="returnvalue">void</span> gedit_document_save (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>,
322
<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocumentSaveFlags" title="enum GeditDocumentSaveFlags"><span class="type">GeditDocumentSaveFlags</span></a> flags</code></em>);</pre>
324
Save the document to its previous location. This results in the "save"
325
signal to be emitted.</p>
326
<div class="variablelist"><table border="0">
327
<col align="left" valign="top">
330
<td><p><span class="term"><em class="parameter"><code>doc</code></em> :</span></p></td>
331
<td>the <a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a>.
335
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
336
<td>optionnal <a class="link" href="gedit-gedit-document.html#GeditDocumentSaveFlags" title="enum GeditDocumentSaveFlags"><span class="type">GeditDocumentSaveFlags</span></a>.
343
<div class="refsect2" title="gedit_document_save_as ()">
344
<a name="gedit-document-save-as"></a><h3>gedit_document_save_as ()</h3>
345
<pre class="programlisting"><span class="returnvalue">void</span> gedit_document_save_as (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>,
346
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>,
347
<em class="parameter"><code>const <a class="link" href="gedit-gedit-encodings.html#GeditEncoding" title="GeditEncoding"><span class="type">GeditEncoding</span></a> *encoding</code></em>,
348
<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocumentSaveFlags" title="enum GeditDocumentSaveFlags"><span class="type">GeditDocumentSaveFlags</span></a> flags</code></em>);</pre>
350
Save the document to a new location. This results in the "save" signal
352
<div class="variablelist"><table border="0">
353
<col align="left" valign="top">
356
<td><p><span class="term"><em class="parameter"><code>doc</code></em> :</span></p></td>
357
<td>the <a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a>.
361
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
362
<td>the uri where to save the document.
366
<td><p><span class="term"><em class="parameter"><code>encoding</code></em> :</span></p></td>
367
<td>the <a class="link" href="gedit-gedit-encodings.html#GeditEncoding" title="GeditEncoding"><span class="type">GeditEncoding</span></a> to encode the document.
371
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
372
<td>optionnal <a class="link" href="gedit-gedit-document.html#GeditDocumentSaveFlags" title="enum GeditDocumentSaveFlags"><span class="type">GeditDocumentSaveFlags</span></a>.
379
<div class="refsect2" title="gedit_document_is_untouched ()">
380
<a name="gedit-document-is-untouched"></a><h3>gedit_document_is_untouched ()</h3>
381
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gedit_document_is_untouched (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>);</pre>
384
<div class="refsect2" title="gedit_document_is_untitled ()">
385
<a name="gedit-document-is-untitled"></a><h3>gedit_document_is_untitled ()</h3>
386
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gedit_document_is_untitled (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>);</pre>
389
<div class="refsect2" title="gedit_document_get_deleted ()">
390
<a name="gedit-document-get-deleted"></a><h3>gedit_document_get_deleted ()</h3>
391
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gedit_document_get_deleted (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>);</pre>
394
<div class="refsect2" title="gedit_document_goto_line ()">
395
<a name="gedit-document-goto-line"></a><h3>gedit_document_goto_line ()</h3>
396
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gedit_document_goto_line (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>,
397
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> line</code></em>);</pre>
400
<div class="refsect2" title="gedit_document_set_search_text ()">
401
<a name="gedit-document-set-search-text"></a><h3>gedit_document_set_search_text ()</h3>
402
<pre class="programlisting"><span class="returnvalue">void</span> gedit_document_set_search_text (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>,
403
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>,
404
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> flags</code></em>);</pre>
407
<div class="refsect2" title="gedit_document_get_search_text ()">
408
<a name="gedit-document-get-search-text"></a><h3>gedit_document_get_search_text ()</h3>
409
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gedit_document_get_search_text (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>,
410
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *flags</code></em>);</pre>
413
<div class="refsect2" title="gedit_document_get_can_search_again ()">
414
<a name="gedit-document-get-can-search-again"></a><h3>gedit_document_get_can_search_again ()</h3>
415
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gedit_document_get_can_search_again (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>);</pre>
418
<div class="refsect2" title="gedit_document_search_forward ()">
419
<a name="gedit-document-search-forward"></a><h3>gedit_document_search_forward ()</h3>
420
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gedit_document_search_forward (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>,
421
<em class="parameter"><code>const <span class="type">GtkTextIter</span> *start</code></em>,
422
<em class="parameter"><code>const <span class="type">GtkTextIter</span> *end</code></em>,
423
<em class="parameter"><code><span class="type">GtkTextIter</span> *match_start</code></em>,
424
<em class="parameter"><code><span class="type">GtkTextIter</span> *match_end</code></em>);</pre>
427
<div class="refsect2" title="gedit_document_search_backward ()">
428
<a name="gedit-document-search-backward"></a><h3>gedit_document_search_backward ()</h3>
429
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gedit_document_search_backward (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>,
430
<em class="parameter"><code>const <span class="type">GtkTextIter</span> *start</code></em>,
431
<em class="parameter"><code>const <span class="type">GtkTextIter</span> *end</code></em>,
432
<em class="parameter"><code><span class="type">GtkTextIter</span> *match_start</code></em>,
433
<em class="parameter"><code><span class="type">GtkTextIter</span> *match_end</code></em>);</pre>
436
<div class="refsect2" title="gedit_document_replace_all ()">
437
<a name="gedit-document-replace-all"></a><h3>gedit_document_replace_all ()</h3>
438
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gedit_document_replace_all (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>,
439
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *find</code></em>,
440
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *replace</code></em>,
441
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> flags</code></em>);</pre>
444
<div class="refsect2" title="gedit_document_set_language ()">
445
<a name="gedit-document-set-language"></a><h3>gedit_document_set_language ()</h3>
446
<pre class="programlisting"><span class="returnvalue">void</span> gedit_document_set_language (<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>,
447
<em class="parameter"><code><a href="/opt/gnome/share/gtk-doc/html/gtksourceview-2.0/GtkSourceLanguage.html"><span class="type">GtkSourceLanguage</span></a> *lang</code></em>);</pre>
450
<div class="refsect2" title="gedit_document_set_enable_search_highlighting ()">
451
<a name="gedit-document-set-enable-search-highlighting"></a><h3>gedit_document_set_enable_search_highlighting ()</h3>
452
<pre class="programlisting"><span class="returnvalue">void</span> gedit_document_set_enable_search_highlighting
453
(<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>,
454
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> enable</code></em>);</pre>
457
<div class="refsect2" title="gedit_document_get_enable_search_highlighting ()">
458
<a name="gedit-document-get-enable-search-highlighting"></a><h3>gedit_document_get_enable_search_highlighting ()</h3>
459
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gedit_document_get_enable_search_highlighting
460
(<em class="parameter"><code><a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *doc</code></em>);</pre>
463
<div class="refsect2" title="GEDIT_SEARCH_IS_DONT_SET_FLAGS()">
464
<a name="GEDIT-SEARCH-IS-DONT-SET-FLAGS:CAPS"></a><h3>GEDIT_SEARCH_IS_DONT_SET_FLAGS()</h3>
465
<pre class="programlisting">#define GEDIT_SEARCH_IS_DONT_SET_FLAGS(sflags) ((sflags & GEDIT_SEARCH_DONT_SET_FLAGS) != 0)
469
<div class="refsect2" title="GEDIT_SEARCH_SET_DONT_SET_FLAGS()">
470
<a name="GEDIT-SEARCH-SET-DONT-SET-FLAGS:CAPS"></a><h3>GEDIT_SEARCH_SET_DONT_SET_FLAGS()</h3>
471
<pre class="programlisting">#define GEDIT_SEARCH_SET_DONT_SET_FLAGS(sflags,state)</pre>
474
<div class="refsect2" title="GEDIT_SEARCH_IS_ENTIRE_WORD()">
475
<a name="GEDIT-SEARCH-IS-ENTIRE-WORD:CAPS"></a><h3>GEDIT_SEARCH_IS_ENTIRE_WORD()</h3>
476
<pre class="programlisting">#define GEDIT_SEARCH_IS_ENTIRE_WORD(sflags) ((sflags & GEDIT_SEARCH_ENTIRE_WORD) != 0)
480
<div class="refsect2" title="GEDIT_SEARCH_SET_ENTIRE_WORD()">
481
<a name="GEDIT-SEARCH-SET-ENTIRE-WORD:CAPS"></a><h3>GEDIT_SEARCH_SET_ENTIRE_WORD()</h3>
482
<pre class="programlisting">#define GEDIT_SEARCH_SET_ENTIRE_WORD(sflags,state)</pre>
485
<div class="refsect2" title="GEDIT_SEARCH_IS_CASE_SENSITIVE()">
486
<a name="GEDIT-SEARCH-IS-CASE-SENSITIVE:CAPS"></a><h3>GEDIT_SEARCH_IS_CASE_SENSITIVE()</h3>
487
<pre class="programlisting">#define GEDIT_SEARCH_IS_CASE_SENSITIVE(sflags) ((sflags & GEDIT_SEARCH_CASE_SENSITIVE) != 0)
491
<div class="refsect2" title="GEDIT_SEARCH_SET_CASE_SENSITIVE()">
492
<a name="GEDIT-SEARCH-SET-CASE-SENSITIVE:CAPS"></a><h3>GEDIT_SEARCH_SET_CASE_SENSITIVE()</h3>
493
<pre class="programlisting">#define GEDIT_SEARCH_SET_CASE_SENSITIVE(sflags,state)</pre>
496
<div class="refsect1" title="Property Details">
497
<a name="gedit-gedit-document.property-details"></a><h2>Property Details</h2>
498
<div class="refsect2" title='The "can-search-again" property'>
499
<a name="GeditDocument--can-search-again"></a><h3>The <code class="literal">"can-search-again"</code> property</h3>
500
<pre class="programlisting"> "can-search-again" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read</pre>
501
<p>Wheter it's possible to search again in the document.</p>
502
<p>Default value: FALSE</p>
505
<div class="refsect2" title='The "content-type" property'>
506
<a name="GeditDocument--content-type"></a><h3>The <code class="literal">"content-type"</code> property</h3>
507
<pre class="programlisting"> "content-type" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
508
<p>The document's Content Type.</p>
509
<p>Default value: NULL</p>
512
<div class="refsect2" title='The "enable-search-highlighting" property'>
513
<a name="GeditDocument--enable-search-highlighting"></a><h3>The <code class="literal">"enable-search-highlighting"</code> property</h3>
514
<pre class="programlisting"> "enable-search-highlighting" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
515
<p>Whether all the occurences of the searched string must be highlighted.</p>
516
<p>Default value: FALSE</p>
519
<div class="refsect2" title='The "encoding" property'>
520
<a name="GeditDocument--encoding"></a><h3>The <code class="literal">"encoding"</code> property</h3>
521
<pre class="programlisting"> "encoding" <a class="link" href="gedit-gedit-encodings.html#GeditEncoding" title="GeditEncoding"><span class="type">GeditEncoding</span></a>* : Read</pre>
522
<p>The GeditEncoding used for the document.</p>
525
<div class="refsect2" title='The "mime-type" property'>
526
<a name="GeditDocument--mime-type"></a><h3>The <code class="literal">"mime-type"</code> property</h3>
527
<pre class="programlisting"> "mime-type" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre>
528
<p>The document's MIME Type.</p>
529
<p>Default value: "text/plain"</p>
532
<div class="refsect2" title='The "newline-type" property'>
533
<a name="GeditDocument--newline-type"></a><h3>The <code class="literal">"newline-type"</code> property</h3>
534
<pre class="programlisting"> "newline-type" <span class="type">GeditDocumentNewlineType</span> : Read / Write</pre>
536
The :newline-type property determines what is considered
537
as a line ending when saving the document</p>
538
<p>Default value: GEDIT_DOCUMENT_NEWLINE_TYPE_LF</p>
541
<div class="refsect2" title='The "read-only" property'>
542
<a name="GeditDocument--read-only"></a><h3>The <code class="literal">"read-only"</code> property</h3>
543
<pre class="programlisting"> "read-only" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read</pre>
544
<p>Whether the document is read only or not.</p>
545
<p>Default value: FALSE</p>
548
<div class="refsect2" title='The "shortname" property'>
549
<a name="GeditDocument--shortname"></a><h3>The <code class="literal">"shortname"</code> property</h3>
550
<pre class="programlisting"> "shortname" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
551
<p>The document's short name.</p>
552
<p>Default value: NULL</p>
555
<div class="refsect2" title='The "uri" property'>
556
<a name="GeditDocument--uri"></a><h3>The <code class="literal">"uri"</code> property</h3>
557
<pre class="programlisting"> "uri" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre>
558
<p>The document's URI.</p>
559
<p>Default value: NULL</p>
562
<div class="refsect1" title="Signal Details">
563
<a name="gedit-gedit-document.signal-details"></a><h2>Signal Details</h2>
564
<div class="refsect2" title='The "cursor-moved" signal'>
565
<a name="GeditDocument-cursor-moved"></a><h3>The <code class="literal">"cursor-moved"</code> signal</h3>
566
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *geditdocument,
567
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre>
570
<div class="refsect2" title='The "load" signal'>
571
<a name="GeditDocument-load"></a><h3>The <code class="literal">"load"</code> signal</h3>
572
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *document,
573
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri,
574
<a class="link" href="gedit-gedit-encodings.html#GeditEncoding" title="GeditEncoding"><span class="type">GeditEncoding</span></a> *encoding,
575
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> line_pos,
576
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> create,
577
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre>
579
The "load" signal is emitted when a document is loaded.</p>
580
<div class="variablelist"><table border="0">
581
<col align="left" valign="top">
584
<td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
585
<td>the <a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a>.
589
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
590
<td>the uri where to load the document from.
594
<td><p><span class="term"><em class="parameter"><code>encoding</code></em> :</span></p></td>
595
<td>the <a class="link" href="gedit-gedit-encodings.html#GeditEncoding" title="GeditEncoding"><span class="type">GeditEncoding</span></a> to encode the document.
599
<td><p><span class="term"><em class="parameter"><code>line_pos</code></em> :</span></p></td>
600
<td>the line to show.
604
<td><p><span class="term"><em class="parameter"><code>create</code></em> :</span></p></td>
605
<td>whether the document should be created if it doesn't exist.
609
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
610
<td>user data set when the signal handler was connected.</td>
614
<p class="since">Since 2.22</p>
617
<div class="refsect2" title='The "loaded" signal'>
618
<a name="GeditDocument-loaded"></a><h3>The <code class="literal">"loaded"</code> signal</h3>
619
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *geditdocument,
620
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> arg1,
621
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre>
624
<div class="refsect2" title='The "loading" signal'>
625
<a name="GeditDocument-loading"></a><h3>The <code class="literal">"loading"</code> signal</h3>
626
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *geditdocument,
627
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> arg1,
628
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> arg2,
629
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre>
632
<div class="refsect2" title='The "save" signal'>
633
<a name="GeditDocument-save"></a><h3>The <code class="literal">"save"</code> signal</h3>
634
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *document,
635
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri,
636
<a class="link" href="gedit-gedit-encodings.html#GeditEncoding" title="GeditEncoding"><span class="type">GeditEncoding</span></a> *encoding,
637
<a class="link" href="gedit-gedit-document.html#GeditDocumentSaveFlags" title="enum GeditDocumentSaveFlags"><span class="type">GeditDocumentSaveFlags</span></a> flags,
638
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre>
640
The "save" signal is emitted when the document is saved.</p>
641
<div class="variablelist"><table border="0">
642
<col align="left" valign="top">
645
<td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
646
<td>the <a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a>.
650
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
651
<td>the uri where the document is about to be saved.
655
<td><p><span class="term"><em class="parameter"><code>encoding</code></em> :</span></p></td>
656
<td>the <a class="link" href="gedit-gedit-encodings.html#GeditEncoding" title="GeditEncoding"><span class="type">GeditEncoding</span></a> used to save the document.
660
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
661
<td>the <a class="link" href="gedit-gedit-document.html#GeditDocumentSaveFlags" title="enum GeditDocumentSaveFlags"><span class="type">GeditDocumentSaveFlags</span></a> for the save operation.
665
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
666
<td>user data set when the signal handler was connected.</td>
670
<p class="since">Since 2.20</p>
673
<div class="refsect2" title='The "saved" signal'>
674
<a name="GeditDocument-saved"></a><h3>The <code class="literal">"saved"</code> signal</h3>
675
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *geditdocument,
676
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> arg1,
677
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre>
680
<div class="refsect2" title='The "saving" signal'>
681
<a name="GeditDocument-saving"></a><h3>The <code class="literal">"saving"</code> signal</h3>
682
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *geditdocument,
683
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> arg1,
684
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> arg2,
685
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre>
688
<div class="refsect2" title='The "search-highlight-updated" signal'>
689
<a name="GeditDocument-search-highlight-updated"></a><h3>The <code class="literal">"search-highlight-updated"</code> signal</h3>
690
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="gedit-gedit-document.html#GeditDocument"><span class="type">GeditDocument</span></a> *geditdocument,
691
<span class="type">GtkTextIter</span> *arg1,
692
<span class="type">GtkTextIter</span> *arg2,
693
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre>
699
Generated by GTK-Doc V1.14</div>
b'\\ No newline at end of file'