Top | ![]() |
![]() |
![]() |
![]() |
void | ide_editor_addin_load () |
void | ide_editor_addin_unload () |
void | ide_editor_addin_page_set () |
IdeEditorAddin * | ide_editor_addin_find_by_module_name () |
The IdeEditorAddin interface provides a simplified interface for plugins that want to perform operations in, or extend, the editor surface.
This differs from the IdeWorkbenchAddin in that you are given access to the editor surface directly. This can be convenient if all you need to do is add panels or perform page tracking of the current focus page.
void ide_editor_addin_load (IdeEditorAddin *self
,IdeEditorSurface *surface
);
This method is called to load the addin.
The addin should add any necessary UI components.
Since: 3.32
void ide_editor_addin_unload (IdeEditorAddin *self
,IdeEditorSurface *surface
);
This method is called to unload the addin.
The addin is responsible for undoing anything it setup in load and cancel any in-flight or pending tasks immediately.
Since: 3.32
void ide_editor_addin_page_set (IdeEditorAddin *self
,IdePage *page
);
This function is called when the current page has changed in the editor surface. This could happen when the user focus another page, either with the keyboard, mouse, touch, or by opening a new buffer.
Note that page
may not be an IdeEditorView, so consumers of this
interface should take appropriate action based on the type.
When the last page is removed, page
will be NULL
to indicate to the
addin that there is no active page.
Since: 3.32
IdeEditorAddin * ide_editor_addin_find_by_module_name (IdeEditorSurface *editor
,const gchar *module_name
);
This function allows locating an IdeEditorAddin that is attached to the IdeEditorSurface by the addin module name. The module name should match the value specified in the ".plugin" module definition.
Since: 3.32