KDECore
KCharMacroExpander Class Reference
Abstract base class for single char macro substitutors. More...
#include <KMacroExpanderBase>
Inheritance diagram for KCharMacroExpander:

Public Member Functions | |
KCharMacroExpander (QChar c=QLatin1Char('%')) | |
Protected Member Functions | |
virtual int | expandEscapedMacro (const QString &str, int pos, QStringList &ret) |
virtual bool | expandMacro (QChar chr, QStringList &ret)=0 |
virtual int | expandPlainMacro (const QString &str, int pos, QStringList &ret) |
Detailed Description
Abstract base class for single char macro substitutors.Use this instead of the functions in the KMacroExpander namespace if speculatively pre-filling the substitution map would be too expensive.
See KWordMacroExpander for a sample application.
Definition at line 253 of file kmacroexpander.h.
Constructor & Destructor Documentation
KCharMacroExpander::KCharMacroExpander | ( | QChar | c = QLatin1Char('%') |
) | [inline, explicit] |
Constructor.
- Parameters:
-
c escape char indicating start of macros, or QChar::null for none
Definition at line 260 of file kmacroexpander.h.
Member Function Documentation
int KCharMacroExpander::expandEscapedMacro | ( | const QString & | str, | |
int | pos, | |||
QStringList & | ret | |||
) | [protected, virtual] |
For internal use only.
Not to be called or reimplemented.
Reimplemented from KMacroExpanderBase.
Definition at line 254 of file kmacroexpander.cpp.
virtual bool KCharMacroExpander::expandMacro | ( | QChar | chr, | |
QStringList & | ret | |||
) | [protected, pure virtual] |
Return substitution list ret
for single-character macro chr
.
- Parameters:
-
chr the macro to expand ret return variable reference. It is guaranteed to be empty when expandMacro is entered.
- Returns:
true
iffchr
was a recognized macro name
int KCharMacroExpander::expandPlainMacro | ( | const QString & | str, | |
int | pos, | |||
QStringList & | ret | |||
) | [protected, virtual] |
For internal use only.
Not to be called or reimplemented.
Reimplemented from KMacroExpanderBase.
Definition at line 246 of file kmacroexpander.cpp.
The documentation for this class was generated from the following files: