• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kdecore
 

kdecore

Public Member Functions | Protected Member Functions
KCharMacroExpander Class Reference

#include <kmacroexpander.h>

Inheritance diagram for KCharMacroExpander:
KMacroExpanderBase

List of all members.

Public Member Functions

 KCharMacroExpander (TQChar c= '%')

Protected Member Functions

virtual int expandPlainMacro (const TQString &str, uint pos, TQStringList &ret)
virtual int expandEscapedMacro (const TQString &str, uint pos, TQStringList &ret)
virtual bool expandMacro (TQChar chr, TQStringList &ret)=0

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.

Since:
3.3
Author:
Oswald Buddenhagen <ossi@kde.org>

Definition at line 224 of file kmacroexpander.h.


Constructor & Destructor Documentation

KCharMacroExpander::KCharMacroExpander ( TQChar  c = '%') [inline]

Constructor.

Parameters:
cescape char indicating start of macros, or TQChar::null for none

Definition at line 231 of file kmacroexpander.h.


Member Function Documentation

int KCharMacroExpander::expandEscapedMacro ( const TQString &  str,
uint  pos,
TQStringList &  ret 
) [protected, virtual]

This function is called every time the escape char is found if it is not TQChar::null.

It should determine whether the string starting at pos witin str is a valid macro and return the substitution value for it if so.

Parameters:
strthe input string
posthe offset within str. Note that this is the position of the occurrence of the escape char
retreturn value: the string to substitute for the macro
Returns:
if greater than zero, the number of chars at pos in str to substitute with ret (i.e., a valid macro was found). if less than zero, subtract this value from pos (to skip a macro, i.e., substitute it with itself). zero requests no special action.

Reimplemented from KMacroExpanderBase.

Definition at line 443 of file kmacroexpander.cpp.

virtual bool KCharMacroExpander::expandMacro ( TQChar  chr,
TQStringList &  ret 
) [protected, pure 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
int KCharMacroExpander::expandPlainMacro ( const TQString &  str,
uint  pos,
TQStringList &  ret 
) [protected, virtual]

This function is called for every single char within the string if the escape char is TQChar::null.

It should determine whether the string starting at pos within str is a valid macro and return the substitution value for it if so.

Parameters:
strthe input string
posthe offset within str
retreturn value: the string to substitute for the macro
Returns:
if greater than zero, the number of chars at pos in str to substitute with ret (i.e., a valid macro was found). if less than zero, subtract this value from pos (to skip a macro, i.e., substitute it with itself). zero requests no special action.

Reimplemented from KMacroExpanderBase.

Definition at line 435 of file kmacroexpander.cpp.


The documentation for this class was generated from the following files:
  • kmacroexpander.h
  • kmacroexpander.cpp

kdecore

Skip menu "kdecore"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdecore

Skip menu "kdecore"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for kdecore by doxygen 1.7.6.1
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |