GeanyData Struct Reference

This contains pointers to global variables owned by Geany for plugins to use. More...

#include <plugindata.h>

Collaboration diagram for GeanyData:

Public Attributes
struct GeanyApp *	app
	Geany application data fields. More...
struct GeanyMainWidgets *	main_widgets
	Important widgets in the main window. More...
GPtrArray *	documents_array
	Dynamic array of GeanyDocument pointers. More...
GPtrArray *	filetypes_array
	Dynamic array of filetype pointers. More...
struct GeanyPrefs *	prefs
	General settings. More...
struct GeanyInterfacePrefs *	interface_prefs
	Interface settings. More...
struct GeanyToolbarPrefs *	toolbar_prefs
	Toolbar settings. More...
struct GeanyEditorPrefs *	editor_prefs
	Editor settings. More...
struct GeanyFilePrefs *	file_prefs
	File-related settings. More...
struct GeanySearchPrefs *	search_prefs
	Search-related settings. More...
struct GeanyToolPrefs *	tool_prefs
	Tool settings. More...
struct GeanyTemplatePrefs *	template_prefs
	Template settings. More...
gpointer *	_compat
GSList *	filetypes_by_title
	List of filetype pointers sorted by name, but with filetypes_index(GEANY_FILETYPES_NONE) first, as this is usually treated specially. More...
GObject *	object

Detailed Description

This contains pointers to global variables owned by Geany for plugins to use.

Core variable pointers can be appended when needed by plugin authors, if appropriate.

Definition at line 166 of file plugindata.h.

Member Data Documentation

_compat

gpointer* GeanyData::_compat

Definition at line 206 of file plugindata.h.

app

struct GeanyApp* GeanyData::app

Geany application data fields.

Definition at line 168 of file plugindata.h.

documents_array

GPtrArray* GeanyData::documents_array

Dynamic array of GeanyDocument pointers.

Once a pointer is added to this, it is never freed. This means the same document pointer can represent a different document later on, or it may have been closed and become invalid. For this reason, you should use document_find_by_id() instead of storing document pointers over time if there is a chance the user can close the document.

Warning

You must check GeanyDocument::is_valid when iterating over this array. This is done automatically if you use the foreach_document() macro.

Note

Never assume that the order of document pointers is the same as the order of notebook tabs. One reason is that notebook tabs can be reordered. Use document_get_from_page() to lookup a document from a notebook tab number.

See also

documents.

(element-type: GeanyDocument)

Definition at line 189 of file plugindata.h.

editor_prefs

struct GeanyEditorPrefs* GeanyData::editor_prefs

Editor settings.

Definition at line 201 of file plugindata.h.

file_prefs

struct GeanyFilePrefs* GeanyData::file_prefs

File-related settings.

Definition at line 202 of file plugindata.h.

filetypes_array

GPtrArray* GeanyData::filetypes_array

Dynamic array of filetype pointers.

List the list is dynamically expanded for custom filetypes filetypes so don't expect the list of known filetypes to be a constant.

(element-type: GeanyFiletype)

Definition at line 197 of file plugindata.h.

filetypes_by_title

GSList* GeanyData::filetypes_by_title

List of filetype pointers sorted by name, but with filetypes_index(GEANY_FILETYPES_NONE) first, as this is usually treated specially.

The list does not change (after filetypes have been initialized), so you can use

g_slist_nth_data(filetypes_by_title, n) 

and expect the same result at different times.

See also

filetypes_get_sorted_by_name().

(element-type: GeanyFiletype)

Definition at line 215 of file plugindata.h.

interface_prefs

struct GeanyInterfacePrefs* GeanyData::interface_prefs

Interface settings.

Definition at line 199 of file plugindata.h.

main_widgets

struct GeanyMainWidgets* GeanyData::main_widgets

Important widgets in the main window.

Definition at line 169 of file plugindata.h.

Referenced by demo_init(), item_activate(), on_editor_notify(), on_unsplit(), plugin_init(), proxy_help(), proxy_init(), and split_view().

object

GObject* GeanyData::object

Definition at line 221 of file plugindata.h.

prefs

struct GeanyPrefs* GeanyData::prefs

General settings.

Definition at line 198 of file plugindata.h.

search_prefs

struct GeanySearchPrefs* GeanyData::search_prefs

Search-related settings.

Definition at line 203 of file plugindata.h.

template_prefs

struct GeanyTemplatePrefs* GeanyData::template_prefs

Template settings.

Definition at line 205 of file plugindata.h.

tool_prefs

struct GeanyToolPrefs* GeanyData::tool_prefs

Tool settings.

Definition at line 204 of file plugindata.h.

toolbar_prefs

struct GeanyToolbarPrefs* GeanyData::toolbar_prefs

Toolbar settings.

Definition at line 200 of file plugindata.h.

---

The documentation for this struct was generated from the following file:

• src/plugindata.h