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::OptionsVideoState Class Reference

Screen that lets the user configure various Video options. More...

#include <OptionsVideoState.h>

Inheritance diagram for OpenXcom::OptionsVideoState:
OpenXcom::OptionsBaseState OpenXcom::State

Public Member Functions

 OptionsVideoState (Game *game, OptionsOrigin origin)
 Creates the Options state. More...
 
 ~OptionsVideoState ()
 Cleans up the Options state.
 
void btnDisplayResolutionUpClick (Action *action)
 Handler for clicking the Next Resolution button. More...
 
void btnDisplayResolutionDownClick (Action *action)
 Handler for clicking the Previous Resolution button. More...
 
void txtDisplayWidthChange (Action *action)
 Handler for changing the Display Width text. More...
 
void txtDisplayHeightChange (Action *action)
 Handler for changing the Display Height text. More...
 
void cbxLanguageChange (Action *action)
 Handler for changing the Language combobox. More...
 
void cbxFilterChange (Action *action)
 Handler for changing the Filter combobox. More...
 
void updateDisplayMode (Action *action)
 Handler for clicking the Display Mode combobox. More...
 
void btnLetterboxClick (Action *action)
 Handler for clicking the Letterboxed button. More...
 
void btnLockMouseClick (Action *action)
 Handler for clicking the Lock Mouse button. More...
 
void updateBattlescapeScale (Action *action)
 Handler for updating the selected battlescape scale. More...
 
void updateGeoscapeScale (Action *action)
 Handler for updating the selected geoscape scale. More...
 
void resize (int &, int &)
 Update the resolution settings, we just resized the window. More...
 
void handle (Action *action)
 Handles keypresses. More...
 
- Public Member Functions inherited from OpenXcom::OptionsBaseState
 OptionsBaseState (Game *game, OptionsOrigin origin)
 Creates the Options state. More...
 
 ~OptionsBaseState ()
 Cleans up the Options state.
 
void init ()
 Initializes palettes. More...
 
void setCategory (TextButton *button)
 Presses a certain category button. More...
 
void btnOkClick (Action *action)
 Handler for clicking the OK button. More...
 
void btnCancelClick (Action *action)
 Handler for clicking the Cancel button. More...
 
void btnDefaultClick (Action *action)
 Handler for clicking the Restore Defaults button. More...
 
void btnGroupPress (Action *action)
 Handler for clicking one of the grouping buttons.
 
void txtTooltipIn (Action *action)
 Handler for showing tooltip. More...
 
void txtTooltipOut (Action *action)
 Handler for hiding tooltip. 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 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 recenter (int dX, int dY)
 Re-orients all the surfaces in the state. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from OpenXcom::OptionsBaseState
static void restart (Game *game, OptionsOrigin origin)
 Restarts the game states.
 

Detailed Description

Screen that lets the user configure various Video options.

Constructor & Destructor Documentation

OpenXcom::OptionsVideoState::OptionsVideoState ( Game game,
OptionsOrigin  origin 
)

Creates the Options state.

Initializes all the elements in the Video Options screen.

Parameters
gamePointer to the core game.
originGame section that originated this state.

Member Function Documentation

void OpenXcom::OptionsVideoState::btnDisplayResolutionDownClick ( Action action)

Handler for clicking the Previous Resolution button.

Selects a smaller display resolution.

Parameters
actionPointer to an action.
void OpenXcom::OptionsVideoState::btnDisplayResolutionUpClick ( Action action)

Handler for clicking the Next Resolution button.

Selects a bigger display resolution.

Parameters
actionPointer to an action.
void OpenXcom::OptionsVideoState::btnLetterboxClick ( Action action)

Handler for clicking the Letterboxed button.

Changes the Letterboxing option.

Parameters
actionPointer to an action.
void OpenXcom::OptionsVideoState::btnLockMouseClick ( Action action)

Handler for clicking the Lock Mouse button.

Changes the Lock Mouse option.

Parameters
actionPointer to an action.
void OpenXcom::OptionsVideoState::cbxFilterChange ( Action action)

Handler for changing the Filter combobox.

Changes the Filter options.

Parameters
actionPointer to an action.
void OpenXcom::OptionsVideoState::cbxLanguageChange ( Action action)

Handler for changing the Language combobox.

Changes the Language option.

Parameters
actionPointer to an action.
void OpenXcom::OptionsVideoState::handle ( Action action)
virtual

Handles keypresses.

Takes care of any events from the core game engine.

Parameters
actionPointer to an action.

Reimplemented from OpenXcom::State.

void OpenXcom::OptionsVideoState::resize ( int &  dX,
int &  dY 
)
virtual

Update the resolution settings, we just resized the window.

Updates the scale.

Parameters
dXdelta of X;
dYdelta of Y;

Reimplemented from OpenXcom::OptionsBaseState.

void OpenXcom::OptionsVideoState::txtDisplayHeightChange ( Action action)

Handler for changing the Display Height text.

Changes the Display Height option.

Parameters
actionPointer to an action.
void OpenXcom::OptionsVideoState::txtDisplayWidthChange ( Action action)

Handler for changing the Display Width text.

Changes the Display Width option.

Parameters
actionPointer to an action.
void OpenXcom::OptionsVideoState::updateBattlescapeScale ( Action action)

Handler for updating the selected battlescape scale.

Updates the Battlescape scale.

Parameters
actionPointer to an action.
void OpenXcom::OptionsVideoState::updateDisplayMode ( Action action)

Handler for clicking the Display Mode combobox.

Changes the Display Mode options.

Parameters
actionPointer to an action.
void OpenXcom::OptionsVideoState::updateGeoscapeScale ( Action action)

Handler for updating the selected geoscape scale.

Changes the geoscape scale.

Parameters
actionPointer to an action.

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