IPanelCreator Class Reference

#include <IPanelCreator.h>

Inheritance diagram for IPanelCreator:

Public Member Functions
virtual IControlView *	CreatePanel (const ServiceID dialogServiceID, bool16 isDialogPanel=kFalse)=0
virtual IControlView *	CreatePanelForDialog (const ServiceID dialogServiceID)=0
virtual void	GetServiceIDs (K2Vector< ServiceID > &serviceIDs)=0
virtual RsrcID	GetPanelRsrcID () const =0
virtual bool16	AutoShowPanel () 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 is required to be implemented when adding panels to selectable dialog.

Member Function Documentation

virtual bool16 IPanelCreator::AutoShowPanel ( ) const

pure virtual

Determine whether panel created should be made visible when dialog in service ID list is shown.

If AutoShowPanel returns true, the panel created by this class is automatically made visible whenever a selectable dialog that this class has registered for (via GetServiceIDs()) is opened. If AutoShowPanel returns false, the panel is not made visible nor is listed in the popup and it will have to be shown by calling ISelectableDialogSwitcher::ShowDialogPanel().

Returns

kTrue if panel should be created when a dialog in the list of service IDs is shown

Implemented in CPanelCreator.

virtual IControlView* IPanelCreator::CreatePanel ( const ServiceID  dialogServiceID, bool16  isDialogPanel = kFalse  )

pure virtual

Creates the panel.

Parameters

dialogServiceID

the service id of the dialog that the panel is being created for.

Implemented in CPanelCreator.

virtual IControlView* IPanelCreator::CreatePanelForDialog ( const ServiceID  dialogServiceID )

pure virtual

Creates the Dialog panel (for Selectable Dialogs, etc).

Parameters

dialogServiceID

the service id of the dialog that the panel is being created for.

Implemented in CPanelCreator.

virtual RsrcID IPanelCreator::GetPanelRsrcID ( ) const

pure virtual

Returns the resource id of the panel that is used in finding the service ids resource and the panel view resource.

Returns

resource ID of panel for resources.

Implemented in CPanelCreator, YangPanelCreator, YinPanelCreator, and XDocBkUIPanelCreator.

virtual void IPanelCreator::GetServiceIDs ( K2Vector< ServiceID > &  serviceIDs )

pure virtual

Returns list of serviceIDs of selectable dialogs that this dialog panel can be installed in.

Parameters

serviceIDs

OUT parameter holding list of selectable dialog service IDs that this panel can be installed in

Implemented in CPanelCreator.