KDE 4.3 PyKDE API Reference

• KDE's Python API

• Overview
• PyKDE Home
• Sitemap
• Contact Us

 

KWordMacroExpander Class Reference

from PyKDE4.kdecore import *

Inherits: KMacroExpanderBase

Detailed Description

Abstract class:

This class can be used as a base class for new classes, but can not be instantiated directly.

Methods
	__init__ (self, QChar c=QLatin1Char('%'))
	__init__ (self, KWordMacroExpander other)
int	expandEscapedMacro (self, QString str, int pos, QStringList ret)
bool	expandMacro (self, QString str, QStringList ret)
int	expandPlainMacro (self, QString str, int pos, QStringList ret)

---

Method Documentation

__init__	(	self,
		QChar	c=QLatin1Char('%')
	)

Constructor.

Parameters:

c

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

__init__	(	self,
		KWordMacroExpander	other
	)

int expandEscapedMacro	(	self,
		QString	str,
		int	pos,
		QStringList	ret
	)

Internal:

Not to be called or reimplemented.

bool expandMacro	(	self,
		QString	str,
		QStringList	ret
	)

Abstract method:

This method is abstract and can be overridden but not called directly.

Return substitution list ret for string macro str.

Parameters:

	str	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

int expandPlainMacro	(	self,
		QString	str,
		int	pos,
		QStringList	ret
	)

Internal:

Not to be called or reimplemented.

• Full Index

Modules

• akonadi
• dnssd
• kdecore
• kdeui
• khtml
• kio
• knewstuff
• kparts
• kutils
• nepomuk
• phonon
• plasma
• polkitqt
• solid
• soprano

This documentation is maintained by Simon Edwards.
KDE^® and the K Desktop Environment^® logo are registered trademarks of KDE e.V. | Legal