torque Torque Game Engine Documentation
TGE Version 1.5.2
Torque Home   Class Hierarchy   Data Structures   Namespaces   Namespace Members   File List   Globals

GuiMenuBar Class Reference

#include <guiMenuBar.h>

Inheritance diagram for GuiMenuBar:

Inheritance graph
[legend]

Public Member Functions

 GuiMenuBar ()
bool onWake ()
 Called when this object is asked to wake up returns true if it's actually awake at the end.
void onSleep ()
 Called when this object is asked to sleep.
void addMenu (const char *menuText, U32 menuId)
Menu * findMenu (const char *menu)
MenuItem * findMenuItem (Menu *menu, const char *menuItem)
void removeMenu (Menu *menu)
void removeMenuItem (Menu *menu, MenuItem *menuItem)
void addMenuItem (Menu *menu, const char *text, U32 id, const char *accelerator, S32 checkGroup)
void clearMenuItems (Menu *menu)
void clearMenus ()
MenuItem * findSubmenuItem (Menu *menu, const char *menuItem, const char *submenuItem)
void addSubmenuItem (Menu *menu, MenuItem *submenu, const char *text, U32 id, const char *accelerator, S32 checkGroup)
void removeSubmenuItem (MenuItem *menuItem, MenuItem *submenuItem)
void clearSubmenuItems (MenuItem *menuitem)
void onSubmenuAction (S32 selectionIndex, RectI bounds, Point2I cellSize)
void closeSubmenu ()
void checkSubmenuMouseMove (const GuiEvent &event)
MenuItem * findHitMenuItem (Point2I mousePoint)
void highlightedMenuItem (S32 selectionIndex, RectI bounds, Point2I cellSize)
Menu * findHitMenu (Point2I mousePoint)
void onPreRender ()
 Do special pre-render proecessing.
void onRender (Point2I offset, const RectI &updateRect)
 Called when this control is to render itself.
void checkMenuMouseMove (const GuiEvent &event)
void onMouseMove (const GuiEvent &event)
void onMouseLeave (const GuiEvent &event)
void onMouseDown (const GuiEvent &event)
void onMouseDragged (const GuiEvent &event)
void onMouseUp (const GuiEvent &event)
void onAction ()
 Occurs when this control performs its "action".
void closeMenu ()
void buildAcceleratorMap ()
 Adds this control's accelerator key to the accelerator map, and recursively tells all children to do the same.
void acceleratorKeyPress (U32 index)
 Occurs when the accelerator key for this control is pressed.
void menuItemSelected (Menu *menu, MenuItem *item)
void processTick ()
 This method is called once every 32ms if isProcessingTicks returns true when called on the object.
 DECLARE_CONOBJECT (GuiMenuBar)

Static Public Member Functions

static void initPersistFields ()
 Register dynamic fields in a subclass of ConsoleObject.

Data Fields

GuiMenuBackgroundCtrl * mBackground
GuiMenuTextListCtrl * mTextList
GuiSubmenuBackgroundCtrl * mSubmenuBackground
GuiMenuTextListCtrl * mSubmenuTextList
Menu * menuList
Menu * mouseDownMenu
Menu * mouseOverMenu
MenuItem * mouseDownSubmenu
MenuItem * mouseOverSubmenu
bool menuBarDirty
U32 mCurAcceleratorIndex
Point2I maxBitmapSize
S32 mCheckmarkBitmapIndex
S32 mPadding
S32 mHorizontalMargin
S32 mVerticalMargin
S32 mBitmapMargin
S32 mMouseOverCounter
bool mCountMouseOver
S32 mMouseHoverAmount

Private Types

typedef GuiTickCtrl Parent

Data Structures

struct  Menu
struct  MenuItem

Member Typedef Documentation

typedef GuiTickCtrl GuiMenuBar::Parent [private]

Reimplemented from GuiTickCtrl.

Constructor & Destructor Documentation

GuiMenuBar::GuiMenuBar (  ) 

Member Function Documentation

bool GuiMenuBar::onWake (  )  [virtual]

Called when this object is asked to wake up returns true if it's actually awake at the end.

Reimplemented from GuiControl.

void GuiMenuBar::onSleep (  )  [virtual]

Called when this object is asked to sleep.

Reimplemented from GuiControl.

void GuiMenuBar::addMenu ( const char *  menuText,
U32  menuId 
)

Menu* GuiMenuBar::findMenu ( const char *  menu  ) 

MenuItem* GuiMenuBar::findMenuItem ( Menu *  menu,
const char *  menuItem 
)

void GuiMenuBar::removeMenu ( Menu *  menu  ) 

void GuiMenuBar::removeMenuItem ( Menu *  menu,
MenuItem *  menuItem 
)

void GuiMenuBar::addMenuItem ( Menu *  menu,
const char *  text,
U32  id,
const char *  accelerator,
S32  checkGroup 
)

void GuiMenuBar::clearMenuItems ( Menu *  menu  ) 

void GuiMenuBar::clearMenus (  ) 

MenuItem* GuiMenuBar::findSubmenuItem ( Menu *  menu,
const char *  menuItem,
const char *  submenuItem 
)

void GuiMenuBar::addSubmenuItem ( Menu *  menu,
MenuItem *  submenu,
const char *  text,
U32  id,
const char *  accelerator,
S32  checkGroup 
)

void GuiMenuBar::removeSubmenuItem ( MenuItem *  menuItem,
MenuItem *  submenuItem 
)

void GuiMenuBar::clearSubmenuItems ( MenuItem *  menuitem  ) 

void GuiMenuBar::onSubmenuAction ( S32  selectionIndex,
RectI  bounds,
Point2I  cellSize 
)

void GuiMenuBar::closeSubmenu (  ) 

void GuiMenuBar::checkSubmenuMouseMove ( const GuiEvent &  event  ) 

MenuItem* GuiMenuBar::findHitMenuItem ( Point2I  mousePoint  ) 

void GuiMenuBar::highlightedMenuItem ( S32  selectionIndex,
RectI  bounds,
Point2I  cellSize 
)

Menu* GuiMenuBar::findHitMenu ( Point2I  mousePoint  ) 

void GuiMenuBar::onPreRender (  )  [virtual]

Do special pre-render proecessing.

Reimplemented from GuiControl.

void GuiMenuBar::onRender ( Point2I  offset,
const RectI &  updateRect 
) [virtual]

Called when this control is to render itself.

Parameters:
offset The location this control is to begin rendering
updateRect The screen area this control has drawing access to

Reimplemented from GuiControl.

void GuiMenuBar::checkMenuMouseMove ( const GuiEvent &  event  ) 

void GuiMenuBar::onMouseMove ( const GuiEvent &  event  )  [virtual]

Reimplemented from GuiControl.

void GuiMenuBar::onMouseLeave ( const GuiEvent &  event  )  [virtual]

Reimplemented from GuiControl.

void GuiMenuBar::onMouseDown ( const GuiEvent &  event  )  [virtual]

Reimplemented from GuiControl.

void GuiMenuBar::onMouseDragged ( const GuiEvent &  event  )  [virtual]

Reimplemented from GuiControl.

void GuiMenuBar::onMouseUp ( const GuiEvent &  event  )  [virtual]

Reimplemented from GuiControl.

void GuiMenuBar::onAction (  )  [virtual]

Occurs when this control performs its "action".

Reimplemented from GuiControl.

void GuiMenuBar::closeMenu (  ) 

void GuiMenuBar::buildAcceleratorMap (  )  [virtual]

Adds this control's accelerator key to the accelerator map, and recursively tells all children to do the same.

Reimplemented from GuiControl.

void GuiMenuBar::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 GuiMenuBar::menuItemSelected ( Menu *  menu,
MenuItem *  item 
)

void GuiMenuBar::processTick (  )  [virtual]

This method is called once every 32ms if isProcessingTicks returns true when called on the object.

Reimplemented from GuiTickCtrl.

static void GuiMenuBar::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

See also:
addField(), addFieldV(), addDepricatedField(), addGroup(), endGroup()

Reimplemented from GuiControl.

GuiMenuBar::DECLARE_CONOBJECT ( GuiMenuBar   ) 

Field Documentation

GuiMenuBackgroundCtrl* GuiMenuBar::mBackground

GuiMenuTextListCtrl* GuiMenuBar::mTextList

GuiSubmenuBackgroundCtrl* GuiMenuBar::mSubmenuBackground

GuiMenuTextListCtrl* GuiMenuBar::mSubmenuTextList

Menu* GuiMenuBar::menuList

Menu* GuiMenuBar::mouseDownMenu

Menu* GuiMenuBar::mouseOverMenu

MenuItem* GuiMenuBar::mouseDownSubmenu

MenuItem* GuiMenuBar::mouseOverSubmenu

bool GuiMenuBar::menuBarDirty

U32 GuiMenuBar::mCurAcceleratorIndex

Point2I GuiMenuBar::maxBitmapSize

S32 GuiMenuBar::mCheckmarkBitmapIndex

S32 GuiMenuBar::mPadding

S32 GuiMenuBar::mHorizontalMargin

S32 GuiMenuBar::mVerticalMargin

S32 GuiMenuBar::mBitmapMargin

S32 GuiMenuBar::mMouseOverCounter

bool GuiMenuBar::mCountMouseOver

S32 GuiMenuBar::mMouseHoverAmount



All Rights Reserved GarageGames.com, Inc. 1999-2005
Auto-magically Generated with Doxygen
© GarageGames.com Home Back to Top