pqPythonMacroSettings is a class to handle macro settings like names and tooltips. More...

Public Types
enum	MacroItemCategories { MacroItemCategories::ToolTip, MacroItemCategories::Name, MacroItemCategories::Unused }

Public Member Functions
	pqPythonMacroSettings (MacroItemCategories currentCategory)

void	setItemInSettings (const QString &macroPath, const QString &value)
	Fill setting for macroPath with value under the current category. More...

QString	getItemFromSettings (const QString &macroPath)
	Return value for macroPath from the settings under the current category. More...

QMap< QString, QString >	getItemSettings ()
	Get a map of {macroPath: value} from the given settings under the current category. More...

void	writeItemSettings (const QMap< QString, QString > &settingsMap)
	Write the given map to the settings under the current category. More...

void	removeItemFromSettings (const QString &macroPath)
	Remove the given macroPath and its associated value from the settings under the current category. More...

Detailed Description

pqPythonMacroSettings is a class to handle macro settings like names and tooltips.

Definition at line 16 of file pqPythonMacroSettings.h.

Member Enumeration Documentation

strong

Definition at line 19 of file pqPythonMacroSettings.h.

pqPythonMacroSettings::pqPythonMacroSettings ( MacroItemCategories currentCategory )

explicit

void pqPythonMacroSettings::setItemInSettings	(	const QString &	macroPath,
		const QString &	value
	)

Fill setting for macroPath with value under the current category.

QString pqPythonMacroSettings::getItemFromSettings ( const QString & macroPath )

Return value for macroPath from the settings under the current category.

QMap<QString, QString> pqPythonMacroSettings::getItemSettings ( )

Get a map of {macroPath: value} from the given settings under the current category.

void pqPythonMacroSettings::writeItemSettings ( const QMap< QString, QString > & settingsMap )

Write the given map to the settings under the current category.

Map is expected to be at format {macroPath: value} Previous settings are erased under the current category.

void pqPythonMacroSettings::removeItemFromSettings ( const QString & macroPath )

Remove the given macroPath and its associated value from the settings under the current category.

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