IControlSet Class Reference

#include <IControlSet.h>

Inheritance diagram for IControlSet:

Public Types
enum	{ kDefaultIID = IID_ICONTROLSET }

Public Member Functions
virtual int32	VisibleSetCount ()=0
virtual int32	TotalSetCount ()=0
virtual void	ShowSets (K2Vector< int32 >)=0
virtual void	ShowSets ()=0
virtual void	Initialize (bool16 bCreateMenuButton=kFalse)=0
virtual bool16	IsCustomizable ()=0
virtual void	GetVisibleControlSets (K2Vector< int32 > &sets) const =0
virtual void	SetVisibleControlSets (K2Vector< int32 > sets)=0
virtual void	ResetVisibleControlSets ()=0
virtual IControlView *	GetNthControlSet (const int32 index) const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Interface that represents a set of controls, one or more of which can be visible at a time. IControlSet is typically used to manage different appearances of the same UI, for example the large and small row versions of list boxes. Another example is the progressive disclosure used by some palettes.

There are subclasses for horizontal and vertical orientations (kControlSetHorzImpl, kControlSetVertImpl).

Member Function Documentation

virtual IControlView* IControlSet::GetNthControlSet ( const int32  index ) const

pure virtual

Return the nth control set (not necessary the same as the nth control view due to separator widgets).

virtual void IControlSet::GetVisibleControlSets ( K2Vector< int32 > &  sets ) const

pure virtual

Get a list of the visible control sets (by index).

Parameters

sets	OUT the list to put the visible sets in.

virtual void IControlSet::Initialize ( bool16  bCreateMenuButton = kFalse )

pure virtual

Initialize the control set's view.

virtual bool16 IControlSet::IsCustomizable ( )

pure virtual

Is the control set customizeable - only possible for InCopy.

virtual void IControlSet::ResetVisibleControlSets ( )

pure virtual

Set the visible control sets to whatever is currently visible.

virtual void IControlSet::SetVisibleControlSets ( K2Vector< int32 >  sets )

pure virtual

Set the visible control sets to those in a list (by index) - called after customize dialog finishes.

Parameters

sets	IN the list to set as visible.

virtual void IControlSet::ShowSets ( K2Vector< int32 >  )

pure virtual

Show the specified control sets

virtual void IControlSet::ShowSets ( )

pure virtual

Show the currently visible control sets

virtual int32 IControlSet::TotalSetCount ( )

pure virtual

Get the total count of control sets

virtual int32 IControlSet::VisibleSetCount ( )

pure virtual

Get the count of visible control sets