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

Transfer screen that lets the player pick what items to transfer between bases. More...

#include <TransferItemsState.h>

Inheritance diagram for OpenXcom::TransferItemsState:
OpenXcom::State

Public Member Functions

 TransferItemsState (Game *game, Base *baseFrom, Base *baseTo)
 Creates the Transfer Items state. More...
 
 ~TransferItemsState ()
 Cleans up the Transfer Items state.
 
void think ()
 Runs the timers. More...
 
void btnOkClick (Action *action)
 Handler for clicking the OK button. More...
 
void completeTransfer ()
 Completes the transfer between bases.
 
void btnCancelClick (Action *action)
 Handler for clicking the Cancel button. More...
 
void lstItemsLeftArrowPress (Action *action)
 Handler for pressing an Increase arrow in the list. More...
 
void lstItemsLeftArrowRelease (Action *action)
 Handler for releasing an Increase arrow in the list. More...
 
void lstItemsLeftArrowClick (Action *action)
 Handler for clicking an Increase arrow in the list. More...
 
void lstItemsRightArrowPress (Action *action)
 Handler for pressing a Decrease arrow in the list. More...
 
void lstItemsRightArrowRelease (Action *action)
 Handler for releasing a Decrease arrow in the list. More...
 
void lstItemsRightArrowClick (Action *action)
 Handler for clicking a Decrease arrow in the list. More...
 
void lstItemsMousePress (Action *action)
 Handler for pressing-down a mouse-button in the list. More...
 
void increase ()
 Increases the quantity of an item by one. More...
 
void increaseByValue (int change)
 Increases the quantity of an item by the given value. More...
 
void decrease ()
 Decreases the quantity of an item by one. More...
 
void decreaseByValue (int change)
 Decreases the quantity of an item by the given value. More...
 
void updateItemStrings ()
 Updates the quantity-strings of the selected item.
 
int getTotal () const
 Gets the total of the transfer. 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 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

Transfer screen that lets the player pick what items to transfer between bases.

Constructor & Destructor Documentation

OpenXcom::TransferItemsState::TransferItemsState ( Game game,
Base baseFrom,
Base baseTo 
)

Creates the Transfer Items state.

Initializes all the elements in the Transfer screen.

Parameters
gamePointer to the core game.
baseFromPointer to the source base.
baseToPointer to the destination base.

Member Function Documentation

void OpenXcom::TransferItemsState::btnCancelClick ( Action action)

Handler for clicking the Cancel button.

Returns to the previous screen.

Parameters
actionPointer to an action.
void OpenXcom::TransferItemsState::btnOkClick ( Action action)

Handler for clicking the OK button.

Transfers the selected items.

Parameters
actionPointer to an action.
void OpenXcom::TransferItemsState::decrease ( )

Decreases the quantity of an item by one.

Decreases the quantity of the selected item to transfer by one.

void OpenXcom::TransferItemsState::decreaseByValue ( int  change)

Decreases the quantity of an item by the given value.

Decreases the quantity of the selected item to transfer by "change".

Parameters
changeHow much we want to remove.
int OpenXcom::TransferItemsState::getTotal ( ) const

Gets the total of the transfer.

Gets the total cost of the current transfer.

Returns
Total cost.
void OpenXcom::TransferItemsState::increase ( )

Increases the quantity of an item by one.

Increases the quantity of the selected item to transfer by one.

void OpenXcom::TransferItemsState::increaseByValue ( int  change)

Increases the quantity of an item by the given value.

Increases the quantity of the selected item to transfer by "change".

Parameters
changeHow much we want to add.
void OpenXcom::TransferItemsState::lstItemsLeftArrowClick ( Action action)

Handler for clicking an Increase arrow in the list.

Increases the selected item; by one on left-click; to max on right-click.

Parameters
actionPointer to an action.
void OpenXcom::TransferItemsState::lstItemsLeftArrowPress ( Action action)

Handler for pressing an Increase arrow in the list.

Starts increasing the item.

Parameters
actionPointer to an action.
void OpenXcom::TransferItemsState::lstItemsLeftArrowRelease ( Action action)

Handler for releasing an Increase arrow in the list.

Stops increasing the item.

Parameters
actionPointer to an action.
void OpenXcom::TransferItemsState::lstItemsMousePress ( Action action)

Handler for pressing-down a mouse-button in the list.

Handles the mouse-wheels on the arrow-buttons.

Parameters
actionPointer to an action.
void OpenXcom::TransferItemsState::lstItemsRightArrowClick ( Action action)

Handler for clicking a Decrease arrow in the list.

Decreases the selected item; by one on left-click; to 0 on right-click.

Parameters
actionPointer to an action.
void OpenXcom::TransferItemsState::lstItemsRightArrowPress ( Action action)

Handler for pressing a Decrease arrow in the list.

Starts decreasing the item.

Parameters
actionPointer to an action.
void OpenXcom::TransferItemsState::lstItemsRightArrowRelease ( Action action)

Handler for releasing a Decrease arrow in the list.

Stops decreasing the item.

Parameters
actionPointer to an action.
void OpenXcom::TransferItemsState::think ( )
virtual

Runs the timers.

Runs the arrow timers.

Reimplemented from OpenXcom::State.


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