#include <CommonControls.hpp>

Inherits FW::Window::Listener.

Classes
class	StateObject

Public Types
enum	Feature { Feature_CloseOnEsc = 1 << 0, Feature_CloseOnAltF4 = 1 << 1, Feature_RepaintOnF5 = 1 << 2, Feature_ShowFPSOnF9 = 1 << 3, Feature_HideControlsOnF10 = 1 << 4, Feature_FullScreenOnF11 = 1 << 5, Feature_ScreenshotOnPrtScn = 1 << 6, Feature_LoadStateOnNum = 1 << 7, Feature_SaveStateOnAltNum = 1 << 8, Feature_None = 0, Feature_All = (1 << 9) - 1, Feature_Default = Feature_All }

Public Member Functions
	CommonControls (U32 features=Feature_Default)

virtual	~CommonControls (void)

virtual bool	handleEvent (const Window::Event &ev)

void	message (const String &str, const String &volatileID="", U32 abgr=0xffffffffu)

void	addToggle (bool target, const String &key, const String &title, bool dirtyNotify=NULL)

void	addToggle (S32 target, S32 value, const String &key, const String &title, bool dirtyNotify=NULL)

void	addButton (bool target, const String &key, const String &title, bool dirtyNotify=NULL)

void	addButton (S32 target, S32 value, const String &key, const String &title, bool dirtyNotify=NULL)

void	addSeparator (void)

void	setControlVisibility (bool visible)

void	addSlider (F32 target, F32 minValue, F32 maxValue, bool isExponential, const String &increaseKey, const String &decreaseKey, const String &format, F32 speed=0.25f, bool dirtyNotify=NULL)

void	addSlider (S32 target, S32 minValue, S32 maxValue, bool isExponential, const String &increaseKey, const String &decreaseKey, const String &format, F32 speed=0.0f, bool dirtyNotify=NULL)

void	beginSliderStack (void)

void	endSliderStack (void)

void	removeControl (const void *target)

void	resetControls (void)

void	setStateFilePrefix (const String &prefix)

void	setScreenshotFilePrefix (const String &prefix)

String	getStateFileName (int idx) const

String	getScreenshotFileName (void) const

void	addStateObject (StateObject *obj)

void	removeStateObject (StateObject *obj)

bool	loadState (const String &fileName)

bool	saveState (const String &fileName)

bool	loadStateDialog (void)

bool	saveStateDialog (void)

void	showControls (bool show)

void	showFPS (bool show)

bool	getShowControls (void) const

bool	getShowFPS (void) const

F32	getKeyBoost (void) const

void	flashButtonTitles (void)

Public Member Functions inherited from FW::Window::Listener
	Listener (void)

virtual	~Listener (void)

Detailed Description

Definition at line 42 of file CommonControls.hpp.

Member Enumeration Documentation

enum FW::CommonControls::Feature

Enumerator
Feature_CloseOnEsc
Feature_CloseOnAltF4
Feature_RepaintOnF5
Feature_ShowFPSOnF9
Feature_HideControlsOnF10
Feature_FullScreenOnF11
Feature_ScreenshotOnPrtScn
Feature_LoadStateOnNum
Feature_SaveStateOnAltNum
Feature_None
Feature_All
Feature_Default

Definition at line 48 of file CommonControls.hpp.

Constructor & Destructor Documentation

CommonControls::CommonControls ( U32 features = Feature_Default )

Definition at line 46 of file CommonControls.cpp.

CommonControls::~CommonControls ( void )

virtual

Definition at line 90 of file CommonControls.cpp.

Member Function Documentation

void FW::CommonControls::addButton	(	bool *	target,
		const String &	key,
		const String &	title,
		bool *	dirtyNotify = `NULL`
	)

inline

Definition at line 158 of file CommonControls.hpp.

void FW::CommonControls::addButton	(	S32 *	target,
		S32	value,
		const String &	key,
		const String &	title,
		bool *	dirtyNotify = `NULL`
	)

inline

Definition at line 159 of file CommonControls.hpp.

void FW::CommonControls::addSeparator ( void )

inline

Definition at line 160 of file CommonControls.hpp.

void FW::CommonControls::addSlider	(	F32 *	target,
		F32	minValue,
		F32	maxValue,
		bool	isExponential,
		const String &	increaseKey,
		const String &	decreaseKey,
		const String &	format,
		F32	speed = `0.25f`,
		bool *	dirtyNotify = `NULL`
	)

inline

Definition at line 163 of file CommonControls.hpp.

void FW::CommonControls::addSlider	(	S32 *	target,
		S32	minValue,
		S32	maxValue,
		bool	isExponential,
		const String &	increaseKey,
		const String &	decreaseKey,
		const String &	format,
		F32	speed = `0.0f`,
		bool *	dirtyNotify = `NULL`
	)

inline

Definition at line 164 of file CommonControls.hpp.

void FW::CommonControls::addStateObject ( StateObject * obj )

inline

Definition at line 176 of file CommonControls.hpp.

void FW::CommonControls::addToggle	(	bool *	target,
		const String &	key,
		const String &	title,
		bool *	dirtyNotify = `NULL`
	)

inline

Definition at line 156 of file CommonControls.hpp.

void FW::CommonControls::addToggle	(	S32 *	target,
		S32	value,
		const String &	key,
		const String &	title,
		bool *	dirtyNotify = `NULL`
	)

inline

Definition at line 157 of file CommonControls.hpp.

void FW::CommonControls::beginSliderStack ( void )

inline

Definition at line 165 of file CommonControls.hpp.

void FW::CommonControls::endSliderStack ( void )

inline

Definition at line 166 of file CommonControls.hpp.

void CommonControls::flashButtonTitles ( void )

Definition at line 461 of file CommonControls.cpp.

F32 CommonControls::getKeyBoost ( void ) const

Definition at line 446 of file CommonControls.cpp.

String CommonControls::getScreenshotFileName ( void ) const

Definition at line 335 of file CommonControls.cpp.

bool FW::CommonControls::getShowControls ( void ) const

inline

Definition at line 185 of file CommonControls.hpp.

bool FW::CommonControls::getShowFPS ( void ) const

inline

Definition at line 186 of file CommonControls.hpp.

String FW::CommonControls::getStateFileName ( int idx ) const

inline

Definition at line 173 of file CommonControls.hpp.

bool CommonControls::handleEvent ( const Window::Event & ev )

virtual

Implements FW::Window::Listener.

Definition at line 97 of file CommonControls.cpp.

bool CommonControls::loadState ( const String & fileName )

Definition at line 352 of file CommonControls.cpp.

bool CommonControls::loadStateDialog ( void )

Definition at line 388 of file CommonControls.cpp.

void CommonControls::message	(	const String &	str,
		const String &	volatileID = `""`,
		U32	abgr = `0xffffffffu`
	)

Definition at line 258 of file CommonControls.cpp.

void CommonControls::removeControl ( const void * target )

Definition at line 284 of file CommonControls.cpp.

void FW::CommonControls::removeStateObject ( StateObject * obj )

inline

Definition at line 177 of file CommonControls.hpp.

void CommonControls::resetControls ( void )

Definition at line 315 of file CommonControls.cpp.

bool CommonControls::saveState ( const String & fileName )

Definition at line 416 of file CommonControls.cpp.

bool CommonControls::saveStateDialog ( void )

Definition at line 402 of file CommonControls.cpp.

void FW::CommonControls::setControlVisibility ( bool visible )

inline

Definition at line 161 of file CommonControls.hpp.

void FW::CommonControls::setScreenshotFilePrefix ( const String & prefix )

inline

Definition at line 172 of file CommonControls.hpp.

void FW::CommonControls::setStateFilePrefix ( const String & prefix )

inline

Definition at line 171 of file CommonControls.hpp.

void FW::CommonControls::showControls ( bool show )

inline

Definition at line 183 of file CommonControls.hpp.

void FW::CommonControls::showFPS ( bool show )

inline

Definition at line 184 of file CommonControls.hpp.

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

src/framework/gui/CommonControls.hpp
src/framework/gui/CommonControls.cpp

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation