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

Public Member Functions

 GTTxtEdtServiceProvider (IPMUnknown *boss)
 
virtual ~GTTxtEdtServiceProvider ()
 
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

GTTxtEdtServiceProvider

registers as providing the service of responding to a group of document file action and text story creation/deletion signals.

See the constructor for the list of signals registered.

GTTxtEdtServiceProvider 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 * GTTxtEdtServiceProvider::GTTxtEdtServiceProvider (IPMUnknownboss)

Constructor initializes a list of service IDs, one for after open and another for before close.

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

Destructor.

Member Function Documentation

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

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

Reimplemented from CServiceProvider.

void GTTxtEdtServiceProvider::GetName (PMStringpName)
virtual

GetName initializes the name of the service.

Parameters
pNamePtr to PMString to receive the name.

Reimplemented from CServiceProvider.

ServiceID GTTxtEdtServiceProvider::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 GTTxtEdtServiceProvider::GetServiceIDs (K2Vector< ServiceID > & serviceIDs)
virtual

GetServiceIDs returns a list of services provided.

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

Reimplemented from CServiceProvider.

bool16 GTTxtEdtServiceProvider::HasMultipleIDs (void ) const
virtual

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

Reimplemented from CServiceProvider.

bool16 GTTxtEdtServiceProvider::IsDefaultServiceProvider (void )
virtual

IsDefaultServiceProvider tells application this service is not the default service.

Reimplemented from CServiceProvider.