OpenXcom::ListGamesState Class Reference

Base class for saved game screens which provides the common layout and listing. More...

#include <ListGamesState.h>

Inheritance diagram for OpenXcom::ListGamesState:

Public Member Functions
	ListGamesState (Game *game, OptionsOrigin origin, int firstValidRow, bool autoquick)
	Creates the Saved Game state. More...
virtual	~ListGamesState ()
	Cleans up the Saved Game state.
void	init ()
	Sets up the saves list. More...
void	sortList (SaveSort sort)
	Sorts the savegame list. More...
virtual void	updateList ()
	Updates the savegame list. More...
void	btnCancelClick (Action *action)
	Handler for clicking the Cancel button. More...
void	lstSavesMouseOver (Action *action)
	Handler for moving the mouse over a list item. More...
void	lstSavesMouseOut (Action *action)
	Handler for moving the mouse outside the list borders. More...
virtual void	lstSavesPress (Action *action)
	Handler for clicking the Saves list. More...
void	sortNameClick (Action *action)
	Handler for clicking the Name arrow. More...
void	sortDateClick (Action *action)
	Handler for clicking the Date arrow. More...
void	disableSort ()
	disables the sort buttons.
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	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...

Protected Member Functions
void	updateArrows ()
	Updates the sorting arrows based on the current setting.

Detailed Description

Base class for saved game screens which provides the common layout and listing.

Constructor & Destructor Documentation

OpenXcom::ListGamesState::ListGamesState	(	Game *	game,
		OptionsOrigin	origin,
		int	firstValidRow,
		bool	autoquick
	)

Creates the Saved Game state.

Initializes all the elements in the Saved Game screen.

Parameters

game	Pointer to the core game.
origin	Game section that originated this state.
firstValidRow	First row containing saves.
autoquick	Show auto/quick saved games?

Member Function Documentation

void OpenXcom::ListGamesState::btnCancelClick

(

Action *

action

)

Handler for clicking the Cancel button.

Returns to the previous screen.

Parameters

action

Pointer to an action.

void OpenXcom::ListGamesState::init ( )

virtual

Sets up the saves list.

Refreshes the saves list.

Reimplemented from OpenXcom::State.

void OpenXcom::ListGamesState::lstSavesMouseOut

(

Action *

action

)

Handler for moving the mouse outside the list borders.

Clears the details.

Parameters

action

Pointer to an action.

void OpenXcom::ListGamesState::lstSavesMouseOver

(

Action *

action

)

Handler for moving the mouse over a list item.

Shows the details of the currently hovered save.

Parameters

action

Pointer to an action.

void OpenXcom::ListGamesState::lstSavesPress ( Action *  action )

virtual

Handler for clicking the Saves list.

Deletes the selected save.

Parameters

action

Pointer to an action.

Reimplemented in OpenXcom::ListSaveState, and OpenXcom::ListLoadState.

void OpenXcom::ListGamesState::sortDateClick

(

Action *

action

)

Handler for clicking the Date arrow.

Sorts the saves by date.

Parameters

action

Pointer to an action.

void OpenXcom::ListGamesState::sortList

(

SaveSort

sort

)

Sorts the savegame list.

Sorts the save game list.

Parameters

sort	Order to sort the games in.

void OpenXcom::ListGamesState::sortNameClick

(

Action *

action

)

Handler for clicking the Name arrow.

Sorts the saves by name.

Parameters

action

Pointer to an action.

void OpenXcom::ListGamesState::updateList ( )

virtual

Updates the savegame list.

Updates the save game list with the current list of available savegames.

Reimplemented in OpenXcom::ListSaveState.

---

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

• ListGamesState.h
• ListGamesState.cpp