ScreenOptions Class Reference

#include <ScreenOptions.h>

Inheritance diagram for ScreenOptions:

[legend]Collaboration diagram for ScreenOptions:

[legend]List of all members.


Public Member Functions
	ScreenOptions (CString sClassName)
void	InitMenu (InputMode im, OptionRowData OptionRowData[], int iNumOptionLines)
virtual	~ScreenOptions ()
virtual void	Update (float fDeltaTime)
virtual void	DrawPrimitives ()
virtual void	Input (const DeviceInput &DeviceI, const InputEventType type, const GameInput &GameI, const MenuInput &MenuI, const StyleInput &StyleI)
virtual void	HandleScreenMessage (const ScreenMessage SM)
Protected Types
enum	Navigation { NAV_THREE_KEY, NAV_THREE_KEY_MENU, NAV_FIVE_KEY, NAV_TOGGLE_THREE_KEY, NAV_TOGGLE_FIVE_KEY }
Protected Member Functions
virtual void	ImportOptions ()=0
virtual void	ExportOptions ()=0
void	InitOptionsText ()
void	GetWidthXY (PlayerNumber pn, int iRow, int iChoiceOnRow, int &iWidthOut, int &iXOut, int &iYOut)
CString	GetExplanationText (int row) const
CString	GetExplanationTitle (int row) const
BitmapText &	GetTextItemForRow (PlayerNumber pn, int iRow, int iChoiceOnRow)
void	PositionUnderlines ()
void	PositionIcons ()
virtual void	RefreshIcons ()
void	PositionCursors ()
void	PositionItems ()
void	TweenCursor (PlayerNumber pn)
void	UpdateText (int row)
void	UpdateEnabledDisabled ()
virtual void	OnChange (PlayerNumber pn)
virtual void	MenuBack (PlayerNumber pn)
virtual void	MenuStart (PlayerNumber pn, const InputEventType type)
void	StartGoToNextScreen ()
virtual void	GoToNextScreen ()=0
virtual void	GoToPrevScreen ()=0
void	MenuLeft (PlayerNumber pn, const InputEventType type)
void	MenuRight (PlayerNumber pn, const InputEventType type)
void	ChangeValueInRow (PlayerNumber pn, int iDelta, bool Repeat)
void	MenuUp (PlayerNumber pn, const InputEventType type)
void	MenuDown (PlayerNumber pn, const InputEventType type)
void	MoveRow (PlayerNumber pn, int dir, bool Repeat)
int	GetCurrentRow (PlayerNumber pn=PLAYER_1) const
bool	AllAreOnExit () const
void	LoadOptionIcon (PlayerNumber pn, int iRow, CString sText)
void	SetNavigation (Navigation nav)
void	StoreFocus (PlayerNumber pn)
Protected Attributes
vector< Row * >	m_Rows
Navigation	m_OptionsNavigation
int	m_iCurrentRow [NUM_PLAYERS]
int	m_iFocusX [NUM_PLAYERS]
InputMode	m_InputMode
ActorFrame	m_framePage
AutoActor	m_sprPage
OptionsCursor	m_Highlight [NUM_PLAYERS]
Sprite	m_sprLineHighlight [NUM_PLAYERS]
BitmapText	m_textPlayerName [NUM_PLAYERS]
BitmapText	m_textExplanation [NUM_PLAYERS]
DualScrollBar	m_ScrollBar
AutoActor	m_sprMore
bool	m_bMoreShown
bool	m_bWasOnExit [NUM_PLAYERS]
AutoActor	m_sprDisqualify [NUM_PLAYERS]
bool	m_bGotAtLeastOneStartPressed [NUM_PLAYERS]
RageSound	m_SoundChangeCol
RageSound	m_SoundNextRow
RageSound	m_SoundPrevRow
RageSound	m_SoundToggleOn
RageSound	m_SoundToggleOff

Member Enumeration Documentation

enum ScreenOptions::Navigation [protected]

Enumeration values:

NAV_THREE_KEY

NAV_THREE_KEY_MENU

NAV_FIVE_KEY

NAV_TOGGLE_THREE_KEY

NAV_TOGGLE_FIVE_KEY

Constructor & Destructor Documentation

ScreenOptions::ScreenOptions ( CString sClassName )

ScreenOptions::~ScreenOptions ( ) [virtual]

Member Function Documentation

bool ScreenOptions::AllAreOnExit ( ) const [protected]

void ScreenOptions::ChangeValueInRow ( PlayerNumber pn,

int iDelta,

bool Repeat

) [protected]

void ScreenOptions::DrawPrimitives ( ) [virtual]

Reimplemented from ActorFrame.
Reimplemented in ScreenPlayerOptions.

virtual void ScreenOptions::ExportOptions ( ) [protected, pure virtual]

Implemented in ScreenNetworkOptions, ScreenOptionsMaster, ScreenProfileOptions, and ScreenSMOnlineLogin.

int ScreenOptions::GetCurrentRow ( PlayerNumber pn = PLAYER_1 ) const [protected]

CString ScreenOptions::GetExplanationText ( int row ) const [protected]

CString ScreenOptions::GetExplanationTitle ( int row ) const [protected]

BitmapText & ScreenOptions::GetTextItemForRow ( PlayerNumber pn,

int iRow,

int iChoiceOnRow

) [protected]

void ScreenOptions::GetWidthXY ( PlayerNumber pn,

int iRow,

int iChoiceOnRow,

int & iWidthOut,

int & iXOut,

int & iYOut

) [protected]

virtual void ScreenOptions::GoToNextScreen ( ) [protected, pure virtual]

Implemented in ScreenNetworkOptions, ScreenOptionsMaster, ScreenPlayerOptions, ScreenProfileOptions, ScreenSMOnlineLogin, and ScreenSongOptions.

virtual void ScreenOptions::GoToPrevScreen ( ) [protected, pure virtual]

Implemented in ScreenNetworkOptions, ScreenOptionsMaster, ScreenPlayerOptions, ScreenProfileOptions, ScreenSMOnlineLogin, and ScreenSongOptions.

void ScreenOptions::HandleScreenMessage ( const ScreenMessage SM ) [virtual]

Reimplemented from Screen.
Reimplemented in ScreenNetworkOptions, ScreenPlayerOptions, ScreenProfileOptions, and ScreenSMOnlineLogin.

virtual void ScreenOptions::ImportOptions ( ) [protected, pure virtual]

Implemented in ScreenNetworkOptions, ScreenOptionsMaster, ScreenProfileOptions, and ScreenSMOnlineLogin.

void ScreenOptions::InitMenu ( InputMode im,

OptionRowData OptionRowData[],

int iNumOptionLines

)

void ScreenOptions::InitOptionsText ( ) [protected]

void ScreenOptions::Input ( const DeviceInput & DeviceI,

const InputEventType type,

const GameInput & GameI,

const MenuInput & MenuI,

const StyleInput & StyleI

) [virtual]

Reimplemented from Screen.
Reimplemented in ScreenPlayerOptions.

void ScreenOptions::LoadOptionIcon ( PlayerNumber pn,

int iRow,

CString sText

) [protected]

void ScreenOptions::MenuBack ( PlayerNumber pn ) [protected, virtual]

Reimplemented from Screen.

void ScreenOptions::MenuDown ( PlayerNumber pn,

const InputEventType type

) [inline, protected, virtual]

Reimplemented from Screen.

void ScreenOptions::MenuLeft ( PlayerNumber pn,

const InputEventType type

) [inline, protected, virtual]

Reimplemented from Screen.

void ScreenOptions::MenuRight ( PlayerNumber pn,

const InputEventType type

) [inline, protected, virtual]

Reimplemented from Screen.

void ScreenOptions::MenuStart ( PlayerNumber pn,

const InputEventType type

) [protected, virtual]

Reimplemented from Screen.
Reimplemented in ScreenNetworkOptions, ScreenProfileOptions, and ScreenSMOnlineLogin.

void ScreenOptions::MenuUp ( PlayerNumber pn,

const InputEventType type

) [inline, protected, virtual]

Reimplemented from Screen.

void ScreenOptions::MoveRow ( PlayerNumber pn,

int dir,

bool Repeat

) [protected]

void ScreenOptions::OnChange ( PlayerNumber pn ) [protected, virtual]

void ScreenOptions::PositionCursors ( ) [protected]

void ScreenOptions::PositionIcons ( ) [protected]

void ScreenOptions::PositionItems ( ) [protected]

void ScreenOptions::PositionUnderlines ( ) [protected]

void ScreenOptions::RefreshIcons ( ) [protected, virtual]

Reimplemented in ScreenOptionsMaster.

void ScreenOptions::SetNavigation ( Navigation nav ) [inline, protected]

void ScreenOptions::StartGoToNextScreen ( ) [protected]

void ScreenOptions::StoreFocus ( PlayerNumber pn ) [protected]

void ScreenOptions::TweenCursor ( PlayerNumber pn ) [protected]

void ScreenOptions::Update ( float fDeltaTime ) [virtual]

Reimplemented from Screen.
Reimplemented in ScreenPlayerOptions.

void ScreenOptions::UpdateEnabledDisabled ( ) [protected]

void ScreenOptions::UpdateText ( int row ) [protected]

Member Data Documentation

bool ScreenOptions::m_bGotAtLeastOneStartPressed[NUM_PLAYERS] [protected]

bool ScreenOptions::m_bMoreShown [protected]

bool ScreenOptions::m_bWasOnExit[NUM_PLAYERS] [protected]

ActorFrame ScreenOptions::m_framePage [protected]

OptionsCursor ScreenOptions::m_Highlight[NUM_PLAYERS] [protected]

int ScreenOptions::m_iCurrentRow[NUM_PLAYERS] [protected]

int ScreenOptions::m_iFocusX[NUM_PLAYERS] [protected]

InputMode ScreenOptions::m_InputMode [protected]

Navigation ScreenOptions::m_OptionsNavigation [protected]

vector<Row*> ScreenOptions::m_Rows [protected]

DualScrollBar ScreenOptions::m_ScrollBar [protected]

RageSound ScreenOptions::m_SoundChangeCol [protected]

RageSound ScreenOptions::m_SoundNextRow [protected]

RageSound ScreenOptions::m_SoundPrevRow [protected]

RageSound ScreenOptions::m_SoundToggleOff [protected]

RageSound ScreenOptions::m_SoundToggleOn [protected]

AutoActor ScreenOptions::m_sprDisqualify[NUM_PLAYERS] [protected]

Sprite ScreenOptions::m_sprLineHighlight[NUM_PLAYERS] [protected]

AutoActor ScreenOptions::m_sprMore [protected]

AutoActor ScreenOptions::m_sprPage [protected]

BitmapText ScreenOptions::m_textExplanation[NUM_PLAYERS] [protected]

BitmapText ScreenOptions::m_textPlayerName[NUM_PLAYERS] [protected]

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

Generated on Thu Jan 27 21:03:19 2005 for StepMania by

1.3.7

ScreenOptions Class Reference

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation