____                _       __
    / __ )____  _____   | |     / /___ ___________
   / __  / __ \/ ___/   | | /| / / __ `/ ___/ ___/
  / /_/ / /_/ (__  )    | |/ |/ / /_/ / /  (__  )
 /_____/\____/____/     |__/|__/\__,_/_/  /____/

       A futuristic real-time strategy game.
          This file is part of Bos Wars.
(C) Copyright 2001-2007 by the Bos Wars and Stratagus Project. Distributed under the "GNU General Public License"

ButtonAction Class Reference

#include <interface.h>

List of all members.

Public Member Functions

 ButtonAction ()

Public Attributes

int Pos
 button position in the grid
int Level
 requires button level
ButtonCmd Action
 command on button press
int Value
 extra value for command
std::string ValueStr
 keep original value string
ButtonCheckFunc Allowed
 Check if this button is allowed.
std::string AllowStr
 argument for allowed
std::string UnitMask
 for which units is it available
IconConfig Icon
 icon to display
int Key
 alternative on keyboard
std::string Hint
 tip text


Detailed Description

Definition at line 74 of file interface.h.


Constructor & Destructor Documentation

ButtonAction::ButtonAction (  )  [inline]

Definition at line 76 of file interface.h.


Member Data Documentation

button position in the grid

Definition at line 79 of file interface.h.

Referenced by AddButton(), CclDefineButton(), GetButtonStatus(), UpdateButtonPanelMultipleUnits(), and UpdateButtonPanelSingleUnit().

requires button level

Definition at line 80 of file interface.h.

Referenced by AddButton(), CclDefineButton(), and UpdateButtonPanelSingleUnit().

extra value for command

Definition at line 82 of file interface.h.

Referenced by AddButton(), CButtonPanel::DoClicked(), DrawPopup(), GetButtonStatus(), IsButtonAllowed(), and UpdateStatusLineForButton().

keep original value string

Definition at line 83 of file interface.h.

Referenced by AddButton(), CclDefineButton(), and InitAiHelper().

Check if this button is allowed.

Definition at line 85 of file interface.h.

Referenced by AddButton(), CclDefineButton(), and IsButtonAllowed().

argument for allowed

Definition at line 86 of file interface.h.

Referenced by AddButton(), ButtonCheckUnitsAnd(), ButtonCheckUnitsOr(), and CclDefineButton().

for which units is it available

Definition at line 87 of file interface.h.

Referenced by AddButton(), CclDefineButton(), InitAiHelper(), and UpdateButtonPanelSingleUnit().

icon to display

Definition at line 88 of file interface.h.

Referenced by AddButton(), CclDefineButton(), CButtonPanel::Draw(), and DrawPieMenu().

alternative on keyboard

Definition at line 89 of file interface.h.

Referenced by AddButton().

std::string ButtonAction::Hint

tip text

Definition at line 90 of file interface.h.

Referenced by AddButton(), CclDefineButton(), DrawPopup(), and UpdateStatusLineForButton().


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

Generated on Sat Feb 21 00:28:23 2009 for Bos Wars by  doxygen 1.5.6