CAUGuiMan Class Reference

CAUGui Manager object. More...

#include <CAUGui.h>

List of all members.

Public Member Functions
	CAUGuiMan (AUCarbonViewBase *, UInt32 x, UInt32 y)
	construct CAUGui Manager object
	~CAUGuiMan ()
	destroy CAUGui Manager object
void	initialize ()
	post constructor
void	addImage (CAUGuiGraphic *theImage)
	adding a Graphics object
CAUGuiGraphic *	getImageByID (UInt32 theID)
	getting a Graphics object from it's ID (see CAUGuiItem)
void	addCtrl (CAUGuiCtrl *theCtrl)
	adding a Control object
CAUGuiCtrl *	getCtrlByID (UInt32 theID)
	getting a Control object from it's ID (see CAUGuiItem)
CAUGuiCtrl *	getCtrlByControlRef (ControlRef theControl)
	getting a Control object from it's ControlRef (used by event handler)
CAUGuiCtrl *	getControls ()
	getting the linked list (CAUGuiItem) of controls
void	setRelaxed (bool r)
	set this to true if you're in User thread to prevent unnecessary redraws
bool	isRelaxed (void)
	how urgent is a redraw?
AUCarbonViewBase *	getAUCarbonViewBase ()
	sometimes you have to deal with the AUCarbonViewBase, for instance in C-callbacks
void	requestInternalParameters ()
	set up internal Parameter Scheme (not elegant, direct pointers, but works so far)
float	getInternalParameter (int index)
	get value from an internal Parameter
void	idle ()
	the timer based idle function, triggers those of control objects
UInt32	requestID (void)
	CAUGuiItems ask for unique ids. Not much use yet, but who knows...
Public Attributes
UInt32	X
UInt32	Y

---

Detailed Description

CAUGui Manager object.

This object is your basic assistant for everything related to CAUGui

You won't be much in touch with it. Everything you do is having an instance of it in your GUI class. The other thing is, you have to pass it the topmost Panes of your user interface and all your graphics. It then deals with their lifetime and connects control objects to corresponding Carbon APIs and CoreAudio base classes.

It also cares about idle timers and stuff.

Definition at line 94 of file CAUGui.h.

---

Constructor & Destructor Documentation

CAUGuiMan::CAUGuiMan (  AUCarbonViewBase *  , UInt32  x, UInt32  y )

construct CAUGui Manager object in AUCarbonViewBase::CreateUI you pass it this (your GUI class derived form AUCarbonViewBase) and the x, y parameter of CreateUI Definition at line 24 of file CAUGui.cpp. References numConstructions, X, and Y.

CAUGuiMan::~CAUGuiMan (   )

destroy CAUGui Manager object destroy the CAUGuiMan in your GUI class's destructor and it cleans up all your GUI objects. If you have instances of Objects in your GUI class that are also passed to CAUGuiMan (either by directly passing it via add methods or indirectly by those of Controls), just set them to NULL. DON'T DELETE OBJECTS THAT ARE OBSERVED BY CAUGuiMan!!! Definition at line 51 of file CAUGui.cpp.

---

Member Function Documentation

void CAUGuiMan::addCtrl (  CAUGuiCtrl *  theCtrl  )

adding a Control object Definition at line 199 of file CAUGui.cpp. References CAUGuiItem::append(), CAUGuiCtrl::getAUVP(), CAUGuiCtrl::getBounds(), CAUGuiCtrl::getDaddy(), CAUGuiCtrl::getRange(), CAUGuiCtrl::getResolution(), CAUGuiCtrl::initForeignControls(), CAUGuiCtrl::isAUVPattached(), CAUGuiCtrl::providesForeignControls(), requestID(), CAUGuiCtrl::setCarbonControl(), CAUGuiItem::setID(), X, and Y. Referenced by CAUGuiLayeredPane::addCtrl(), CAUGuiCtrl::addCtrl(), and CAUGuiLayeredPane::addCtrlToGroup().

void CAUGuiMan::addImage (  CAUGuiGraphic *  theImage  )

adding a Graphics object Definition at line 177 of file CAUGui.cpp. References CAUGuiItem::append(), requestID(), and CAUGuiItem::setID().

AUCarbonViewBase* CAUGuiMan::getAUCarbonViewBase (   )  [inline]

sometimes you have to deal with the AUCarbonViewBase, for instance in C-callbacks Definition at line 149 of file CAUGui.h. Referenced by CAUGuiPane::initForeignControls().

CAUGuiCtrl* CAUGuiMan::getControls (   )  [inline]

getting the linked list (CAUGuiItem) of controls Definition at line 138 of file CAUGui.h.

CAUGuiCtrl * CAUGuiMan::getCtrlByControlRef (  ControlRef  theControl  )

getting a Control object from it's ControlRef (used by event handler) Definition at line 278 of file CAUGui.cpp. References CAUGuiCtrl::getChild(), CAUGuiItem::getNext(), and CAUGuiCtrl::isControlRef(). Referenced by CAUGuiControlHandler().

CAUGuiCtrl * CAUGuiMan::getCtrlByID (  UInt32  theID  )

getting a Control object from it's ID (see CAUGuiItem) Definition at line 270 of file CAUGui.cpp. References CAUGuiItem::getByID().

CAUGuiGraphic * CAUGuiMan::getImageByID (  UInt32  theID  )

getting a Graphics object from it's ID (see CAUGuiItem) Definition at line 190 of file CAUGui.cpp. References CAUGuiItem::getByID().

float CAUGuiMan::getInternalParameter (  int  index  )

get value from an internal Parameter Definition at line 136 of file CAUGui.cpp. References requestInternalParameters(). Referenced by CAUGuiMeter::idle().

void CAUGuiMan::idle (   )

the timer based idle function, triggers those of control objects Definition at line 149 of file CAUGui.cpp. References CAUGuiCtrl::idle(), and setRelaxed().

void CAUGuiMan::initialize (   )

post constructor Definition at line 72 of file CAUGui.cpp. References TimerProc().

bool CAUGuiMan::isRelaxed (  void   )  [inline]

how urgent is a redraw? Definition at line 146 of file CAUGui.h. Referenced by CAUGuiCtrl::mustUpdate().

UInt32 CAUGuiMan::requestID (  void   )

CAUGuiItems ask for unique ids. Not much use yet, but who knows... Definition at line 298 of file CAUGui.cpp. Referenced by addCtrl(), and addImage().

void CAUGuiMan::requestInternalParameters (   )

set up internal Parameter Scheme (not elegant, direct pointers, but works so far) Definition at line 114 of file CAUGui.cpp. References kInternalParameterProperyID, and kNumInternalParameters. Referenced by getInternalParameter().

void CAUGuiMan::setRelaxed (  bool  r  )  [inline]

set this to true if you're in User thread to prevent unnecessary redraws Definition at line 143 of file CAUGui.h. Referenced by CAUGuiControlHandler(), and idle().

---

Member Data Documentation

UInt32 CAUGuiMan::X

Definition at line 163 of file CAUGui.h. Referenced by addCtrl(), and CAUGuiMan().

UInt32 CAUGuiMan::Y

Definition at line 164 of file CAUGui.h. Referenced by addCtrl(), and CAUGuiMan().

---

The documentation for this class was generated from the following files:

• CAUGui.h
• CAUGui.cpp

(c) 2002 - 2003 by Urs Heckmann www.u-he.com