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...
 
struct 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...
 
gint index
 Index in the documents array. More...
 
gboolean is_valid
 General flag to represent this document is active and all properties are set correctly. More...
 
gboolean readonly
 Whether this document is read-only. More...
 
gchar * real_path
 The link-dereferenced, locale-encoded file name. More...
 
TMWorkObjecttm_file
 TMWorkObject object for this document, or NULL. More...
 

Detailed Description

Structure for representing an open tab with all its properties.

Field Documentation

gboolean GeanyDocument::changed

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

struct GeanyEditor* GeanyDocument::editor

The editor associated with the document.

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.

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.
GeanyFiletype* GeanyDocument::file_type

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

gboolean GeanyDocument::has_bom

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

gboolean GeanyDocument::has_tags

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

gint GeanyDocument::index

Index in the documents array.

gboolean GeanyDocument::is_valid

General flag to represent this document is active and all properties are set correctly.

gboolean GeanyDocument::readonly

Whether this document is read-only.

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.
TMWorkObject* GeanyDocument::tm_file

TMWorkObject object for this document, or NULL.