OpenXcom::InfoboxState Class Reference

Frame that briefly shows some info like : Yasuaki Okamoto Has Panicked. More...

#include <InfoboxState.h>

Inheritance diagram for OpenXcom::InfoboxState:

Public Member Functions
	InfoboxState (Game *game, const std::wstring &msg)
	Creates the Infobox state. More...
	~InfoboxState ()
	Cleans up the Infobox state.
void	handle (Action *action)
	Handler for clicking anything. More...
void	think ()
	Handles the timers. More...
void	close ()
	Closes the window.
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	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

Frame that briefly shows some info like : Yasuaki Okamoto Has Panicked.

It disappears after 2 seconds.

Constructor & Destructor Documentation

OpenXcom::InfoboxState::InfoboxState	(	Game *	game,
		const std::wstring &	msg
	)

Creates the Infobox state.

Initializes all the elements.

Parameters

game	Pointer to the core game.
msg	Message string.

Member Function Documentation

void OpenXcom::InfoboxState::handle ( Action *  action )

virtual

Handler for clicking anything.

Closes the window.

Parameters

action

Pointer to an action.

Reimplemented from OpenXcom::State.

void OpenXcom::InfoboxState::think ( )

virtual

Handles the timers.

Keeps the animation timers running.

Reimplemented from OpenXcom::State.

---

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

• InfoboxState.h
• InfoboxState.cpp