OpenXcom  1.0
Open-source clone of the original X-Com
Public Member Functions | Protected Member Functions | List of all members
OpenXcom::UfopaediaStartState Class Reference

UfopaediaStartState is the screen that opens when clicking Ufopaedia button in Geoscape. More...

#include <UfopaediaStartState.h>

Inheritance diagram for OpenXcom::UfopaediaStartState:
OpenXcom::State

Public Member Functions

virtual ~UfopaediaStartState ()
 Deletes timers.
 
- Public Member Functions inherited from OpenXcom::State
 State ()
 Creates a new state linked to a game. More...
 
virtual ~State ()
 Cleans up the state. More...
 
void setInterface (const std::string &s, bool alterPal=false, SavedBattleGame *battleGame=0)
 Set interface rules. More...
 
void add (Surface *surface)
 Adds a child element to the state. More...
 
void add (Surface *surface, const std::string &id, const std::string &category, Surface *parent=0)
 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 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...
 
const LocalizedTexttr (const std::string &id, SoldierGender gender) 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 * 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 think ()
 Run timers.
 
void btnSectionClick (Action *action)
 Displays the list of articles for this section. More...
 
void btnOkClick (Action *action)
 Returns to the previous screen. More...
 
void btnScrollUpPress (Action *action)
 Starts scrolling the section buttons up. More...
 
void btnScrollUpClick (Action *action)
 Scrolls the section buttons up. More...
 
void btnScrollDownPress (Action *action)
 Starts scrolling the section buttons down. More...
 
void btnScrollDownClick (Action *action)
 Scrolls the section buttons down. More...
 
void btnScrollRelease (Action *action)
 Stops scrolling the section buttons. More...
 
void scroll ()
 Offsets the list of section buttons.
 
void updateButtons ()
 Updates the section button labels based on scroll.
 

Additional Inherited Members

- Static Public Member Functions inherited from OpenXcom::State
static void setGamePtr (Game *game)
 Sets game object pointer.
 
- Static Protected Attributes inherited from OpenXcom::State
static Game_game = 0
 Initializes static member.
 

Detailed Description

UfopaediaStartState is the screen that opens when clicking Ufopaedia button in Geoscape.

Presents buttons to all sections of Ufopaedia, opening a UfopaediaSelectState on click.

Member Function Documentation

◆ btnOkClick()

void OpenXcom::UfopaediaStartState::btnOkClick ( Action action)
protected

Returns to the previous screen.

Parameters
actionPointer to an action.

◆ btnScrollDownClick()

void OpenXcom::UfopaediaStartState::btnScrollDownClick ( Action action)
protected

Scrolls the section buttons down.

Parameters
actionPointer to an action.

◆ btnScrollDownPress()

void OpenXcom::UfopaediaStartState::btnScrollDownPress ( Action action)
protected

Starts scrolling the section buttons down.

Parameters
actionPointer to an action.

◆ btnScrollRelease()

void OpenXcom::UfopaediaStartState::btnScrollRelease ( Action action)
protected

Stops scrolling the section buttons.

Parameters
actionPointer to an action.

◆ btnScrollUpClick()

void OpenXcom::UfopaediaStartState::btnScrollUpClick ( Action action)
protected

Scrolls the section buttons up.

Parameters
actionPointer to an action.

◆ btnScrollUpPress()

void OpenXcom::UfopaediaStartState::btnScrollUpPress ( Action action)
protected

Starts scrolling the section buttons up.

Parameters
actionPointer to an action.

◆ btnSectionClick()

void OpenXcom::UfopaediaStartState::btnSectionClick ( Action action)
protected

Displays the list of articles for this section.

Parameters
actionPointer to an action.

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