HypServiceProvider Class Reference

Inheritance diagram for HypServiceProvider:

Public Member Functions
	HypServiceProvider (IPMUnknown *boss)
virtual	~HypServiceProvider ()
virtual void	GetName (PMString *pName)
virtual ServiceID	GetServiceID ()
virtual bool16	IsDefaultServiceProvider ()
virtual InstancePerX	GetInstantiationPolicy ()
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

Identifies the linguistic hyphenation service this plug-in provides to the application.

Constructor & Destructor Documentation

HypServiceProvider::HypServiceProvider

(

IPMUnknown *

boss

)

Constructor.

HypServiceProvider::~HypServiceProvider ( )

virtual

Destructor

Member Function Documentation

IK2ServiceProvider::InstancePerX HypServiceProvider::GetInstantiationPolicy ( void  )

virtual

A service provider can choose to have one instance that is shared by all requests for that service providers (this is the most common case - kInstancePerSession), or a service provider may choose to have a unique instance created on each request for the service provider (kInstancePerUse). kInstancePerSessionPreload will cause a service provider to be constructed and cached at application startup. Furthermore, a "preload" service provider will not be unloaded until application shutdown. Note: Since "preload" service providers are never unloaded, the incur the memory overhead for the service and cause the plug-in that contains the service to not be unloaded. Therefore "preload" service providers should be avoided, when possible.

See IK2ServiceProvider for more details.

Reimplemented from CServiceProvider.

void HypServiceProvider::GetName ( PMString *  pName )

virtual

Gets the service provider's name, if there is one.

Reimplemented from CServiceProvider.

ServiceID HypServiceProvider::GetServiceID ( void  )

virtual

Gets the service provider's ID.

Implements IK2ServiceProvider.

virtual IPlugIn::ThreadingPolicy HypServiceProvider::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 HypServiceProvider::IsDefaultServiceProvider ( void  )

virtual

Returns kTrue if this is the default service provider, otherwise kFalse.

Reimplemented from CServiceProvider.