OpenXcom  1.0
Open-source clone of the original X-Com
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
OpenXcom::BaseNameState Class Reference

Window used to input a name for a new base. More...

#include <BaseNameState.h>

Inheritance diagram for OpenXcom::BaseNameState:
OpenXcom::State

Public Member Functions

 BaseNameState (Game *game, Base *base, Globe *globe, bool first)
 Creates the Base Name state. More...
 
 ~BaseNameState ()
 Cleans up the Base Name state.
 
void btnOkClick (Action *action)
 Handler for clicking the OK button. More...
 
void edtNameChange (Action *action)
 Handler for changing text on the Name edit. 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 LocalizedTexttr (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

Window used to input a name for a new base.

Player's first Base uses this screen additional bases use ConfirmNewBaseState

Constructor & Destructor Documentation

OpenXcom::BaseNameState::BaseNameState ( Game game,
Base base,
Globe globe,
bool  first 
)

Creates the Base Name state.

Initializes all the elements in a Base Name window.

Parameters
gamePointer to the core game.
basePointer to the base to name.
globePointer to the Geoscape globe.
firstIs this the first base in the game?

Member Function Documentation

void OpenXcom::BaseNameState::btnOkClick ( Action action)

Handler for clicking the OK button.

Returns to the previous screen.

Parameters
actionPointer to an action.
void OpenXcom::BaseNameState::edtNameChange ( Action action)

Handler for changing text on the Name edit.

Updates the base name and disables the OK button if no name is entered.

Parameters
actionPointer to an action.

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