![]() |
![]() |
![]() |
gedit Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties | Signals |
enum GeditSearchFlags; GeditDocumentPrivate; GeditDocument; enum GeditDocumentSaveFlags; #define GEDIT_DOCUMENT_ERROR GQuark gedit_document_error_quark (void); GeditDocument * gedit_document_new (void); gchar * gedit_document_get_uri (GeditDocument *doc); gchar * gedit_document_get_uri_for_display (GeditDocument *doc); gchar * gedit_document_get_short_name_for_display (GeditDocument *doc); gchar * gedit_document_get_mime_type (GeditDocument *doc); gboolean gedit_document_get_readonly (GeditDocument *doc); void gedit_document_load (GeditDocument *doc, const gchar *uri, const GeditEncoding *encoding, gint line_pos, gboolean create); gboolean gedit_document_insert_file (GeditDocument *doc, GtkTextIter *iter, const gchar *uri, const GeditEncoding *encoding); gboolean gedit_document_load_cancel (GeditDocument *doc); void gedit_document_save (GeditDocument *doc, GeditDocumentSaveFlags flags); void gedit_document_save_as (GeditDocument *doc, const gchar *uri, const GeditEncoding *encoding, 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); void gedit_document_set_search_text (GeditDocument *doc, const gchar *text, guint flags); gchar * gedit_document_get_search_text (GeditDocument *doc, guint *flags); gboolean gedit_document_get_can_search_again (GeditDocument *doc); gboolean gedit_document_search_forward (GeditDocument *doc, const GtkTextIter *start, const GtkTextIter *end, GtkTextIter *match_start, GtkTextIter *match_end); gboolean gedit_document_search_backward (GeditDocument *doc, const GtkTextIter *start, const GtkTextIter *end, GtkTextIter *match_start, GtkTextIter *match_end); gint gedit_document_replace_all (GeditDocument *doc, const gchar *find, const gchar *replace, guint flags); void gedit_document_set_language (GeditDocument *doc, GtkSourceLanguage *lang); void gedit_document_set_enable_search_highlighting (GeditDocument *doc, gboolean enable); gboolean gedit_document_get_enable_search_highlighting (GeditDocument *doc); #define GEDIT_SEARCH_IS_DONT_SET_FLAGS (sflags) #define GEDIT_SEARCH_SET_DONT_SET_FLAGS (sflags,state) #define GEDIT_SEARCH_IS_ENTIRE_WORD (sflags) #define GEDIT_SEARCH_SET_ENTIRE_WORD (sflags,state) #define GEDIT_SEARCH_IS_CASE_SENSITIVE (sflags) #define GEDIT_SEARCH_SET_CASE_SENSITIVE (sflags,state)
"can-search-again" gboolean : Read "enable-search-highlighting" gboolean : Read / Write "encoding" GeditEncoding* : Read "mime-type" gchar* : Read "read-only" gboolean : Read "shortname" gchar* : Read "uri" gchar* : Read
"cursor-moved" : Run Last "load" : Run Last "loaded" : Run Last "loading" : Run Last "save" : Run Last "saved" : Run Last "saving" : Run Last "search-highlight-updated" : Run Last
typedef enum { GEDIT_SEARCH_DONT_SET_FLAGS = 1 << 0, GEDIT_SEARCH_ENTIRE_WORD = 1 << 1, GEDIT_SEARCH_CASE_SENSITIVE = 1 << 2 } GeditSearchFlags;
typedef enum { GEDIT_DOCUMENT_SAVE_IGNORE_MTIME = 1 << 0, GEDIT_DOCUMENT_SAVE_IGNORE_BACKUP = 1 << 1, GEDIT_DOCUMENT_SAVE_PRESERVE_BACKUP = 1 << 2 } GeditDocumentSaveFlags;
gchar * gedit_document_get_uri_for_display (GeditDocument *doc);
|
|
Returns : |
gchar * gedit_document_get_short_name_for_display (GeditDocument *doc);
|
|
Returns : |
gchar * gedit_document_get_mime_type (GeditDocument *doc);
|
|
Returns : |
gboolean gedit_document_get_readonly (GeditDocument *doc);
|
|
Returns : |
void gedit_document_load (GeditDocument *doc, const gchar *uri, const GeditEncoding *encoding, gint line_pos, gboolean create);
Load a document. This results in the "load" signal to be emitted.
|
the GeditDocument. |
|
the uri where to load the document from. |
|
the GeditEncoding to encode the document. |
|
the line to show. |
|
whether the document should be created if it doesn't exist. |
gboolean gedit_document_insert_file (GeditDocument *doc, GtkTextIter *iter, const gchar *uri, const GeditEncoding *encoding);
|
|
|
|
|
|
|
|
Returns : |
gboolean gedit_document_load_cancel (GeditDocument *doc);
Cancel load of a document.
|
the GeditDocument. |
Returns : |
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, const gchar *uri, const GeditEncoding *encoding, GeditDocumentSaveFlags flags);
Save the document to a new location. This results in the "save" signal to be emitted.
|
the GeditDocument. |
|
the uri where to save the document. |
|
the GeditEncoding to encode the document. |
|
optionnal GeditDocumentSaveFlags. |
gboolean gedit_document_is_untouched (GeditDocument *doc);
|
|
Returns : |
gboolean gedit_document_is_untitled (GeditDocument *doc);
|
|
Returns : |
gboolean gedit_document_get_deleted (GeditDocument *doc);
|
|
Returns : |
gboolean gedit_document_goto_line (GeditDocument *doc, gint line);
|
|
|
|
Returns : |
void gedit_document_set_search_text (GeditDocument *doc, const gchar *text, guint flags);
|
|
|
|
|
gchar * gedit_document_get_search_text (GeditDocument *doc, guint *flags);
|
|
|
|
Returns : |
gboolean gedit_document_get_can_search_again (GeditDocument *doc);
|
|
Returns : |
gboolean gedit_document_search_forward (GeditDocument *doc, const GtkTextIter *start, const GtkTextIter *end, GtkTextIter *match_start, GtkTextIter *match_end);
|
|
|
|
|
|
|
|
|
|
Returns : |
gboolean gedit_document_search_backward (GeditDocument *doc, const GtkTextIter *start, const GtkTextIter *end, GtkTextIter *match_start, GtkTextIter *match_end);
|
|
|
|
|
|
|
|
|
|
Returns : |
gint gedit_document_replace_all (GeditDocument *doc, const gchar *find, const gchar *replace, guint flags);
|
|
|
|
|
|
|
|
Returns : |
void gedit_document_set_language (GeditDocument *doc, GtkSourceLanguage *lang);
|
|
|
void gedit_document_set_enable_search_highlighting (GeditDocument *doc, gboolean enable);
|
|
|
gboolean gedit_document_get_enable_search_highlighting (GeditDocument *doc);
|
|
Returns : |
#define GEDIT_SEARCH_IS_DONT_SET_FLAGS(sflags) ((sflags & GEDIT_SEARCH_DONT_SET_FLAGS) != 0)
|
#define GEDIT_SEARCH_SET_DONT_SET_FLAGS(sflags,state)
|
|
|
#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)
|
"can-search-again"
property"can-search-again" gboolean : Read
Wheter it's possible to search again in the document.
Default value: FALSE
"enable-search-highlighting"
property"enable-search-highlighting" gboolean : Read / Write
Whether all the occurences of the searched string must be highlighted.
Default value: FALSE
"mime-type"
property"mime-type" gchar* : Read
The document's MIME Type.
Default value: "text/plain"
"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
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"load"
signalvoid user_function (GeditDocument *document, gchar *uri, GeditEncoding *encoding, gint line_pos, gboolean create, gpointer user_data) : Run Last
The "load" signal is emitted when a document is loaded.
|
the GeditDocument. |
|
the uri where to load the document from. |
|
the GeditEncoding to encode the document. |
|
the line 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, gpointer arg1, gpointer user_data) : Run Last
|
the object which received the signal. |
|
|
|
user data set when the signal handler was connected. |
"loading"
signalvoid user_function (GeditDocument *geditdocument, guint64 arg1, guint64 arg2, gpointer user_data) : Run Last
|
the object which received the signal. |
|
|
|
|
|
user data set when the signal handler was connected. |
"save"
signalvoid user_function (GeditDocument *document, gchar *uri, GeditEncoding *encoding, GeditDocumentSaveFlags flags, gpointer user_data) : Run Last
The "save" signal is emitted when the document is saved.
|
the GeditDocument. |
|
the uri where the document is about to be saved. |
|
the GeditEncoding 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, gpointer arg1, gpointer user_data) : Run Last
|
the object which received the signal. |
|
|
|
user data set when the signal handler was connected. |
"saving"
signalvoid user_function (GeditDocument *geditdocument, guint64 arg1, guint64 arg2, gpointer user_data) : Run Last
|
the object which received the signal. |
|
|
|
|
|
user data set when the signal handler was connected. |
"search-highlight-updated"
signalvoid user_function (GeditDocument *geditdocument, GtkTextIter *arg1, GtkTextIter *arg2, gpointer user_data) : Run Last
|
the object which received the signal. |
|
|
|
|
|
user data set when the signal handler was connected. |