OpenXcom::OptionsControlsState Class Reference

Controls screen which allows the user to customize the various key shortcuts in the game. More...

#include <OptionsControlsState.h>

Inheritance diagram for OpenXcom::OptionsControlsState:

Public Member Functions
	OptionsControlsState (OptionsOrigin origin)
	Creates the Controls state. More...
	~OptionsControlsState ()
	Cleans up the Controls state.
void	init ()
	Fills controls list. More...
void	lstControlsClick (Action *action)
	Handler for clicking the Controls list. More...
void	lstControlsKeyPress (Action *action)
	Handler for pressing a key in the Controls list. More...
Public Member Functions inherited from OpenXcom::OptionsBaseState
	OptionsBaseState (OptionsOrigin origin)
	Creates the Options state. More...
	~OptionsBaseState ()
	Cleans up the Options state.
void	setCategory (TextButton *button)
	Presses a certain category button. More...
void	btnOkClick (Action *action)
	Handler for clicking the OK button. More...
void	btnCancelClick (Action *action)
	Handler for clicking the Cancel button. More...
void	btnDefaultClick (Action *action)
	Handler for clicking the Restore Defaults button. More...
void	btnGroupPress (Action *action)
	Handler for clicking one of the grouping buttons.
void	txtTooltipIn (Action *action)
	Handler for showing tooltip. More...
void	txtTooltipOut (Action *action)
	Handler for hiding tooltip. More...
void	resize (int &dX, int &dY)
	Update the resolution settings, we just resized the window. More...
Public Member Functions inherited from OpenXcom::State
	State ()
	Creates a new state linked to a game. More...
virtual	~State ()
	Cleans up the state. More...
void	setInterface (const std::string &s, bool alterPal=false, SavedBattleGame *battleGame=0)
	Set interface rules. More...
void	add (Surface *surface)
	Adds a child element to the state. More...
void	add (Surface *surface, const std::string &id, const std::string &category, Surface *parent=0)
	Adds a child element to the state. More...
bool	isScreen () const
	Gets whether the state is a full-screen. More...
void	toggleScreen ()
	Toggles whether the state is a full-screen. More...
virtual void	handle (Action *action)
	Handles any events. More...
virtual void	think ()
	Runs state functionality every cycle. More...
virtual void	blit ()
	Blits the state to the screen. More...
void	hideAll ()
	Hides all the state surfaces. More...
void	showAll ()
	Shws all the state surfaces. More...
void	resetAll ()
	Resets all the state surfaces. More...
const LocalizedText &	tr (const std::string &id) const
	Get the localized text. More...
LocalizedText	tr (const std::string &id, unsigned n) const
	Get the localized text. More...
const LocalizedText &	tr (const std::string &id, SoldierGender gender) const
	Get the localized text. More...
void	redrawText ()
	redraw all the text-type surfaces.
void	centerAllSurfaces ()
	center all surfaces relative to the screen. More...
void	lowerAllSurfaces ()
	lower all surfaces by half the screen height. More...
void	applyBattlescapeTheme ()
	switch the colours to use the battlescape palette. More...
void	setModal (InteractiveSurface *surface)
	Sets a modal surface. More...
void	setPalette (SDL_Color *colors, int firstcolor=0, int ncolors=256, bool immediately=true)
	Changes a set of colors on the state's 8bpp palette. More...
void	setPalette (const std::string &palette, int backpals=-1)
	Changes the state's 8bpp palette with certain resources. More...
SDL_Color *	getPalette ()
	Gets the state's 8bpp palette. More...
virtual void	recenter (int dX, int dY)
	Re-orients all the surfaces in the state. More...

Additional Inherited Members
Static Public Member Functions inherited from OpenXcom::OptionsBaseState
static void	restart (OptionsOrigin origin)
	Restarts the game states.
Static Public Member Functions inherited from OpenXcom::State
static void	setGamePtr (Game *game)
	Sets game object pointer.
Static Protected Attributes inherited from OpenXcom::State
static Game *	_game = 0
	Initializes static member.

Detailed Description

Controls screen which allows the user to customize the various key shortcuts in the game.

Constructor & Destructor Documentation

OptionsControlsState()

OpenXcom::OptionsControlsState::OptionsControlsState

(

OptionsOrigin

origin

)

Creates the Controls state.

Initializes all the elements in the Controls screen.

Parameters

game	Pointer to the core game.
origin	Game section that originated this state.

Member Function Documentation

init()

void OpenXcom::OptionsControlsState::init ( )

virtual

Fills controls list.

Fills the controls list based on category.

Reimplemented from OpenXcom::OptionsBaseState.

lstControlsClick()

void OpenXcom::OptionsControlsState::lstControlsClick

(

Action *

action

)

Handler for clicking the Controls list.

Select a control for changing.

Parameters

action

Pointer to an action.

lstControlsKeyPress()

void OpenXcom::OptionsControlsState::lstControlsKeyPress

(

Action *

action

)

Handler for pressing a key in the Controls list.

Change selected control.

Parameters

action

Pointer to an action.

---

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

• OptionsControlsState.h
• OptionsControlsState.cpp