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

Public Member Functions

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

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

BscDEHDrwEvtSrvc Registers this plug-in with the application as providing a draw event handling service.

BscDEHDrwEvtSrvc 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 * BscDEHDrwEvtSrvc::BscDEHDrwEvtSrvc (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.
BscDEHDrwEvtSrvc::~BscDEHDrwEvtSrvc ()
virtual

Destructor.

Member Function Documentation

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

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

Reimplemented from CServiceProvider.

void BscDEHDrwEvtSrvc::GetName (PMStringpName)
virtual

GetName initializes the name of the service.

Parameters
pNamePtr to PMString to receive the name.

Reimplemented from CServiceProvider.

ServiceID BscDEHDrwEvtSrvc::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.

virtual IPlugIn::ThreadingPolicy BscDEHDrwEvtSrvc::GetThreadingPolicy () const
inlinevirtual

By default the base class will return the threading policy of the plugin where the service provider is defined. Service providers can override this if they reside in a model plugin but want to operate only in the main thread.

Reimplemented from CServiceProvider.

bool16 BscDEHDrwEvtSrvc::IsDefaultServiceProvider (void )
virtual

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

Reimplemented from CServiceProvider.