Geany  dev
Data Fields
GeanyDocument Struct Reference

Structure for representing an open tab with all its properties. More...

Data Fields

gboolean changed
 Whether this document has been changed since it was last saved. More...
 
GeanyEditoreditor
 The editor associated with the document. More...
 
gchar * encoding
 The encoding of the document, must be a valid string representation of an encoding, can be retrieved with encodings_get_charset_from_index. More...
 
gchar * file_name
 The UTF-8 encoded file name. More...
 
GeanyFiletypefile_type
 The filetype for this document, it's only a reference to one of the elements of the global filetypes array. More...
 
gboolean has_bom
 Internally used flag to indicate whether the file of this document has a byte-order-mark. More...
 
gboolean has_tags
 Whether this document supports source code symbols(tags) to show in the sidebar. More...
 
guint id
 A pseudo-unique ID for this document. More...
 
gint index
 Index in the documents array. More...
 
gboolean is_valid
 Flag used to check if this document is valid when iterating GeanyData::documents_array. More...
 
gboolean readonly
 Whether this document is read-only. More...
 
gchar * real_path
 The link-dereferenced, locale-encoded file name. More...
 
TMSourceFiletm_file
 TMSourceFile object for this document, or NULL. More...
 

Detailed Description

Structure for representing an open tab with all its properties.

Field Documentation

◆ changed

gboolean GeanyDocument::changed

Whether this document has been changed since it was last saved.

◆ editor

GeanyEditor* GeanyDocument::editor

The editor associated with the document.

◆ encoding

gchar* GeanyDocument::encoding

The encoding of the document, must be a valid string representation of an encoding, can be retrieved with encodings_get_charset_from_index.

◆ file_name

gchar* GeanyDocument::file_name

The UTF-8 encoded file name.

Be careful; glibc and GLib file functions expect the locale representation of the file name which can be different from this. For conversion into locale encoding, you can use utils_get_locale_from_utf8().

See also
real_path.

◆ file_type

GeanyFiletype* GeanyDocument::file_type

The filetype for this document, it's only a reference to one of the elements of the global filetypes array.

◆ has_bom

gboolean GeanyDocument::has_bom

Internally used flag to indicate whether the file of this document has a byte-order-mark.

◆ has_tags

gboolean GeanyDocument::has_tags

Whether this document supports source code symbols(tags) to show in the sidebar.

◆ id

guint GeanyDocument::id

A pseudo-unique ID for this document.

0 is reserved as an unused value.

See also
document_find_by_id().

◆ index

gint GeanyDocument::index

Index in the documents array.

◆ is_valid

gboolean GeanyDocument::is_valid

Flag used to check if this document is valid when iterating GeanyData::documents_array.

◆ readonly

gboolean GeanyDocument::readonly

Whether this document is read-only.

◆ real_path

gchar* GeanyDocument::real_path

The link-dereferenced, locale-encoded file name.

If non-NULL, this indicates the file once existed on disk (not just as an unsaved document with a filename set).

Note
This is only assigned after a successful save or open - it should not be set elsewhere.
See also
file_name.

◆ tm_file

TMSourceFile* GeanyDocument::tm_file

TMSourceFile object for this document, or NULL.