InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
PstLstDocServiceProvider Class Reference
Inheritance diagram for PstLstDocServiceProvider:
CServiceProviderIK2ServiceProviderIPMUnknown

Public Member Functions

 PstLstDocServiceProvider (IPMUnknown *boss)
 
virtual ~PstLstDocServiceProvider ()
 
virtual void GetName (PMString *pName)
 
virtual ServiceID GetServiceID ()
 
virtual bool16 IsDefaultServiceProvider ()
 
virtual InstancePerX GetInstantiationPolicy ()
 
virtual bool16 HasMultipleIDs () const
 
virtual void GetServiceIDs (K2Vector< ServiceID > &serviceIDs)
 
- Public Member Functions inherited from CServiceProvider
 CServiceProvider (IPMUnknown *boss)
 
virtual IPlugIn::ThreadingPolicy GetThreadingPolicy () const
 

Additional Inherited Members

- Public Types inherited from IK2ServiceProvider
enum  { kDefaultIID = IID_IK2SERVICEPROVIDER }
 
enum  InstancePerX { kInstancePerSession, kInstancePerUse, kInstancePerSessionPreload, kInstancePerSessionNoPurge }
 
- Protected Member Functions inherited from CServiceProvider
void InitThreadingPolicy (PMIID whichIID=IID_IK2SERVICEPROVIDER)
 
- Protected Attributes inherited from CServiceProvider
IPlugIn::ThreadingPolicy fThreadingPolicy
 

Detailed Description

registers as providing the service of responding to a group of document file action signals. See the constructor code for a list of the signals this service responds.

PstLstDocServiceProvider implements IK2ServiceProvider based on the partial implementation CServiceProvider.

Constructor & Destructor Documentation

Binds the C implementation class onto its ImplementationID making the C code callable by the application * PstLstDocServiceProvider::PstLstDocServiceProvider (IPMUnknownboss)

Constructor initializes a list of service IDs, one for each file action signal that DocWchResponder will handle.

Parameters
bossinterface ptr from boss object on which this interface is aggregated.
PstLstDocServiceProvider::~PstLstDocServiceProvider ()
virtual

Destructor.

Member Function Documentation

IK2ServiceProvider::InstancePerX PstLstDocServiceProvider::GetInstantiationPolicy (void )
virtual

GetInstantiationPolicy returns a InstancePerX value to indicate that only one instance per session is needed.

Reimplemented from CServiceProvider.

void PstLstDocServiceProvider::GetName (PMStringpName)
virtual

GetName initializes the name of the service.

Parameters
pNamePtr to PMString to receive the name.

Reimplemented from CServiceProvider.

ServiceID PstLstDocServiceProvider::GetServiceID (void )
virtual

GetServiceID returns a single service ID. This is required, even though GetServiceIDs() will return the complete list initialized in the constructor. This method just returns the first service ID in the list.

Implements IK2ServiceProvider.

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

GetServiceIDs returns a list of services provided.

Parameters
serviceIDsList of IDs describing the services that PstLstDocServiceProvider registers to handle.

Reimplemented from CServiceProvider.

bool16 PstLstDocServiceProvider::HasMultipleIDs (void ) const
virtual

HasMultipleIDs returns kTrue in order to force a call to GetServiceIDs().

Reimplemented from CServiceProvider.

bool16 PstLstDocServiceProvider::IsDefaultServiceProvider (void )
virtual

IsDefaultServiceProvider tells the application this service is not the default service.

Reimplemented from CServiceProvider.