InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
kPstLstDocResponderBoss Class Reference

#include <SdkObjModel.h>

Inheritance diagram for kPstLstDocResponderBoss:

Public Member Functions

IResponder IID_IRESPONDER
 
IK2ServiceProvider IID_IK2SERVICEPROVIDER
 

Detailed Description

 This boss provides the service of responding to document file actions.

It has two interfaces: one that tells InDesign what kind of service is provided, and a second to provide the service. An interface, IPstLstObserver is added to the kDocBoss to observer the document's hierarchy change, for example, the removal of a page item by File->Cut command, this observer allows us to purge the data allocated for the page item before it's too late. Since there is not always a front document, we can only hook up the observer with the document when it is opened, and detach the observer when the document is closed. The purpose of this responder boss is to get notified for these events so the observer can be hooked up and detached in the right time.

Member Function Documentation

IK2ServiceProvider kPstLstDocResponderBoss::IID_IK2SERVICEPROVIDER
     An impl. of this plug-in to identify this boss as providing a 

responder service for multiple document actions, such as for doc open, close, etc. If only one service was needed, then we'd reuse an API-defined implementation ID listed in DocumentID.h.

    Implementation: kPstLstDocServiceProviderImpl.
IResponder kPstLstDocResponderBoss::IID_IRESPONDER
     An impl. of this plug-in to perform the responder service.  This implementation

will deliver every service promised by the IK2ServiceProvider implementation. We respond to kAfterNewDocSignalResponderService by attaching the doc observer and kBeforeCloseDocSignalResponderService by detaching the observer.

    Implementation: kPstLstDocResponderImpl.