#include <IPanelControlData.h>

Inheritance diagram for IPanelControlData:

Public Types
enum	{ kDefaultIID = IID_IPANELCONTROLDATA }

Public Member Functions
Maintenance
virtual void	AddWidget (IControlView *w, int32 at=-1, bool16 invalidate=kTrue)=0

virtual void	RemoveWidget (IControlView *w, bool16 invalidate=kTrue, bool16 deleteUID=kFalse)=0

virtual void	MoveWidget (IControlView *w, int32 at, bool16 invalidate=kTrue)=0

virtual void	RemoveWidget (int32 index, bool16 invalidate=kTrue, bool16 deleteUID=kFalse)=0

virtual void	ReleaseAll (bool16 deleteUID=kTrue)=0

Notification
virtual void	WidgetAttributeChanged (IControlView *view, const WidgetAttributeID &id)=0

Keyboard Focus
virtual void	SetKeyboardFocus (const WidgetID &widgetId)=0

virtual void	SetKeyboardFocus (const IControlView *widget)=0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Inquisition
enum	{ kSearchLevel_Invalid = 0, kSearchLevel_Self = 1, kSearchLevel_SelfAndChildren = 2, kSearchLevel_SelfChildrenAndGrandchildren = 3, kSearchLevel_SelfChildrenGrandchildrenAndGreatgrandchildren = 4, kSearchLevel_AllDescendants = 9999 }

virtual IControlView *	GetWidget (int32 index) const =0

virtual IControlView *	FindWidget (const WidgetID &widgetId, int16 searchLevels=kSearchLevel_AllDescendants) const =0

virtual IControlView *	FindWidget (const SysPoint &windowPt, int16 searchLevels=kSearchLevel_AllDescendants) const =0

virtual bool16	GetWidgetVisibleState (int32 index) const =0

virtual bool16	IsWidgetInstantiated (int32 index) const =0

virtual int32	GetIndex (const IControlView *w) const =0

virtual int32	Length () const =0

Detailed Description

Interface that container widgets implement

Member Function Documentation

virtual void IPanelControlData::AddWidget	(	IControlView *	w,
		int32	at = `-1`,
		bool16	invalidate = `kTrue`
	)

pure virtual

Add a child widget at position 'at'. If 'at' is -1 the widget is added at the end of the of the child widget list.

virtual IControlView* IPanelControlData::FindWidget	(	const WidgetID &	widgetId,
		int16	searchLevels = `kSearchLevel_AllDescendants`
	)		const

pure virtual

Recursively find the widget whose widget id is 'widgetId'. Only search 'searchLevels' deep.

virtual IControlView* IPanelControlData::FindWidget	(	const SysPoint &	windowPt,
		int16	searchLevels = `kSearchLevel_AllDescendants`
	)		const

pure virtual

Recursively find the widget that windowPt falls within. Only search 'searchLevels' deep.

virtual int32 IPanelControlData::GetIndex ( const IControlView * w ) const

pure virtual

Get the position of widget 'w'.

virtual IControlView* IPanelControlData::GetWidget ( int32 index ) const

pure virtual

Return the widget whose position in the widget list is 'index'.

virtual bool16 IPanelControlData::GetWidgetVisibleState ( int32 index ) const

pure virtual

Returns the widgets visible state flag.

virtual bool16 IPanelControlData::IsWidgetInstantiated ( int32 index ) const

pure virtual

Returns true if the widget is currently instantiated.

virtual int32 IPanelControlData::Length ( ) const

pure virtual

Return the number of child widgets.

virtual void IPanelControlData::MoveWidget	(	IControlView *	w,
		int32	at,
		bool16	invalidate = `kTrue`
	)

pure virtual

Move the widget 'w' to a new position in the child widget list. Does not change parent or reattach observers. 0 would move to start of list, 1 to next position, etc. -1 can be used to move widget to the end of the list.

virtual void IPanelControlData::ReleaseAll ( bool16 deleteUID = kTrue )

pure virtual

Release all widgets.

virtual void IPanelControlData::RemoveWidget	(	IControlView *	w,
		bool16	invalidate = `kTrue`,
		bool16	deleteUID = `kFalse`
	)

pure virtual

Remove widget 'w'.

virtual void IPanelControlData::RemoveWidget	(	int32	index,
		bool16	invalidate = `kTrue`,
		bool16	deleteUID = `kFalse`
	)

pure virtual

Remove widget at position 'index'.

virtual void IPanelControlData::SetKeyboardFocus ( const WidgetID & widgetId )

pure virtual

Sets the keyboard focus to the specified widget

virtual void IPanelControlData::SetKeyboardFocus ( const IControlView * widget )

pure virtual

Sets the keyboard focus to the specified widget. controlView, passed must be one of its children.

virtual void IPanelControlData::WidgetAttributeChanged	(	IControlView *	view,
		const WidgetAttributeID &	id
	)

pure virtual

Called by child widget when one of its attributes changes. Only a small set of 'interesting' attrubutes are defined. See WidgetID.h.

Public Types

Public Member Functions

Inquisition

Detailed Description

Member Function Documentation