OpenXcom::OptionsBaseState Class Reference

Options base state for common stuff across Options windows. More...

#include <OptionsBaseState.h>

Inheritance diagram for OpenXcom::OptionsBaseState:

Public Member Functions
	OptionsBaseState (Game *game, OptionsOrigin origin)
	Creates the Options state. More...
	~OptionsBaseState ()
	Cleans up the Options state.
void	init ()
	Initializes palettes. More...
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 (Game *game)
	Creates a new state linked to a game. More...
virtual	~State ()
	Cleans up the state. More...
void	add (Surface *surface)
	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...
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 *const	getPalette ()
	Gets the state's 8bpp palette. More...
virtual void	recenter (int dX, int dY)
	Re-orients all the surfaces in the state. More...

Static Public Member Functions
static void	restart (Game *game, OptionsOrigin origin)
	Restarts the game states.

Detailed Description

Options base state for common stuff across Options windows.

Constructor & Destructor Documentation

OpenXcom::OptionsBaseState::OptionsBaseState	(	Game *	game,
		OptionsOrigin	origin
	)

Creates the Options state.

Initializes all the elements in the Options window.

Parameters

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

Member Function Documentation

void OpenXcom::OptionsBaseState::btnCancelClick

(

Action *

action

)

Handler for clicking the Cancel button.

Loads previous options and returns to the previous screen.

Parameters

action

Pointer to an action.

void OpenXcom::OptionsBaseState::btnDefaultClick

(

Action *

action

)

Handler for clicking the Restore Defaults button.

Restores the Options to default settings.

Parameters

action

Pointer to an action.

void OpenXcom::OptionsBaseState::btnOkClick

(

Action *

action

)

Handler for clicking the OK button.

Saves the new options and returns to the proper origin screen.

Parameters

action

Pointer to an action.

void OpenXcom::OptionsBaseState::init ( )

virtual

Initializes palettes.

Initializes UI colors according to origin.

Reimplemented from OpenXcom::State.

Reimplemented in OpenXcom::OptionsControlsState.

void OpenXcom::OptionsBaseState::resize ( int &  dX, int &  dY  )

virtual

Update the resolution settings, we just resized the window.

Updates the scale.

Parameters

dX	delta of X;
dY	delta of Y;

Reimplemented from OpenXcom::State.

Reimplemented in OpenXcom::OptionsVideoState.

void OpenXcom::OptionsBaseState::setCategory

(

TextButton *

button

)

Presses a certain category button.

Handles the pressed-button state for the category buttons.

Parameters

button

Button to press.

void OpenXcom::OptionsBaseState::txtTooltipIn

(

Action *

action

)

Handler for showing tooltip.

Shows a tooltip for the appropriate button.

Parameters

action

Pointer to an action.

void OpenXcom::OptionsBaseState::txtTooltipOut

(

Action *

action

)

Handler for hiding tooltip.

Clears the tooltip text.

Parameters

action

Pointer to an action.

---

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

• OptionsBaseState.h
• OptionsBaseState.cpp