CSelectableDialogSwitcher Class Reference

Inheritance diagram for CSelectableDialogSwitcher:

Public Member Functions
	CSelectableDialogSwitcher (IPMUnknown *boss)
virtual void	ReadWrite (IPMStream *s, ImplementationID prop)
virtual void	SwitchDialogPanel (int32 dialogNumber, bool16 validate=kTrue)
virtual void	SwitchDialogPanelByID (WidgetID panelsWidgetID)
virtual void	AddDialogPanel (IControlView *dialogPanel, const PMString &panelName, int32 at=-1, bool16 autoVisible=kTrue)
virtual IControlView *	GetDialogPanel (WidgetID panelsWidgetID)
virtual void	SetDialogServiceID (const ServiceID &dialogServiceID, const WidgetID dialogGroupPanelWidgetID=kDialogGroupPanelWidgetID, const WidgetID dialogSelectionWidgetID=kSelectDialogSelectionWidgetID, const WidgetID dialogTitleTextWidgetID=kSelectDialogTitleTextWidgetID)
virtual ServiceID	GetDialogServiceID () const
virtual WidgetID	GetGroupPanelWidgetID () const
virtual WidgetID	GetSelectionListWidgetID () const
virtual WidgetID	GetTitleTextWidgetID () const
virtual IPanelControlData *	QueryGroupPanelControlData ()
virtual void	LoadDialogPanels ()
virtual void	ShowDialogPanel (const WidgetID panelWidgetID, const bool16 show=kTrue)
virtual int32	GetCurrentPanelIndex () const
virtual void	HideNonAutoShownPanels ()
virtual WidgetID	GetPanelWidgetID (int32 index) const
virtual bool16	GetAutoResizable () const
virtual void	SetAutoResizable (const bool16 bAutoSize)
virtual void	RemoveDialogPanel (IControlView *dialogPanel)
virtual int32	GetDialogPanelIndex (WidgetID panelWidgetID) const
virtual int32	GetNumDialogPanels () const
virtual void	UnloadDialogPanels ()
virtual bool16	SetKeyFocusToSelectionList ()

Protected Member Functions
virtual void	ShowHideDialogPanel (int32 dialogNumber, bool16 showPanel)
virtual void	SelectionWidgetAddString (const PMString &newString, int32 at=IStringListControlData::kEnd, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)
virtual void	SelectionWidgetClear (bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)
virtual PMString	SelectionWidgetGetString (int32 index) const
virtual int32	SelectionWidgetLength () const
virtual void	SelectionWidgetRemoveString (int32 index, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)
virtual void	SelectionWidgetSelect (int32 index, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)
virtual void	RebuildIfNecessary ()
virtual void	UpdateTitleTextString (int32 dialogNumber)
virtual int32	GetPanelIndexInDialog (const int32 &panelIndex) const
virtual bool16	GetPanelAutoVisible (const int32 &index) const
virtual void	GetAdjustedPanelPosition (IControlView *panel, const K2Vector< ClassID > &panelIDs, int32 &panelPosition)
virtual void	ReadWriteDialogPanel (IPMStream *s, K2Vector< DialogPanelEntry > &dialogPanelList)
void	CustomLoadDialogPanel (bool skipAddRomanPanel=kFalse)

Protected Attributes
int32	fCurrentDialogPanelIndex
bool16	fSwitchingPanels
ServiceID	fDialogServiceID
bool16	fPanelsLoaded
WidgetID	fGroupPanelWidgetID
WidgetID	fSelectionWidgetID
WidgetID	fTitleTextWidgetID
K2Vector< DialogPanelEntry >	fDialogPanelList
bool16	fPanelsInitialized
bool16	fAutoResizable

Additional Inherited Members
Public Types inherited from ISelectableDialogSwitcher
enum	{ kDefaultIID = IID_ISELECTABLEDIALOGSWITCHER }
enum	{ kNextPanel = -1, kPreviousPanel = -2 }

Member Function Documentation

virtual void CSelectableDialogSwitcher::AddDialogPanel ( IControlView *  dialogPanel, const PMString &  panelName, int32  at = -1, bool16  autoVisible = kTrue  )

virtual

Adds the dialog panel to the selectable dialog. "at" specifies the position of the panel relative to the others. If "at" is -1, the panel is appended to the end of the list of panels. If autoVisible is true, the panel is added to the dialog's selection list.

Implements ISelectableDialogSwitcher.

virtual bool16 CSelectableDialogSwitcher::GetAutoResizable ( ) const

virtual

Does the parent panel auto-resize in height as you switch to each panel.

Implements ISelectableDialogSwitcher.

virtual int32 CSelectableDialogSwitcher::GetCurrentPanelIndex ( ) const

virtual

Returns the index of the currently displayed panel.

Implements ISelectableDialogSwitcher.

virtual IControlView* CSelectableDialogSwitcher::GetDialogPanel ( WidgetID  panelsWidgetID )

virtual

Finds the dialog panel in the selectable dialog.

Implements ISelectableDialogSwitcher.

virtual int32 CSelectableDialogSwitcher::GetDialogPanelIndex ( WidgetID  panelWidgetID ) const

virtual

Given the dialog panel's WidgetID, return its current position in the panel list.

Implements ISelectableDialogSwitcher.

virtual ServiceID CSelectableDialogSwitcher::GetDialogServiceID ( ) const

virtual

Gets the service ID for this dialog.

Implements ISelectableDialogSwitcher.

virtual WidgetID CSelectableDialogSwitcher::GetGroupPanelWidgetID ( ) const

virtual

Gets the widget ID of the group panel that holds the dialog panels.

Implements ISelectableDialogSwitcher.

virtual int32 CSelectableDialogSwitcher::GetNumDialogPanels ( ) const

virtual

Returns the number of selectable dialog panels.

Implements ISelectableDialogSwitcher.

virtual WidgetID CSelectableDialogSwitcher::GetPanelWidgetID ( int32  index ) const

virtual

Given an index to a panel, this function returns the widget id of the panel.

Implements ISelectableDialogSwitcher.

virtual WidgetID CSelectableDialogSwitcher::GetSelectionListWidgetID ( ) const

virtual

Gets the widget ID of the list box used to select the dialog panels.

Implements ISelectableDialogSwitcher.

virtual WidgetID CSelectableDialogSwitcher::GetTitleTextWidgetID ( ) const

virtual

Gets the widget ID of the TextWidget that is to display the name of the currently active dialog panel.

Implements ISelectableDialogSwitcher.

virtual void CSelectableDialogSwitcher::HideNonAutoShownPanels ( )

virtual

Call this function when the selectable dialog is closed to hide any non auto shown panels that were made visible after the dialog was opened.

Implements ISelectableDialogSwitcher.

virtual void CSelectableDialogSwitcher::LoadDialogPanels ( )

virtual

Forces a dynamic load of all the dialog panels associated with this selectable dialog

Implements ISelectableDialogSwitcher.

Reimplemented in BscSlDlgTreeViewDlgSwitcher.

virtual IPanelControlData* CSelectableDialogSwitcher::QueryGroupPanelControlData ( )

virtual

Returns the panel control data associated with the group panel widget. The group panel widget is the widget that holds all of the dialog sub panels.

Implements ISelectableDialogSwitcher.

virtual void CSelectableDialogSwitcher::RemoveDialogPanel ( IControlView *  dialogPanel )

virtual

Remove a dialog panel.

Implements ISelectableDialogSwitcher.

virtual void CSelectableDialogSwitcher::SetAutoResizable ( const bool16  bAutoSize )

virtual

Sets auto-resize for parent panel.

Implements ISelectableDialogSwitcher.

virtual void CSelectableDialogSwitcher::SetDialogServiceID ( const ServiceID &  dialogServiceID, const WidgetID  dialogGroupPanelWidgetID = kDialogGroupPanelWidgetID, const WidgetID  dialogSelectionWidgetID = kSelectDialogSelectionWidgetID, const WidgetID  dialogTitleTextWidgetID = kSelectDialogTitleTextWidgetID  )

virtual

Set the service ID for this dialog. Used to find the sub dialog panels

Implements ISelectableDialogSwitcher.

virtual void CSelectableDialogSwitcher::ShowDialogPanel ( const WidgetID  panelWidgetID, const bool16  show = kTrue  )

virtual

Call ShowDialogPanel to show a dialog panel and add its name to the selectable dialog's selection list.

Implements ISelectableDialogSwitcher.

virtual void CSelectableDialogSwitcher::SwitchDialogPanel ( int32  dialogNumber, bool16  validate = kTrue  )

virtual

Changes the displayed dialog panel to that of dialogNumber. Normally, validation takes place on the panel that will get hidden. Validation can be turned off by passing in false. Pass in "kNextPanel" to switch to the next panel or "kPreviousPanel" to go to the previous panel.

Implements ISelectableDialogSwitcher.

virtual void CSelectableDialogSwitcher::SwitchDialogPanelByID ( WidgetID  panelsWidgetID )

virtual

Changes the displayed dialog panel to the panel with the specified widget id.

Implements ISelectableDialogSwitcher.

virtual void CSelectableDialogSwitcher::UnloadDialogPanels ( )

virtual

Forces a dynamic unload of all the dialog panels associated with this selectable dialog

Implements ISelectableDialogSwitcher.