doom3-gpl: idUserInterface Class Reference

doom3-gpl

Doom 3 GPL source release

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages

#include <UserInterface.h>

Inheritance diagram for idUserInterface:

Public Member Functions
virtual	~idUserInterface ()

virtual const char *	Name () const =0

virtual const char *	Comment () const =0

virtual bool	IsInteractive () const =0

virtual bool	IsUniqued () const =0

virtual void	SetUniqued (bool b)=0

virtual bool	InitFromFile (const char *qpath, bool rebuild=true, bool cache=true)=0

virtual const char *	HandleEvent (const sysEvent_t event, int time, bool updateVisuals=NULL)=0

virtual void	HandleNamedEvent (const char *eventName)=0

virtual void	Redraw (int time)=0

virtual void	DrawCursor ()=0

virtual const idDict &	State () const =0

virtual void	DeleteStateVar (const char *varName)=0

virtual void	SetStateString (const char varName, const char value)=0

virtual void	SetStateBool (const char *varName, const bool value)=0

virtual void	SetStateInt (const char *varName, const int value)=0

virtual void	SetStateFloat (const char *varName, const float value)=0

virtual const char *	GetStateString (const char varName, const char defaultString="") const =0

virtual bool	GetStateBool (const char varName, const char defaultString="0") const =0

virtual int	GetStateInt (const char varName, const char defaultString="0") const =0

virtual float	GetStateFloat (const char varName, const char defaultString="0") const =0

virtual void	StateChanged (int time, bool redraw=false)=0

virtual const char *	Activate (bool activate, int time)=0

virtual void	Trigger (int time)=0

virtual void	ReadFromDemoFile (class idDemoFile *f)=0

virtual void	WriteToDemoFile (class idDemoFile *f)=0

virtual bool	WriteToSaveGame (idFile *savefile) const =0

virtual bool	ReadFromSaveGame (idFile *savefile)=0

virtual void	SetKeyBindingNames (void)=0

virtual void	SetCursor (float x, float y)=0

virtual float	CursorX ()=0

virtual float	CursorY ()=0

Detailed Description

Definition at line 45 of file UserInterface.h.

Constructor & Destructor Documentation

virtual idUserInterface::~idUserInterface ( )

inlinevirtual

Definition at line 47 of file UserInterface.h.

Member Function Documentation

virtual const char* idUserInterface::Activate	(	bool	activate,
		int	time
	)

pure virtual

Implemented in idUserInterfaceLocal.

virtual const char* idUserInterface::Comment ( ) const

pure virtual

Implemented in idUserInterfaceLocal.

virtual float idUserInterface::CursorX ( )

pure virtual

Implemented in idUserInterfaceLocal.

virtual float idUserInterface::CursorY ( )

pure virtual

Implemented in idUserInterfaceLocal.

virtual void idUserInterface::DeleteStateVar ( const char * varName )

pure virtual

Implemented in idUserInterfaceLocal.

virtual void idUserInterface::DrawCursor ( )

pure virtual

Implemented in idUserInterfaceLocal.

virtual bool idUserInterface::GetStateBool	(	const char *	varName,
		const char *	defaultString = `"0"`
	)		const

pure virtual

Implemented in idUserInterfaceLocal.

virtual float idUserInterface::GetStateFloat	(	const char *	varName,
		const char *	defaultString = `"0"`
	)		const

pure virtual

Implemented in idUserInterfaceLocal.

virtual int idUserInterface::GetStateInt	(	const char *	varName,
		const char *	defaultString = `"0"`
	)		const

pure virtual

Implemented in idUserInterfaceLocal.

virtual const char* idUserInterface::GetStateString	(	const char *	varName,
		const char *	defaultString = `""`
	)		const

pure virtual

Implemented in idUserInterfaceLocal.

virtual const char* idUserInterface::HandleEvent	(	const sysEvent_t *	event,
		int	time,
		bool *	updateVisuals = `NULL`
	)

pure virtual

Implemented in idUserInterfaceLocal.

virtual void idUserInterface::HandleNamedEvent ( const char * eventName )

pure virtual

Implemented in idUserInterfaceLocal.

virtual bool idUserInterface::InitFromFile	(	const char *	qpath,
		bool	rebuild = `true`,
		bool	cache = `true`
	)

pure virtual

Implemented in idUserInterfaceLocal.

virtual bool idUserInterface::IsInteractive ( ) const

pure virtual

Implemented in idUserInterfaceLocal.

virtual bool idUserInterface::IsUniqued ( ) const

pure virtual

Implemented in idUserInterfaceLocal.

virtual const char* idUserInterface::Name ( ) const

pure virtual

Implemented in idUserInterfaceLocal.

virtual void idUserInterface::ReadFromDemoFile ( class idDemoFile * f )

pure virtual

Implemented in idUserInterfaceLocal.

virtual bool idUserInterface::ReadFromSaveGame ( idFile * savefile )

pure virtual

Implemented in idUserInterfaceLocal.

virtual void idUserInterface::Redraw ( int time )

pure virtual

Implemented in idUserInterfaceLocal.

virtual void idUserInterface::SetCursor	(	float	x,
		float	y
	)

pure virtual

Implemented in idUserInterfaceLocal.

virtual void idUserInterface::SetKeyBindingNames ( void )

pure virtual

Implemented in idUserInterfaceLocal.

virtual void idUserInterface::SetStateBool	(	const char *	varName,
		const bool	value
	)

pure virtual

Implemented in idUserInterfaceLocal.

virtual void idUserInterface::SetStateFloat	(	const char *	varName,
		const float	value
	)

pure virtual

Implemented in idUserInterfaceLocal.

virtual void idUserInterface::SetStateInt	(	const char *	varName,
		const int	value
	)

pure virtual

Implemented in idUserInterfaceLocal.

virtual void idUserInterface::SetStateString	(	const char *	varName,
		const char *	value
	)

pure virtual

Implemented in idUserInterfaceLocal.

virtual void idUserInterface::SetUniqued ( bool b )

pure virtual

Implemented in idUserInterfaceLocal.

virtual const idDict& idUserInterface::State ( ) const

pure virtual

Implemented in idUserInterfaceLocal.

virtual void idUserInterface::StateChanged	(	int	time,
		bool	redraw = `false`
	)

pure virtual

Implemented in idUserInterfaceLocal.

virtual void idUserInterface::Trigger ( int time )

pure virtual

Implemented in idUserInterfaceLocal.

virtual void idUserInterface::WriteToDemoFile ( class idDemoFile * f )

pure virtual

Implemented in idUserInterfaceLocal.

virtual bool idUserInterface::WriteToSaveGame ( idFile * savefile ) const

pure virtual

Implemented in idUserInterfaceLocal.

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

neo/ui/UserInterface.h