KCharMacroExpander Class Reference

#include <KMacroExpanderBase>

Inheritance diagram for KCharMacroExpander:

Public Member Functions
	KCharMacroExpander (QChar c=QLatin1Char('%'))
Public Member Functions inherited from KMacroExpanderBase
	KMacroExpanderBase (QChar c=QLatin1Char('%'))
virtual	~KMacroExpanderBase ()
QChar	escapeChar () const
void	expandMacros (QString &str)
bool	expandMacrosShellQuote (QString &str)
bool	expandMacrosShellQuote (QString &str, int &pos)
void	setEscapeChar (QChar c)

Protected Member Functions
int	expandEscapedMacro (const QString &str, int pos, QStringList &ret) override
virtual bool	expandMacro (QChar chr, QStringList &ret)=0
int	expandPlainMacro (const QString &str, int pos, QStringList &ret) override

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.

Author

Oswald Buddenhagen ossi@.nosp@m.kde..nosp@m.org

Definition at line 246 of file kmacroexpander.h.

Constructor & Destructor Documentation

KCharMacroExpander()

KCharMacroExpander::KCharMacroExpander ( QChar c = QLatin1Char('%') )

inlineexplicit

Constructor.

Parameters

c	escape char indicating start of macros, or QChar::null for none

Definition at line 253 of file kmacroexpander.h.

Member Function Documentation

expandEscapedMacro()

int KCharMacroExpander::expandEscapedMacro ( const QString & str, int pos, QStringList & ret )

overrideprotectedvirtual

Not to be called or reimplemented.

Reimplemented from KMacroExpanderBase.

Definition at line 250 of file kmacroexpander.cpp.

expandMacro()

virtual bool KCharMacroExpander::expandMacro ( QChar chr, QStringList & ret )

protectedpure 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 iff chr was a recognized macro name

expandPlainMacro()

int KCharMacroExpander::expandPlainMacro ( const QString & str, int pos, QStringList & ret )

overrideprotectedvirtual

Not to be called or reimplemented.

Reimplemented from KMacroExpanderBase.

Definition at line 242 of file kmacroexpander.cpp.

---

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

• kmacroexpander.h
• kmacroexpander.cpp