KTextEditor
KTextEditor::VariableInterface Class Reference
[Document Extension Interfaces]
#include <variableinterface.h>
Detailed Description
Variable/Modeline extension interface for the Document.
Introduction
The VariableInterface is designed to provide access to so called "document variables" (also called modelines), for example variables defined in files like "kate: variable value;" or the emacs style "-*- variable: value -*-".The idea is to allow KTextEditor plugins and applications to use document variables. A document implementing this interface should return values for variables that it does not otherwise know how to use, since they could be of interest for plugins. A Document implementing this interface must emit the signal variableChanged() whenever a variable/value pair was set, changed or removed.
- Note:
- Implementations should check the document variables whenever the document was saved or loaded.
Accessing the VariableInterface
The VariableInterface is an extension interface for a Document, i.e. the Document inherits the interface provided that the used KTextEditor library implements the interface. Use qobject_cast to access the interface:// doc is of type KTextEditor::Document* KTextEditor::VariableInterface *iface = qobject_cast<KTextEditor::VariableInterface*>( doc ); if( iface ) { // the implementation supports the interface // do stuff }
- See also:
- KTextEditor::Document, KTextEditor::Plugin
Definition at line 76 of file variableinterface.h.
Public Member Functions | |
virtual QString | variable (const QString &name) const =0 |
virtual void | variableChanged (Document *document, const QString &variable, const QString &value)=0 |
VariableInterface () | |
virtual | ~VariableInterface () |
Constructor & Destructor Documentation
VariableInterface::VariableInterface | ( | ) |
Definition at line 327 of file ktexteditor.cpp.
VariableInterface::~VariableInterface | ( | ) | [virtual] |
Member Function Documentation
virtual QString KTextEditor::VariableInterface::variable | ( | const QString & | name | ) | const [pure virtual] |
Get the value of the variable name
.
- Returns:
- the value or an empty string if the variable is not set or has no value.
virtual void KTextEditor::VariableInterface::variableChanged | ( | Document * | document, | |
const QString & | variable, | |||
const QString & | value | |||
) | [pure virtual] |
The document
emits this signal whenever the value
of the variable
changed, this includes when a variable was initially set.
- Parameters:
-
document document that emitted the signal variable variable that changed value new value for variable
- See also:
- variable()
The documentation for this class was generated from the following files: