/usr/include/ktexteditor/variableinterface.h is in kdelibs5-dev 4:4.13.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 | /*
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
---
Copyright (C) 2004, Anders Lund <anders@alweb.dk>
Copyright (C) 2005 Dominik Haumann (dhdev@gmx.de) (documentation)
*/
#ifndef _KTEXTEDITOR_VARIABLE_INTERFACE_H_
#define _KTEXTEDITOR_VARIABLE_INTERFACE_H_
#include <ktexteditor/ktexteditor_export.h>
#include <QtCore/QObject>
class QString;
namespace KTextEditor {
class Document;
/**
* \brief Variable/Modeline extension interface for the Document.
*
* \ingroup kte_group_doc_extensions
*
* \section variface_intro 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.
*
* \section variface_access Accessing the VariableInterface
*
* The VariableInterface is an extension interface for a
* Document, i.e. the Document inherits the interface \e provided that the
* used KTextEditor library implements the interface. Use qobject_cast to
* access the interface:
* \code
* // doc is of type KTextEditor::Document*
* KTextEditor::VariableInterface *iface =
* qobject_cast<KTextEditor::VariableInterface*>( doc );
*
* if( iface ) {
* // the implementation supports the interface
* // do stuff
* }
* \endcode
*
* \see KTextEditor::Document, KTextEditor::Plugin
* \author Anders Lund \<anders@alweb.dk\>
*/
class KTEXTEDITOR_EXPORT VariableInterface
{
public:
VariableInterface();
/**
* Virtual destructor.
*/
virtual ~VariableInterface();
/**
* Get the value of the variable \p name.
* \return the value or an empty string if the variable is not set or has
* no value.
*/
virtual QString variable( const QString &name ) const = 0;
//
// signals!!
//
public:
/**
* The \p document emits this signal whenever the \p value of the
* \p variable changed, this includes when a variable was initially set.
* \param document document that emitted the signal
* \param variable variable that changed
* \param value new value for \e variable
* \see variable()
*/
virtual void variableChanged( Document* document, const QString &variable, const QString &value ) = 0;
private:
class VariableInterfacePrivate* const d;
};
} // namespace KTextEditor
Q_DECLARE_INTERFACE(KTextEditor::VariableInterface, "org.kde.KTextEditor.VariableInterface")
#endif
// kate: space-indent on; indent-width 2; replace-tabs on;
|