Geany Plugin API Documentation

Author

Enrico Tröger, Nick Treleaven, Frank Lanitz, Matthew Brush

Intro

This is the Geany API documentation. It should be considered work in progress. We will try to document as many functions and structs as possible.

Warning

Do not use any symbol not in the documentation - it may change.

Except for exceptions stated in the documentation for geany_load_module(), no API function may be called if the plugin is not enabled (between the calls to their GeanyFuncs::init and GeanyFuncs::cleanup functions).

Plugin Support

• Plugin HowTo - get started
• Proxy Plugin HowTo
• Plugin Extension HowTo
• Porting guide from legacy entry points to the current ones
• Plugin Datatypes and Macros
• Plugin Signals
• Plugin Utility Functions
• Plugin Writing Guidelines
• plugins/demoplugin.c - in Geany's source, bigger than the howto example

Common API files

• dialogs.h
• document.h
• editor.h
• filetypes.h
• keybindings.h
• msgwindow.h
• pluginextension.h
• project.h
• Scintilla Wrapper Functions
• Spawning programs
• Stash Pref/Setting Functions
• General Utility Functions
• Widget Utility Functions

More

• All API functions and types - see Files link at the top
• Deprecated symbols - see Related Pages link at the top

Note

See the HACKING file for information about developing the plugin API and other useful notes.