ActionAvailability Class Reference

#include <actionavailability.h>

List of all members.

Public Types

enum  Availability { notAtAll, partially, available }

Public Member Functions

 ActionAvailability ()
ActionAvailabilityset (Availability avail, const ASCString &msg)
Availability getAvailability () const
ASCString getMessage () const
bool ready () const
virtual ~ActionAvailability ()


Detailed Description

Definition at line 28 of file actionavailability.h.


Member Enumeration Documentation

enum ActionAvailability::Availability

Enumerator:
notAtAll  the action is not available and no action symbol shall be shown to the user.
partially  the action would be available, if not some prerequisites are missing which the user could provide
available  the action can be executed right now

Definition at line 30 of file actionavailability.h.


Constructor & Destructor Documentation

ActionAvailability::ActionAvailability (  ) 

Definition at line 23 of file actionavailability.cpp.

References available.

virtual ActionAvailability::~ActionAvailability (  )  [inline, virtual]

Definition at line 40 of file actionavailability.h.


Member Function Documentation

ActionAvailability & ActionAvailability::set ( Availability  avail,
const ASCString msg 
)

Definition at line 28 of file actionavailability.cpp.

Referenced by JumpDriveCommand::available().

ActionAvailability::Availability ActionAvailability::getAvailability (  )  const

Definition at line 40 of file actionavailability.cpp.

Referenced by GuiFunctions::JumpDriveIcon::available().

ASCString ActionAvailability::getMessage (  )  const

Definition at line 51 of file actionavailability.cpp.

Referenced by GuiFunctions::JumpDriveIcon::execute(), and unitJump().

bool ActionAvailability::ready (  )  const

Definition at line 45 of file actionavailability.cpp.

References available.

Referenced by GuiFunctions::JumpDriveIcon::execute(), and unitJump().


The documentation for this class was generated from the following files:
Generated on Mon May 21 01:46:12 2012 for Advanced Strategic Command by  doxygen 1.5.1