KTextEditor::Variable Class Reference

#include <variable.h>

Public Types
using	ExpandFunction = QString(*)(const QStringView &text, KTextEditor::View *view)

Public Member Functions
	Variable (const QString &name, const QString &description, ExpandFunction expansionFunc)
QString	description () const
QString	evaluate (const QStringView &prefix, KTextEditor::View *view) const
bool	isValid () const
QString	name () const

Detailed Description

Variable for variable expansion.

Introduction

A Variable is used by the KTextEditor::Editor to expand variables, also know as expanding macros. A Variable itself is defined by the variable name() as well as a description() and a function that replaces the variable by its value.

To register a Variable in the Editor use either Editor::registerVariableMatch() or Editor::registerPrefixMatch().

See also

KTextEditor::Editor, KTextEditor::Editor::registerVariableMatch(), KTextEditor::Editor::registerPrefixMatch()

Author

Dominik Haumann <dhaum.nosp@m.ann@.nosp@m.kde.o.nosp@m.rg>

Definition at line 47 of file variable.h.

Member Typedef Documentation

using KTextEditor::Variable::ExpandFunction = QString (*)(const QStringView& text, KTextEditor::View* view)

Function that is called to expand a variable in text.

Parameters

text

Definition at line 54 of file variable.h.

Constructor & Destructor Documentation

KTextEditor::Variable::Variable	(	const QString &	name,
		const QString &	description,
		Variable::ExpandFunction	func
	)

Constructor defining a Variable by its name, its description, and its function expansionFunc to expand a variable to its corresponding value.

Note

The name should not be translated.

Definition at line 24 of file variable.cpp.

Member Function Documentation

QString KTextEditor::Variable::description

(

)

const

Returns the description that was provided in the constructor.

Definition at line 40 of file variable.cpp.

QString KTextEditor::Variable::evaluate	(	const QStringView &	prefix,
		KTextEditor::View *	view
	)		const

Expands the Variable to its value.

As example for an exact match, a variable "CurerntDocument:Cursor:Line" uses the view to return the current line of the text cursor. In this case prefix equals the text of the variable itself, i.e. "CurerntDocument:Cursor:Line".

As example of a prefix match, a variable "ENV:value" expands the environment value value, e.g. "ENV:HOME". In this case, the prefix equals the text "ENV:HOME" and view would be unused.

Returns

the expanded variable.

Definition at line 45 of file variable.cpp.

bool KTextEditor::Variable::isValid

(

)

const

Returns true, if the name is non-empty and the function provided in the constructor is not a nullptr.

Definition at line 30 of file variable.cpp.

QString KTextEditor::Variable::name

(

)

const

Returns the name that was provided in the constructor.

Depending on where the Variable is registered, this name is used to identify an exact match or a prefix match.

Definition at line 35 of file variable.cpp.

---

The documentation for this class was generated from the following files:

• variable.h
• variable.cpp