KCharMacroExpander

Search for usage in LXR

KCharMacroExpander Class Referenceabstract

#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
 
- Protected Member Functions inherited from KMacroExpanderBase

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
cescape 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
chrthe macro to expand
retreturn 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:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Oct 11 2024 12:17:55 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.