_________ __                 __
        /   _____//  |_____________ _/  |______     ____  __ __  ______
        \_____  \\   __\_  __ \__  \\   __\__  \   / ___\|  |  \/  ___/
        /        \|  |  |  | \// __ \|  |  / __ \_/ /_/  >  |  /\___ \
       /_______  /|__|  |__|  (____  /__| (____  /\___  /|____//____  >
               \/                  \/          \//_____/            \/
    ______________________                           ______________________
                          T H E   W A R   B E G I N S
                   Stratagus - A free fantasy real time strategy game engine

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Public Attributes | List of all members
ButtonAction Class Reference

Action of button. More...

#include <interface.h>

Public Member Functions

 ButtonAction ()
 

Public Attributes

int Pos
 
int Level
 button position in the grid More...
 
bool AlwaysShow
 requires button level More...
 
ButtonCmd Action
 button is always shown but drawn grayscale if not available More...
 
int Value
 command on button press More...
 
void * Payload
 extra value for command More...
 
std::string ValueStr
 
ButtonCheckFunc Allowed
 keep original value string More...
 
std::string AllowStr
 Check if this button is allowed. More...
 
std::string UnitMask
 argument for allowed More...
 
IconConfig Icon
 for which units is it available More...
 
int Key
 icon to display More...
 
std::string Hint
 alternative on keyboard More...
 
std::string Description
 tip texts More...
 
SoundConfig CommentSound
 description shown on status bar (optional) More...
 
std::string ButtonCursor
 Sound comment used when you press the button. More...
 
std::string Popup
 Custom cursor for button action (for example, to set spell target) More...
 

Detailed Description

Action of button.

Constructor & Destructor Documentation

ButtonAction::ButtonAction ( )
inline

Member Data Documentation

ButtonCmd ButtonAction::Action

button is always shown but drawn grayscale if not available

ButtonCheckFunc ButtonAction::Allowed

keep original value string

std::string ButtonAction::AllowStr

Check if this button is allowed.

bool ButtonAction::AlwaysShow

requires button level

std::string ButtonAction::ButtonCursor

Sound comment used when you press the button.

SoundConfig ButtonAction::CommentSound

description shown on status bar (optional)

std::string ButtonAction::Description

tip texts

std::string ButtonAction::Hint

alternative on keyboard

IconConfig ButtonAction::Icon

for which units is it available

int ButtonAction::Key

icon to display

int ButtonAction::Level

button position in the grid

void* ButtonAction::Payload

extra value for command

std::string ButtonAction::Popup

Custom cursor for button action (for example, to set spell target)

int ButtonAction::Pos
std::string ButtonAction::UnitMask

argument for allowed

int ButtonAction::Value

command on button press

std::string ButtonAction::ValueStr

The documentation for this class was generated from the following file:
(C) Copyright 1998-2012 by The Stratagus Project under the GNU General Public License.
All trademarks and copyrights on this page are owned by their respective owners.