Torque Game Engine Documentation TGE Version 1.5.2

Torque Home   Class Hierarchy   Data Structures   Namespaces   Namespace Members   File List   Globals

GuiButtonBaseCtrl Class Reference #include <guiButtonBaseCtrl.h> Inheritance diagram for GuiButtonBaseCtrl: [legend] Public Types enum   {   ButtonTypePush,   ButtonTypeCheck,   ButtonTypeRadio } Public Member Functions   GuiButtonBaseCtrl () bool  onWake ()   Called when this object is asked to wake up returns true if it's actually awake at the end.   DECLARE_CONOBJECT (GuiButtonBaseCtrl) void  setText (const char *text) void  setTextID (S32 id) void  setTextID (const char *id) const char *  getText () void  setStateOn (bool bStateOn) void  acceleratorKeyPress (U32 index)   Occurs when the accelerator key for this control is pressed. void  acceleratorKeyRelease (U32 index)   Occurs when the accelerator key for this control is released. void  onMouseDown (const GuiEvent &) void  onMouseUp (const GuiEvent &) void  onRightMouseUp (const GuiEvent &) void  onMouseEnter (const GuiEvent &) void  onMouseLeave (const GuiEvent &) bool  onKeyDown (const GuiEvent &event)   Happens when a key is depressed. bool  onKeyUp (const GuiEvent &event)   Happens when a key is released. void  setScriptValue (const char *value)   Sets the value of the variable bound to this object. const char *  getScriptValue ()   Returns the value of the variable bound to this object. void  onMessage (GuiControl *, S32 msg)   Receive a message from another control. void  onAction ()   Occurs when this control performs its "action". Static Public Member Functions static void  initPersistFields ()   Register dynamic fields in a subclass of ConsoleObject. Protected Attributes StringTableEntry  mButtonText StringTableEntry  mButtonTextID bool  mDepressed bool  mMouseOver bool  mStateOn S32  mButtonType S32  mRadioGroup Private Types typedef GuiControl  Parent Member Typedef Documentation typedef GuiControl GuiButtonBaseCtrl::Parent [private] Reimplemented from GuiControl. Reimplemented in GuiBitmapButtonCtrl, GuiBitmapButtonTextCtrl, GuiButtonCtrl, GuiCheckBoxCtrl, and GuiRadioCtrl. Member Enumeration Documentation anonymous enum Enumerator: ButtonTypePush  ButtonTypeCheck  ButtonTypeRadio  Constructor & Destructor Documentation GuiButtonBaseCtrl::GuiButtonBaseCtrl (  )  Member Function Documentation bool GuiButtonBaseCtrl::onWake (  )  [virtual] Called when this object is asked to wake up returns true if it's actually awake at the end. Reimplemented from GuiControl. Reimplemented in GuiBitmapButtonCtrl, GuiButtonCtrl, and GuiCheckBoxCtrl. GuiButtonBaseCtrl::DECLARE_CONOBJECT ( GuiButtonBaseCtrl   )  static void GuiButtonBaseCtrl::initPersistFields (  )  [static] Register dynamic fields in a subclass of ConsoleObject. See also: addField(), addFieldV(), addDepricatedField(), addGroup(), endGroup() Reimplemented from GuiControl. Reimplemented in GuiBitmapButtonCtrl, and GuiCheckBoxCtrl. void GuiButtonBaseCtrl::setText ( const char *  text  )  void GuiButtonBaseCtrl::setTextID ( S32  id  )  void GuiButtonBaseCtrl::setTextID ( const char *  id  )  const char* GuiButtonBaseCtrl::getText (  )  void GuiButtonBaseCtrl::setStateOn ( bool  bStateOn  )  void GuiButtonBaseCtrl::acceleratorKeyPress ( U32  index  )  [virtual] Occurs when the accelerator key for this control is pressed. Parameters: index  Index in the acclerator map of the key Reimplemented from GuiControl. void GuiButtonBaseCtrl::acceleratorKeyRelease ( U32  index  )  [virtual] Occurs when the accelerator key for this control is released. Parameters: index  Index in the acclerator map of the key Reimplemented from GuiControl. void GuiButtonBaseCtrl::onMouseDown ( const GuiEvent &   )  [virtual] Reimplemented from GuiControl. Reimplemented in GuiCheckBoxCtrl. void GuiButtonBaseCtrl::onMouseUp ( const GuiEvent &   )  [virtual] Reimplemented from GuiControl. Reimplemented in GuiCheckBoxCtrl. void GuiButtonBaseCtrl::onRightMouseUp ( const GuiEvent &   )  [virtual] Reimplemented from GuiControl. void GuiButtonBaseCtrl::onMouseEnter ( const GuiEvent &   )  [virtual] Reimplemented from GuiControl. void GuiButtonBaseCtrl::onMouseLeave ( const GuiEvent &   )  [virtual] Reimplemented from GuiControl. bool GuiButtonBaseCtrl::onKeyDown ( const GuiEvent &  event  )  [virtual] Happens when a key is depressed. Parameters: event  Event descriptor (which contains the key) Reimplemented from GuiControl. bool GuiButtonBaseCtrl::onKeyUp ( const GuiEvent &  event  )  [virtual] Happens when a key is released. Parameters: event  Event descriptor (which contains the key) Reimplemented from GuiControl. void GuiButtonBaseCtrl::setScriptValue ( const char *  value  )  [virtual] Sets the value of the variable bound to this object. Reimplemented from GuiControl. const char* GuiButtonBaseCtrl::getScriptValue (  )  [virtual] Returns the value of the variable bound to this object. Reimplemented from GuiControl. Reimplemented in GuiCheckBoxCtrl. void GuiButtonBaseCtrl::onMessage ( GuiControl *  sender, S32  msg   ) [virtual] Receive a message from another control. Reimplemented from GuiControl. void GuiButtonBaseCtrl::onAction (  )  [virtual] Occurs when this control performs its "action". Reimplemented from GuiControl. Reimplemented in GuiCheckBoxCtrl. Field Documentation StringTableEntry GuiButtonBaseCtrl::mButtonText [protected] StringTableEntry GuiButtonBaseCtrl::mButtonTextID [protected] bool GuiButtonBaseCtrl::mDepressed [protected] bool GuiButtonBaseCtrl::mMouseOver [protected] bool GuiButtonBaseCtrl::mStateOn [protected] S32 GuiButtonBaseCtrl::mButtonType [protected] S32 GuiButtonBaseCtrl::mRadioGroup [protected]

---

All Rights Reserved GarageGames.com, Inc. 1999-2005
Auto-magically Generated with Doxygen

© GarageGames.com Home Back to Top