Preferences::Integer Class Reference

#include <preferences.h>

Class Description

This class holds a simple integer preference.

This class can be used by a plugin to declare a single integer preference. The object should be declared as a global variable or as a static member variable. If a valid name is given to the object it will autoatically appear in the preferences dialog, and its value will be automatically saved and restored when mudbox quits/restarts. Example:

Preferences::Integer g_iMaxlevel( "Maximum level", "Render", 4 );

Definition at line 334 of file preferences.h.

Public Member Functions
	Integer (const QString &sName, const QString &sCategory, const QString &sNameTr, const QString &sCategoryTr, unsigned int iDefaultValue, bool bVisible=true)
	operator unsigned int (void) const

Public Attributes
aint *	m_pAttribute

Constructor & Destructor Documentation

Integer	(	const QString &	sName,
		const QString &	sCategory,
		const QString &	sNameTr,
		const QString &	sCategoryTr,
		unsigned int	iDefaultValue,
		bool	bVisible = true
	)

Parameters

sName	Name of the item, which will appear in the preferences dialog.
sCategory	Category of the item, which it belongs to in the preferences dialog. This can be an empty string.
sNameTr	Name of the item, which will appear in the preferences dialog.
sCategoryTr	Category of the item, which it belongs to in the preferences dialog. This can be an empty string.
iDefaultValue	Default value of the item. This is only used the first time when the preference is used, in other cases the value of the preferences will be restored from the general mudbox preference file.
bVisible	Visibility of the item in the preferences dialog.

Member Function Documentation

operator unsigned int

(

void

)

const

Member Data Documentation

aint* m_pAttribute

Definition at line 346 of file preferences.h.

---

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

• Mudbox/preferences.h