OpenXcom::ErrorMessageState Class Reference

Generic window used to display error messages. More...

#include <ErrorMessageState.h>

Inheritance diagram for OpenXcom::ErrorMessageState:

Public Member Functions
	ErrorMessageState (Game *game, const std::string &id, SDL_Color *palette, Uint8 color, std::string bg, int bgColor)
	Creates the Error state. More...
	ErrorMessageState (Game *game, const std::wstring &msg, SDL_Color *palette, Uint8 color, std::string bg, int bgColor)
	Creates the Error state. More...
	~ErrorMessageState ()
	Cleans up the Error state.
void	btnOkClick (Action *action)
	Handler for clicking the OK button. 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	init ()
	Initializes the state. 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	resize (int &dX, int &dY)
	Let the state know the window has been resized. More...
virtual void	recenter (int dX, int dY)
	Re-orients all the surfaces in the state. More...

Detailed Description

Generic window used to display error messages.

Constructor & Destructor Documentation

OpenXcom::ErrorMessageState::ErrorMessageState	(	Game *	game,
		const std::string &	id,
		SDL_Color *	palette,
		Uint8	color,
		std::string	bg,
		int	bgColor
	)

Creates the Error state.

Initializes all the elements in an error window.

Parameters

game	Pointer to the core game.
id	Language ID for the message to display.
palette	Parent state palette.
color	Color of the UI controls.
bg	Background image.
bgColor	Background color (-1 for Battlescape).

OpenXcom::ErrorMessageState::ErrorMessageState	(	Game *	game,
		const std::wstring &	msg,
		SDL_Color *	palette,
		Uint8	color,
		std::string	bg,
		int	bgColor
	)

Creates the Error state.

Initializes all the elements in an error window.

Parameters

game	Pointer to the core game.
msg	Text string for the message to display.
palette	Parent state palette.
color	Color of the UI controls.
bg	Background image.
bgColor	Background color (-1 for Battlescape).

Member Function Documentation

void OpenXcom::ErrorMessageState::btnOkClick

(

Action *

action

)

Handler for clicking the OK button.

Closes the window.

Parameters

action

Pointer to an action.

---

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

• ErrorMessageState.h
• ErrorMessageState.cpp