InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IDefaultCSB Class Referenceabstract

#include <IDefaultCSB.h>

Inheritance diagram for IDefaultCSB:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IDEFAULT_CSB }
 

Public Member Functions

virtual void Startup (void)=0
 
virtual void Shutdown (void)=0
 
virtual IDataBaseGetDataBase (void) const =0
 
virtual IWorkspaceQueryWorkspace (void)=0
 
virtual void BroadcastToIntegratorSuite (const PMIID &x, void *y)=0
 
virtual bool16 BroadcastQueuedMessages (IdleTimer *x) const =0
 
virtual void SelectionHasQueuedMessages (void) const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Default CSB Interface. On the document and application workspaces

Member Function Documentation

virtual bool16 IDefaultCSB::BroadcastQueuedMessages (IdleTimerx) const
pure virtual

Broadcast any data from the DefaultCSB that has accumulated since the last idle task.

Parameters
xIdleTimer
virtual void IDefaultCSB::BroadcastToIntegratorSuite (const PMIIDx,
void * y 
)
pure virtual

Broadcast a message from the CSB to a suite on the ASB.

Parameters
xPMIID
ymessage
virtual IDataBase* IDefaultCSB::GetDataBase (void ) const
pure virtual
    Return the database which is the persistent store for the defaults 

            accessed by this boss.

Returns
IDataBase*
virtual IWorkspace* IDefaultCSB::QueryWorkspace (void )
pure virtual
    Return the workspace associated with these defaults.



    The caller is responsible for calling Release().

Returns
IWorkspace* or nil
virtual void IDefaultCSB::SelectionHasQueuedMessages (void ) const
pure virtual

Broadcast an internal message to the Selection Manager that this CSB has messages to broadcast to clients.

virtual void IDefaultCSB::Shutdown (void )
pure virtual

Symmetrical call to balance Startup.

virtual void IDefaultCSB::Startup (void )
pure virtual

Initialize the interface and any other portions of the boss that need to be initialized. Each Abstract Selection Boss will call Startup/Shutdown. An internal connection count is retained so that only the first startup and last Shutdown actually affect the defaults boss (i.e. the workspace)