KTextEditor
KTextEditor::Plugin Class Reference
#include <plugin.h>

Detailed Description
KTextEditor Plugin interface.Topics:
Introduction
The Plugin class provides methods to create loadable plugins for all KTextEditor implementations. A plugin can handle several documents and views. For every document the plugin should handle addDocument() is called and for every view addView().Configuration Management
- Todo:
- write docu about config pages
- Todo:
- write docu about save/load settings
Session Management
As an extension a Plugin can implement the SessionConfigInterface. This interface provides functions to read and write session related settings. If you have session dependent data additionally derive your Plugin from this interface and implement the session related functions, for example:class MyPlugin : public KTextEditor::Plugin, public KTextEditor::SessionConfigInterface { Q_OBJECT Q_INTERFACES(KTextEditor::SessionConfigInterface) // ... virtual void readSessionConfig (KConfig *config); virtual void writeSessionConfig (KConfig *config); };
Plugin Architecture
After the plugin is loaded the editor implementation should first call readConfig() with a given KConfig object. After this it will call addDocument() and addView() for all documents and views the plugin should handle. If your plugin has a GUI it is common to add an extra class, like:class PluginView : public QObject, public KXMLGUIClient { Q_OBJECT public: // Constructor and other methods PluginView( KTextEditor::View* view ) : QObject( view ), KXMLGUIClient( view ), m_view( view ) { ... } // ... private: KTextEditor::View* m_view; };
The method removeView() will be called whenever a View is removed/closed. If you have a PluginView for every view this is the place to remove it.
- See also:
- KTextEditor::Editor, KTextEditor::Document, KTextEditor::View, KTextEditor::SessionConfigInterface
Definition at line 106 of file plugin.h.
Public Member Functions | |
virtual void | addDocument (Document *document) |
virtual void | addView (View *view) |
Plugin (QObject *parent) | |
virtual void | removeDocument (Document *document) |
virtual void | removeView (View *view) |
virtual | ~Plugin () |
Constructor & Destructor Documentation
Plugin::Plugin | ( | QObject * | parent | ) |
Constructor.
Create a new plugin.
- Parameters:
-
parent parent object
Definition at line 265 of file ktexteditor.cpp.
Plugin::~Plugin | ( | ) | [virtual] |
Member Function Documentation
virtual void KTextEditor::Plugin::addDocument | ( | Document * | document | ) | [inline, virtual] |
Add a new document
to the plugin.
This method is called whenever the plugin should handle another document
.
For every call of addDocument() will finally follow a call of removeDocument(), i.e. the number of calls are identic.
- Parameters:
-
document new document to handle
- See also:
- removeDocument(), addView()
virtual void KTextEditor::Plugin::addView | ( | View * | view | ) | [inline, virtual] |
This method is called whenever the plugin should add its GUI to view
.
The process for the Editor can be roughly described as follows:
- add documents the plugin should handle via addDocument()
- for every document doc call addView() for every view for doc.
For every call of addView() will finally follow a call of removeView(), i.e. the number of calls are identic.
- Note:
- As addView() is called for every view in which the plugin's GUI should be visible you must not add the the GUI by iterating over all Document::views() yourself neither use the signal Document::viewCreated().
- Parameters:
-
view view to hang the gui in
- See also:
- removeView(), addDocument()
virtual void KTextEditor::Plugin::removeDocument | ( | Document * | document | ) | [inline, virtual] |
Remove the document
from the plugin.
This method is called whenever the plugin should stop handling the document
.
For every call of addDocument() will finally follow a call of removeDocument(), i.e. the number of calls are identic.
- Parameters:
-
document document to hang the gui out from
- See also:
- addDocument(), removeView()
virtual void KTextEditor::Plugin::removeView | ( | View * | view | ) | [inline, virtual] |
This method is called whenever the plugin should remove its GUI from view
.
For every call of addView() will finally follow a call of removeView(), i.e. the number of calls are identic.
- Parameters:
-
view view to hang the gui out from
- See also:
- addView(), removeDocument()
The documentation for this class was generated from the following files: