InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IDynPnPanelManager Class Referenceabstract

#include <IDynPnPanelManager.h>

Inheritance diagram for IDynPnPanelManager:
IPMUnknownCPMUnknown< IDynPnPanelManager >DynPnPanelManager

Public Types

enum  { kDefaultIID = IID_IDynPnPANELMANAGER }
 

Public Member Functions

virtual int32 GetPanelsCreatedCount ()=0
 
virtual ErrorCode Create (const PMString &name)=0
 
virtual ErrorCode Destroy (const PMString &name)=0
 
virtual bool16 IsShowing (const PMString &name)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Static Public Member Functions

static IDynPnPanelManagerQueryDynamicPanelManager ()
 

Detailed Description

From SDK sample; interface to instantiate the (singleton) dynamic panel manager; also methods to create and destroy dynamic panels, and query their properties. There is a singleton dynamic panel manager boss object, which is created on demand the first time that QueryDynamicPanelManager is called.

Member Function Documentation

virtual ErrorCode IDynPnPanelManager::Create (const PMStringname)
pure virtual

Create the named panel if it doesn't already exist

Returns
kSuccess if operation completed successfully, kFailure otherwise

Implemented in DynPnPanelManager.

virtual ErrorCode IDynPnPanelManager::Destroy (const PMStringname)
pure virtual

Destroy the named panel if it can be destroyed

Returns
kSuccess if operation completed successfully, kFailure otherwise

Implemented in DynPnPanelManager.

virtual int32 IDynPnPanelManager::GetPanelsCreatedCount ()
pure virtual

Accessor for the count of (persistent) panels created to date

Returns
int32

Implemented in DynPnPanelManager.

virtual bool16 IDynPnPanelManager::IsShowing (const PMStringname)
pure virtual

Determine if named panel is showing

Parameters
namespecifies the panel whose visibility we're interested in
Returns
bool16

Implemented in DynPnPanelManager.

IDynPnPanelManager * IDynPnPanelManager::QueryDynamicPanelManager ()
static

Class (static) method to allow instance of our dynamic panel manager to be obtained

Returns
reference to the singleton dynamic panel manager