KMacroExpander Namespace Reference

Detailed Description

A group of functions providing macro expansion (substitution) in strings, optionally with quoting appropriate for shell execution.

Since:
3.1.3


Enumerations

enum  Quoting {
  noquote, singlequote, doublequote, dollarquote,
  paren, subst, group, math
}

Functions

QString expandMacros (const QString &ostr, const QMap< QChar, QString > &map, QChar c)
QString expandMacrosShellQuote (const QString &ostr, const QMap< QChar, QString > &map, QChar c)

Enumeration Type Documentation

enum KMacroExpander::Quoting
 

Internal use only. Quoting state of the expander code. Not available publicly.

Definition at line 85 of file kmacroexpander.cpp.

Function Documentation

QString KMacroExpander::expandMacros (  const QString &  str,
const QMap< QChar, QString > &  map,
QChar  c = '%'
) 
 

Perform safe macro expansion (substitution) on a string.

The escape char must be quoted with itself to obtain its literal representation in the resulting string.

Parameters:
str The string to expand
map map with substitutions
c escape char indicating start of macro, or QChar::null if none
Returns:
the string with all valid macros expanded
 // Code example
 QMap<QChar,QString> map;
 map.insert('u', "/tmp/myfile.txt");
 map.insert('n', "My File");
 QString s = "%% Title: %u:%n";
 s = KMacroExpander::expandMacros(s, map);
 // s is now "% Title: /tmp/myfile.txt:My File";

Definition at line 520 of file kmacroexpander.cpp.

QString KMacroExpander::expandMacrosShellQuote (  const QString &  str,
const QMap< QChar, QString > &  map,
QChar  c = '%'
) 
 

Perform safe macro expansion (substitution) on a string for use in shell commands.

The escape char must be quoted with itself to obtain its literal representation in the resulting string.

Parameters:
str The string to expand
map map with substitutions
c escape char indicating start of macro, or QChar::null if none
Returns:
the string with all valid macros expanded, or a null string if a shell syntax error was detected in the command
 // Code example
 QMap<QChar,QString> map;
 map.insert('u', "/tmp/myfile.txt");
 map.insert('n', "My File");
 QString s = "kedit --caption %n %u";
 s = KMacroExpander::expandMacrosShellQuote(s, map);
 // s is now "kedit --caption 'My File' '/tmp/myfile.txt'";
 system(QFile::encodeName(s));

Definition at line 521 of file kmacroexpander.cpp.

kdecore

API Dox
KDE Home | KDE Accessibility Home | Description of Access Keys