Game Accessibility Library logo SourceForge.net Logo
Game Accessibility Suite: CATGuiObj Class Reference

CATGuiObj Class Reference
[GUI Application library for CATGUI Application library for CAT]

#include <CATGuiObj.h>

Inheritance diagram for CATGuiObj:

CATXMLObject CATSkin CATWidget CATWindow CATControl CATLayer CATWaitDlg GASPilotWindow CATButton CATControlWnd CATKnob CATLabel CATMenu CATPicture CATPictureMulti CATProgress CATSlider CATSwitch CATSwitchMulti CATComboBox CATTab

List of all members.


Detailed Description

GUI object base class.

Copyright (c) 2003-2008 by Michael Ellison. See COPYING.txt for the Game Accessibility Suite [GAS] License (MIT License).

Definition at line 31 of file CATGuiObj.h.


Public Member Functions

 CATGuiObj (const CATString &element, const CATString &rootDir)
 Constructor - mirrors CATXMLObject() constructor for now.
virtual ~CATGuiObj ()
virtual CATString GetName () const
 GetName() retrieves the name of the control.
virtual CATString GetHint () const
 GetHint() retrieves the hint text for the control.
virtual CATResult OnEvent (const CATEvent &event, CATInt32 &retVal)
 OnEvent() is called when events occur that we should know about.
virtual void MarkDirty (CATRect *dirtyRect=0, bool force=false)
virtual CATRect GetRect ()
virtual CATRect GetRectAbs (bool screenCoordinates=false)
virtual CATResult Load (CATPROGRESSCB progressCB=0, void *progressParam=0, CATFloat32 progMin=0.0f, CATFloat32 progMax=1.0f)
 Load() loads the skin in.
virtual CATResult RectFromAttribs ()
virtual void GetMinMax (CATInt32 &minWidth, CATInt32 &minHeight, CATInt32 &maxWidth, CATInt32 &maxHeight)
virtual bool IsEnabled () const
virtual void SetEnabled (bool enabled)
virtual bool IsVisible (const CATGuiObj *object=0) const
virtual void SetVisible (bool visible)
virtual CATWindowGetWindow () const
virtual CATControlHitTest (const CATPOINT &point)
virtual bool ForEachControl (CATCONTROLFUNCB callback, void *userParam)
virtual CATGuiObjFind (const CATString &objectName, const CATString &objectType=L"")
virtual bool GetPostRects (CATStack< CATRect > &rectStack)
virtual void OnCommand (CATCommand &command, CATControl *ctrl)
virtual CATResult ParseAttributes ()
 ParseAttributes() parses the known attributes for an object.
virtual CATAccessibleGetAccessible ()
 Retrieve an accessible object, create one if needed.
virtual CATUInt32 GetAccessRole ()
virtual CATUInt32 GetAccessState ()

Protected Member Functions

CATResult LoadSkinImage (const CATString &filename, CATImage *&imagePtr)
 LoadSkinImage() loads an image from the skin.

Protected Attributes

CATAccessiblefAccessible
 Accessible interface.
CATString fRootDir
 Root directory of skin.
CATString fName
 Name of control.
CATString fHintText
 Hint text for control (for status bar).
CATImagefImage
 Normal image for control.
CATRect fRect
CATInt32 fMinWidth
CATInt32 fMinHeight
CATInt32 fMaxWidth
CATInt32 fMaxHeight
bool fEnabled
 fEnabled is true if the control is enabled, and false otherwise.
bool fVisible
 fVisible is true if the window is visible
bool fShowHintValue
 Show the value of the control in the hint?
CATColor fForegroundColor
 Foreground color.
CATColor fBackgroundColor
 Background color.

The documentation for this class was generated from the following files:
Generated on Mon Feb 11 04:10:30 2008 for Game Accessibility Suite by doxygen 1.5.4