Top | Description | Object Hierarchy | Properties | Signals | ![]() |
![]() |
![]() |
![]() |
GeditDocumentPrivate; struct GeditDocument; enum GeditDocumentSaveFlags; enum GeditDocumentNewlineType; #define GEDIT_DOCUMENT_NEWLINE_TYPE_DEFAULT enum GeditDocumentCompressionType; #define GEDIT_DOCUMENT_ERROR GQuark gedit_document_error_quark (void
); GeditDocument * gedit_document_new (void
); GFile * gedit_document_get_location (GeditDocument *doc
); void gedit_document_set_location (GeditDocument *doc
,GFile *location
); gchar * gedit_document_get_uri_for_display (GeditDocument *doc
); gchar * gedit_document_get_short_name_for_display (GeditDocument *doc
); void gedit_document_set_short_name_for_display (GeditDocument *doc
,const gchar *short_name
); gchar * gedit_document_get_mime_type (GeditDocument *doc
); gboolean gedit_document_get_readonly (GeditDocument *doc
); gboolean gedit_document_is_local (GeditDocument *doc
); void gedit_document_load (GeditDocument *doc
,GFile *location
,const GeditEncoding *encoding
,gint line_pos
,gint column_pos
,gboolean create
); void gedit_document_load_stream (GeditDocument *doc
,GInputStream *stream
,const GeditEncoding *encoding
,gint line_pos
,gint column_pos
); gboolean gedit_document_load_cancel (GeditDocument *doc
); void gedit_document_save (GeditDocument *doc
,GeditDocumentSaveFlags flags
); void gedit_document_save_as (GeditDocument *doc
,GFile *location
,const GeditEncoding *encoding
,GeditDocumentNewlineType newline_type
,GeditDocumentCompressionType compression_type
,GeditDocumentSaveFlags flags
); gboolean gedit_document_is_untouched (GeditDocument *doc
); gboolean gedit_document_is_untitled (GeditDocument *doc
); gboolean gedit_document_get_deleted (GeditDocument *doc
); gboolean gedit_document_goto_line (GeditDocument *doc
,gint line
); gboolean gedit_document_goto_line_offset (GeditDocument *doc
,gint line
,gint line_offset
); void gedit_document_set_language (GeditDocument *doc
,GtkSourceLanguage *lang
); GeditDocumentNewlineType gedit_document_get_newline_type (GeditDocument *doc
); GeditDocumentCompressionType gedit_document_get_compression_type (GeditDocument *doc
); gchar * gedit_document_get_content_type (GeditDocument *doc
); void gedit_document_set_content_type (GeditDocument *doc
,const gchar *content_type
); gchar * gedit_document_get_metadata (GeditDocument *doc
,const gchar *key
); void gedit_document_set_metadata (GeditDocument *doc
,const gchar *first_key
,...
); void gedit_document_set_search_context (GeditDocument *doc
,GtkSourceSearchContext *search_context
); GtkSourceSearchContext * gedit_document_get_search_context (GeditDocument *doc
);
"compression-type" GeditDocumentCompressionType : Read / Write / Construct "content-type" gchar* : Read / Write "empty-search" gboolean : Read "encoding" GeditEncoding* : Read "location" GFile* : Read / Write "mime-type" gchar* : Read "newline-type" GeditDocumentNewlineType : Read / Write / Construct "read-only" gboolean : Read "shortname" gchar* : Read / Write
"cursor-moved" :Run Last
"load" :Run Last
"loaded" :Run Last
"loading" :Run Last
"save" :Run Last
"saved" :Run Last
"saving" :Run Last
typedef enum { GEDIT_DOCUMENT_SAVE_IGNORE_MTIME = 1 << 0, GEDIT_DOCUMENT_SAVE_IGNORE_BACKUP = 1 << 1, GEDIT_DOCUMENT_SAVE_PRESERVE_BACKUP = 1 << 2, GEDIT_DOCUMENT_SAVE_IGNORE_INVALID_CHARS= 1 << 3 } GeditDocumentSaveFlags;
save file despite external modifications. | |
write the file directly without attempting to backup. | |
preserve previous backup file, needed to support autosaving. | |
do not save invalid characters. |
typedef enum { GEDIT_DOCUMENT_NEWLINE_TYPE_LF, GEDIT_DOCUMENT_NEWLINE_TYPE_CR, GEDIT_DOCUMENT_NEWLINE_TYPE_CR_LF } GeditDocumentNewlineType;
#define GEDIT_DOCUMENT_NEWLINE_TYPE_DEFAULT GEDIT_DOCUMENT_NEWLINE_TYPE_CR_LF
typedef enum { GEDIT_DOCUMENT_COMPRESSION_TYPE_NONE, GEDIT_DOCUMENT_COMPRESSION_TYPE_GZIP } GeditDocumentCompressionType;
GFile * gedit_document_get_location (GeditDocument *doc
);
|
a GeditDocument |
Returns : |
a copy of the internal GFile. [allow-none][transfer full] |
void gedit_document_set_location (GeditDocument *doc
,GFile *location
);
gchar * gedit_document_get_uri_for_display (GeditDocument *doc
);
Note: this never returns NULL
.
|
a GeditDocument. |
gchar * gedit_document_get_short_name_for_display
(GeditDocument *doc
);
Note: this never returns NULL
.
|
a GeditDocument. |
void gedit_document_set_short_name_for_display (GeditDocument *doc
,const gchar *short_name
);
|
. [allow-none] |
gchar * gedit_document_get_mime_type (GeditDocument *doc
);
Note: this never returns NULL
.
|
a GeditDocument. |
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.
|
the GeditDocument. |
|
the location where to load the document from. |
|
the GeditEncoding to encode the document, or NULL . [allow-none]
|
|
the line to show. |
|
the column to show. |
|
whether the document should be created if it doesn't exist. |
void gedit_document_load_stream (GeditDocument *doc
,GInputStream *stream
,const GeditEncoding *encoding
,gint line_pos
,gint column_pos
);
|
. [allow-none] |
gboolean gedit_document_load_cancel (GeditDocument *doc
);
Cancel load of a document.
|
the GeditDocument. |
void gedit_document_save (GeditDocument *doc
,GeditDocumentSaveFlags flags
);
Save the document to its previous location. This results in the "save" signal to be emitted.
|
the GeditDocument. |
|
optionnal GeditDocumentSaveFlags. |
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.
|
the GeditDocument. |
|
the location where to save the document. |
|
the GeditEncoding to encode the document. |
|
the GeditDocumentNewlineType for the document. |
|
the compression type for the file. |
|
optionnal GeditDocumentSaveFlags. |
gboolean gedit_document_goto_line_offset (GeditDocument *doc
,gint line
,gint line_offset
);
void gedit_document_set_language (GeditDocument *doc
,GtkSourceLanguage *lang
);
|
. [allow-none] |
GeditDocumentNewlineType gedit_document_get_newline_type
(GeditDocument *doc
);
GeditDocumentCompressionType gedit_document_get_compression_type
(GeditDocument *doc
);
void gedit_document_set_content_type (GeditDocument *doc
,const gchar *content_type
);
|
. [allow-none] |
gchar * gedit_document_get_metadata (GeditDocument *doc
,const gchar *key
);
Gets the metadata assigned to key
.
|
a GeditDocument |
|
name of the key |
Returns : |
the value assigned to key . |
void gedit_document_set_metadata (GeditDocument *doc
,const gchar *first_key
,...
);
Sets metadata on a document.
|
a GeditDocument |
|
name of the first key to set |
|
value for the first key, followed optionally by more key/value pairs,
followed by NULL . [allow-none]
|
void gedit_document_set_search_context (GeditDocument *doc
,GtkSourceSearchContext *search_context
);
Sets the new search context for the document. Use this function only when the search occurrences are highlighted. So this function should not be used for background searches. The purpose is to have only one highlighted search context at a time in the document.
After using this function, you should unref the search_context
. The doc
should be the only owner of the search_context
, so that the Clear Highlight
action works. If you need the search_context
after calling this function,
use gedit_document_get_search_context()
.
|
a GeditDocument |
|
the new GtkSourceSearchContext. [allow-none] |
GtkSourceSearchContext * gedit_document_get_search_context
(GeditDocument *doc
);
Gets the search context. Use this function only if you have used
gedit_document_set_search_context()
before. You should not alter other search
contexts, so you have to verify that the returned search context is yours.
One way to verify that is to compare the search settings object, or to mark
the search context with g_object_set_data()
.
|
a GeditDocument |
Returns : |
the current search context of the document, or NULL if there is no current search context. [transfer none] |
"compression-type"
property"compression-type" GeditDocumentCompressionType : Read / Write / Construct
The :compression-type property determines how to compress the document when saving
Default value: GEDIT_DOCUMENT_COMPRESSION_TYPE_NONE
"content-type"
property "content-type" gchar* : Read / Write
The document's Content Type.
Default value: NULL
"empty-search"
property "empty-search" gboolean : Read
Default value: TRUE
"mime-type"
property "mime-type" gchar* : Read
The document's MIME Type.
Default value: "text/plain"
"newline-type"
property"newline-type" GeditDocumentNewlineType : Read / Write / Construct
The :newline-type property determines what is considered as a line ending when saving the document
Default value: GEDIT_DOCUMENT_NEWLINE_TYPE_LF
"read-only"
property "read-only" gboolean : Read
Whether the document is read only or not.
Default value: FALSE
"cursor-moved"
signalvoid user_function (GeditDocument *geditdocument,
gpointer user_data) : Run Last
"load"
signalvoid user_function (GeditDocument *document,
GFile *location,
GeditEncoding *encoding,
gint line_pos,
gint column_pos,
gpointer user_data) : Run Last
The "load" signal is emitted when a document is loaded.
|
the GeditDocument. |
|
the location where to load the document from. |
|
the GeditEncoding to encode the document. |
|
the line to show. |
|
the column to show. |
|
whether the document should be created if it doesn't exist. |
|
user data set when the signal handler was connected. |
Since 2.22
"loaded"
signalvoid user_function (GeditDocument *geditdocument,
GError *arg1,
gpointer user_data) : Run Last
"loading"
signalvoid user_function (GeditDocument *geditdocument,
guint64 arg1,
guint64 arg2,
gpointer user_data) : Run Last
"save"
signalvoid user_function (GeditDocument *document,
GFile *location,
GeditEncoding *encoding,
GeditDocumentNewlineType newline_type,
GeditDocumentCompressionType compression_type,
GeditDocumentSaveFlags flags,
gpointer user_data) : Run Last
The "save" signal is emitted when the document is saved.
|
the GeditDocument. |
|
the location where the document is about to be saved. |
|
the GeditEncoding used to save the document. |
|
the GeditDocumentNewlineType used to save the document. |
|
the GeditDocumentCompressionType used to save the document. |
|
the GeditDocumentSaveFlags for the save operation. |
|
user data set when the signal handler was connected. |
Since 2.20
"saved"
signalvoid user_function (GeditDocument *geditdocument,
GError *arg1,
gpointer user_data) : Run Last
"saving"
signalvoid user_function (GeditDocument *geditdocument,
guint64 arg1,
guint64 arg2,
gpointer user_data) : Run Last