Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   

VCF::DrawUIState Class Reference

The DrawUIState is a utility class to make it easy to indicate the user interface state of a GUI element, such as a button. More...

#include <vcf/GraphicsKit/DrawUIState.h>

Inheritance diagram for VCF::DrawUIState:

VCF::BackgroundState VCF::ButtonState VCF::DisclosureButtonState VCF::HeaderItemState VCF::ListItemState VCF::MenuState VCF::ProgressState VCF::ScrollBarState VCF::SliderState VCF::TableItemState VCF::TabState VCF::TextState VCF::TreeItemState List of all members.

Public Member Functions

 DrawUIState ()
virtual ~DrawUIState ()
bool isEnabled () const
bool isFocused () const
bool isActive () const
bool isHighlighted () const
void setEnabled (bool val)
void setFocused (bool val)
void setActive (bool val)
void setHighlighted (bool val)
bool isSelected () const
void setSelected (bool val)
bool isToggled () const
void setToggled (bool val)
bool isToggleYes () const
bool isToggleNo () const
bool isMutuallyExclusive () const
void setMutuallyExclusive (bool val)
bool hasChildren () const
void setHasChildren (bool val)
bool itemHasImage () const
void setItemHasImage (bool val)
bool isClosed () const
void setClosed (bool val)
bool isPartialOpened () const
void setPartialOpened (bool val)
bool isOpened () const
void setOpened (bool val)
UIElementType getType () const
void setType (UIElementType val)
bool isSubItem () const
void setAsSubItem (bool val)
UIElementType getItemType () const
uint32 getState () const
void setState (const uint32 &val)

Protected Attributes

uint32 state_
uint32 type_

Detailed Description

The DrawUIState is a utility class to make it easy to indicate the user interface state of a GUI element, such as a button.

The base settings indicate whether the element is active, enabled, focused, or highlighted.

The various sub classes of DrawUIState simply make it easier to identify the state of the element, as well as adding a few more states, and optionally storing additional state information like the text or caption of the control.


Constructor & Destructor Documentation

VCF::DrawUIState::DrawUIState  )  [inline]
 

virtual VCF::DrawUIState::~DrawUIState  )  [inline, virtual]
 


Member Function Documentation

UIElementType VCF::DrawUIState::getItemType  )  const [inline]
 

uint32 VCF::DrawUIState::getState  )  const [inline]
 

UIElementType VCF::DrawUIState::getType  )  const [inline]
 

bool VCF::DrawUIState::hasChildren  )  const [inline]
 

bool VCF::DrawUIState::isActive  )  const [inline]
 

bool VCF::DrawUIState::isClosed  )  const [inline]
 

bool VCF::DrawUIState::isEnabled  )  const [inline]
 

bool VCF::DrawUIState::isFocused  )  const [inline]
 

bool VCF::DrawUIState::isHighlighted  )  const [inline]
 

bool VCF::DrawUIState::isMutuallyExclusive  )  const [inline]
 

bool VCF::DrawUIState::isOpened  )  const [inline]
 

bool VCF::DrawUIState::isPartialOpened  )  const [inline]
 

bool VCF::DrawUIState::isSelected  )  const [inline]
 

Reimplemented in VCF::TextState.

bool VCF::DrawUIState::isSubItem  )  const [inline]
 

bool VCF::DrawUIState::isToggled  )  const [inline]
 

bool VCF::DrawUIState::isToggleNo  )  const [inline]
 

bool VCF::DrawUIState::isToggleYes  )  const [inline]
 

bool VCF::DrawUIState::itemHasImage  )  const [inline]
 

void VCF::DrawUIState::setActive bool  val  )  [inline]
 

void VCF::DrawUIState::setAsSubItem bool  val  )  [inline]
 

void VCF::DrawUIState::setClosed bool  val  )  [inline]
 

void VCF::DrawUIState::setEnabled bool  val  )  [inline]
 

void VCF::DrawUIState::setFocused bool  val  )  [inline]
 

void VCF::DrawUIState::setHasChildren bool  val  )  [inline]
 

void VCF::DrawUIState::setHighlighted bool  val  )  [inline]
 

void VCF::DrawUIState::setItemHasImage bool  val  )  [inline]
 

void VCF::DrawUIState::setMutuallyExclusive bool  val  )  [inline]
 

void VCF::DrawUIState::setOpened bool  val  )  [inline]
 

void VCF::DrawUIState::setPartialOpened bool  val  )  [inline]
 

void VCF::DrawUIState::setSelected bool  val  )  [inline]
 

void VCF::DrawUIState::setState const uint32 val  )  [inline]
 

void VCF::DrawUIState::setToggled bool  val  )  [inline]
 

void VCF::DrawUIState::setType UIElementType  val  )  [inline]
 


Member Data Documentation

uint32 VCF::DrawUIState::state_ [protected]
 

uint32 VCF::DrawUIState::type_ [protected]
 


The documentation for this class was generated from the following file:
   Comments or Suggestions?    License Information