Top | ![]() |
![]() |
![]() |
![]() |
gboolean | can-search-again | Read |
GeditDocumentCompressionType | compression-type | Read / Write / Construct |
gchar * | content-type | Read / Write |
gboolean | empty-search | Read |
gboolean | enable-search-highlighting | Read / Write |
GeditEncoding * | encoding | Read |
GFile * | location | Read / Write |
gchar * | mime-type | Read |
GeditDocumentNewlineType | newline-type | Read / Write / Construct |
gboolean | read-only | Read |
gchar * | shortname | Read / Write |
void | cursor-moved | Run Last |
void | load | Run Last |
void | loaded | Run Last |
void | loading | Run Last |
void | save | Run Last |
void | saved | Run Last |
void | saving | Run Last |
void | search-highlight-updated | Run Last |
enum | GeditSearchFlags |
GeditDocumentPrivate | |
struct | GeditDocument |
enum | GeditDocumentSaveFlags |
#define | GEDIT_DOCUMENT_ERROR |
gchar *
gedit_document_get_uri_for_display (GeditDocument *doc
);
Note: this never returns NULL
.
gchar *
gedit_document_get_short_name_for_display
(GeditDocument *doc
);
Note: this never returns NULL
.
gchar *
gedit_document_get_mime_type (GeditDocument *doc
);
Note: this never returns NULL
.
void gedit_document_load (GeditDocument *doc
,GFile *location
,const GeditEncoding *encoding
,gint line_pos
,gint column_pos
,gboolean create
);
Load a document. This results in the "load" signal to be emitted.
doc |
the GeditDocument. |
|
location |
the location where to load the document from. |
|
encoding |
the GeditEncoding to encode the document, or |
[allow-none] |
line_pos |
the line to show. |
|
column_pos |
the column to show. |
|
create |
whether the document should be created if it doesn't exist. |
gboolean
gedit_document_load_cancel (GeditDocument *doc
);
Cancel load of a document.
void gedit_document_save (GeditDocument *doc
,GeditDocumentSaveFlags flags
);
Save the document to its previous location. This results in the "save" signal to be emitted.
void gedit_document_save_as (GeditDocument *doc
,GFile *location
,const GeditEncoding *encoding
,GeditDocumentNewlineType newline_type
,GeditDocumentCompressionType compression_type
,GeditDocumentSaveFlags flags
);
Save the document to a new location. This results in the "save" signal to be emitted.
doc |
the GeditDocument. |
|
location |
the location where to save the document. |
|
encoding |
the GeditEncoding to encode the document. |
|
newline_type |
the GeditDocumentNewlineType for the document. |
|
flags |
optionnal GeditDocumentSaveFlags. |
void gedit_document_set_search_text (GeditDocument *doc
,const gchar *text
,guint flags
);
gedit_document_set_search_text
has been deprecated since version 3.10 and should not be used in newly-written code.
Use the search and replace API of GtkSourceView instead.
gchar * gedit_document_get_search_text (GeditDocument *doc
,guint *flags
);
gedit_document_get_search_text
has been deprecated since version 3.10 and should not be used in newly-written code.
Use the search and replace API of GtkSourceView instead.
gboolean
gedit_document_get_can_search_again (GeditDocument *doc
);
gedit_document_get_can_search_again
has been deprecated since version 3.10 and should not be used in newly-written code.
Use the search and replace API of GtkSourceView instead.
gboolean gedit_document_search_forward (GeditDocument *doc
,const GtkTextIter *start
,const GtkTextIter *end
,GtkTextIter *match_start
,GtkTextIter *match_end
);
gedit_document_search_forward
has been deprecated since version 3.10 and should not be used in newly-written code.
Use the search and replace API of GtkSourceView instead.
start |
. |
[allow-none] |
end |
. |
[allow-none] |
match_start |
. |
[allow-none] |
match_end |
. |
[allow-none] |
gboolean gedit_document_search_backward (GeditDocument *doc
,const GtkTextIter *start
,const GtkTextIter *end
,GtkTextIter *match_start
,GtkTextIter *match_end
);
gedit_document_search_backward
has been deprecated since version 3.10 and should not be used in newly-written code.
Use the search and replace API of GtkSourceView instead.
start |
. |
[allow-none] |
end |
. |
[allow-none] |
match_start |
. |
[allow-none] |
match_end |
. |
[allow-none] |
gint gedit_document_replace_all (GeditDocument *doc
,const gchar *find
,const gchar *replace
,guint flags
);
gedit_document_replace_all
has been deprecated since version 3.10 and should not be used in newly-written code.
Use the search and replace API of GtkSourceView instead.
void gedit_document_set_language (GeditDocument *doc
,GtkSourceLanguage *lang
);
void gedit_document_set_enable_search_highlighting (GeditDocument *doc
,gboolean enable
);
gedit_document_set_enable_search_highlighting
has been deprecated since version 3.10 and should not be used in newly-written code.
Use the search and replace API of GtkSourceView instead.
gboolean
gedit_document_get_enable_search_highlighting
(GeditDocument *doc
);
gedit_document_get_enable_search_highlighting
has been deprecated since version 3.10 and should not be used in newly-written code.
Use the search and replace API of GtkSourceView instead.
#define GEDIT_SEARCH_IS_DONT_SET_FLAGS(sflags) ((sflags & GEDIT_SEARCH_DONT_SET_FLAGS) != 0)
#define GEDIT_SEARCH_IS_ENTIRE_WORD(sflags) ((sflags & GEDIT_SEARCH_ENTIRE_WORD) != 0)
#define GEDIT_SEARCH_IS_CASE_SENSITIVE(sflags) ((sflags & GEDIT_SEARCH_CASE_SENSITIVE) != 0)
GeditSearchFlags
has been deprecated since version 3.10 and should not be used in newly-written code.
Use the search and replace API in GtkSourceBuffer.
“can-search-again”
property“can-search-again” gboolean
Wheter it's possible to search again in the document.
GeditDocument:can-search-again
has been deprecated since version 3.10 and should not be used in newly-written code.
Use the search and replace API of GtkSourceView instead.
Flags: Read
Default value: FALSE
“compression-type”
property “compression-type” GeditDocumentCompressionType
The :compression-type property determines how to compress the document when saving
Flags: Read / Write / Construct
Default value: GEDIT_DOCUMENT_COMPRESSION_TYPE_NONE
“content-type”
property“content-type” gchar *
The document's Content Type.
Flags: Read / Write
Default value: NULL
“empty-search”
property“empty-search” gboolean
Flags: Read
Default value: TRUE
“enable-search-highlighting”
property“enable-search-highlighting” gboolean
Whether all the occurences of the searched string must be highlighted.
GeditDocument:enable-search-highlighting
has been deprecated since version 3.10 and should not be used in newly-written code.
Use the search and replace API of GtkSourceView instead.
Flags: Read / Write
Default value: FALSE
“encoding”
property“encoding” GeditEncoding *
The GeditEncoding used for the document.
Flags: Read
“mime-type”
property“mime-type” gchar *
The document's MIME Type.
Flags: Read
Default value: "text/plain"
“newline-type”
property “newline-type” GeditDocumentNewlineType
The :newline-type property determines what is considered as a line ending when saving the document
Flags: Read / Write / Construct
Default value: GEDIT_DOCUMENT_NEWLINE_TYPE_LF
“read-only”
property“read-only” gboolean
Whether the document is read only or not.
Flags: Read
Default value: FALSE
“shortname”
property“shortname” gchar *
The document's short name.
Flags: Read / Write
Default value: NULL
“cursor-moved”
signalvoid user_function (GeditDocument *geditdocument, gpointer user_data)
Flags: Run Last
“load”
signalvoid user_function (GeditDocument *document, GFile *location, GeditEncoding *encoding, gint line_pos, gint column_pos, gpointer user_data)
The "load" signal is emitted when a document is loaded.
document |
the GeditDocument. |
|
location |
the location where to load the document from. |
|
encoding |
the GeditEncoding to encode the document. |
|
line_pos |
the line to show. |
|
column_pos |
the column to show. |
|
create |
whether the document should be created if it doesn't exist. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since 2.22
“loaded”
signalvoid user_function (GeditDocument *geditdocument, GError *arg1, gpointer user_data)
Flags: Run Last
“loading”
signalvoid user_function (GeditDocument *geditdocument, guint64 arg1, guint64 arg2, gpointer user_data)
Flags: Run Last
“save”
signalvoid user_function (GeditDocument *document, GFile *location, GeditEncoding *encoding, GeditDocumentNewlineType newline_type, GeditDocumentCompressionType compression_type, GeditDocumentSaveFlags flags, gpointer user_data)
The "save" signal is emitted when the document is saved.
document |
the GeditDocument. |
|
location |
the location where the document is about to be saved. |
|
encoding |
the GeditEncoding used to save the document. |
|
newline_type |
the GeditDocumentNewlineType used to save the document. |
|
compression_type |
the GeditDocumentCompressionType used to save the document. |
|
flags |
the GeditDocumentSaveFlags for the save operation. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since 2.20
“saved”
signalvoid user_function (GeditDocument *geditdocument, GError *arg1, gpointer user_data)
Flags: Run Last
“saving”
signalvoid user_function (GeditDocument *geditdocument, guint64 arg1, guint64 arg2, gpointer user_data)
Flags: Run Last
“search-highlight-updated”
signalvoid user_function (GeditDocument *document, GtkTextIter *start, GtkTextIter *end, gpointer user_data)
GeditDocument::search-highlight-updated
has been deprecated since version 3.10 and should not be used in newly-written code.
Use the “highlight-updated” signal instead.
Flags: Run Last