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

CATControl Class Reference
[GUI Application library for CAT]

#include <CATControl.h>

Inheritance diagram for CATControl:

CATWidget CATGuiObj CATXMLObject CATButton CATControlWnd CATKnob CATLabel CATMenu CATPicture CATPictureMulti CATProgress CATSlider CATSwitch CATSwitchMulti

List of all members.


Detailed Description

Basic Control class.

Definition at line 28 of file CATControl.h.


Public Member Functions

 CATControl (const CATString &element, const CATString &rootDir)
 Constructor - mirrors CATXMLObject() constructor for now.
virtual ~CATControl ()
virtual CATWindowGetWindow () const
 GetWindow() retrieves the parent window.
virtual CATFloat32 GetValue () const
virtual void SetString (const CATString &text)
 These by default try to convert to float. String-type controls override them.
virtual CATString GetString () const
virtual void SetValue (CATFloat32 newValue, bool sendCommand=true)
virtual void ResetValue ()
 ResetValue() resets the control to its default value.
virtual CATCommand GetCommand () const
virtual CATColor GetColorFore () const
virtual CATColor GetColorBack () const
virtual void SetColorFore (const CATColor &color)
virtual void SetColorForeDisabled (const CATColor &color)
virtual void SetColorBack (const CATColor &color)
virtual void SetColorBackDisabled (const CATColor &color)
virtual CATCursorGetCursor ()
 GetCursor() retrieves the object's mouse cursor.
virtual bool IsFocusable () const
virtual void SetFocused (bool focused)
virtual void SetActive (bool active)
virtual bool IsFocused () const
 IsFocused() returns true if the control has the current focus.
virtual bool IsPressed () const
 IsPressed() returns true ifthe control is currently pressed.
virtual bool IsActive () const
virtual void Draw (CATImage *image, const CATRect &dirtyRect)
virtual CATResult OnEvent (const CATEvent &event, CATInt32 &retVal)
 Event handler.
virtual void PostDraw (CATDRAWCONTEXT drawContext, const CATRect &dirtyRect)
virtual CATResult Load (CATPROGRESSCB progressCB=0, void *progressParam=0, CATFloat32 progMin=0.0f, CATFloat32 progMax=1.0f)
 Load() loads the skin in.
virtual void OnMouseClick ()
virtual void OnRightMouseClick ()
virtual void OnMouseDoubleClick (CATMODKEY modKey)
virtual void TrackMouseMove (const CATPOINT &point, bool leftButton, CATMODKEY modKey)
virtual void TrackMouseTimer (CATMODKEY modKey)
virtual void TrackMouseWheel (const CATPOINT &point, CATFloat32 wheelMove, CATMODKEY modKey)
virtual void TrackMouseDown (const CATPOINT &point, CATMODKEY modKey)
virtual void TrackMouseRelease (const CATPOINT &point, CATMODKEY modKey)
virtual void OnMouseWheel (const CATPOINT &point, CATFloat32 wheelMove, CATMODKEY modKey)
virtual void OnKeyDown (const CATKeystroke &keystroke)
virtual void OnKeyUp (const CATKeystroke &keystroke)
virtual void OnKeyPress (const CATKeystroke &keystroke)
virtual void OnParentCreate ()
virtual void OnParentDestroy ()
virtual void GetFontInfo (CATString &fontName, CATFloat32 &fontSize)
virtual CATControlHitTest (const CATPOINT &point)
virtual bool ForEachControl (CATCONTROLFUNCB callback, void *userParam)
virtual CATUInt32 GetAccessState ()

Static Public Member Functions

static CATString FilterGUIString (const CATString &unfiltered)

Protected Member Functions

virtual bool BoundsCheckValue ()
virtual CATFloat32 GetValPercent ()
virtual CATFloat32 GetValRange ()
virtual CATFloat32 GetMinValue ()
virtual CATFloat32 GetMaxValue ()
virtual void SetMinMax (CATFloat32 minValue, CATFloat32 maxValue)
virtual void ResetCursorToDefault ()
virtual CATResult ParseAttributes ()
 ParseAttributes() parses the known attributes for an object.
virtual CATResult CheckImageSize (CATImage *&image, const CATImage *baseImage=0)

Protected Attributes

CATFloat32 fValue
 Value of the control.
CATFloat32 fDefValue
 Default value of control.
CATFloat32 fMinValue
CATFloat32 fMaxValue
CATString fCmdString
 Command to send when control is pressed/activated.
CATString fTarget
 Target for command, if any. Empty for general commands.
CATString fCmdParam
 Additional parameter to send when control is pressed/activated.
CATString fCmdType
 Command Type (empty or "VSTParam" for vst parameters).
CATColor fFgDisColor
 Foreground disabled color.
CATColor fBgDisColor
 Background disabled color.
CATCursor fCursor
 Default Cursor for control.
CATImagefImageDisabled
 Inactive image for control.
CATImagefImagePressed
 Active/pressed image for control.
CATImagefImageFocus
 Focus image.
CATImagefImageActive
 MouseOver image for control.
CATString fText
bool fAutoScaleText
bool fTextCentered
CATPOINT fTextOffset
CATPOINT fTextOffsetPressed
bool fShowBg
bool fMultiline
CATString fFontName
CATFloat32 fFontSize
bool fPressed
 Is the control pressed (mouse currently down on it) ?
bool fFocused
 Is the control focused?
bool fActive
 Is the control active (mouse over)?

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