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

#include <IInCopyApp.h>

Inheritance diagram for IInCopyApp:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IINCOPYAPP }
 

Public Member Functions

virtual bool FilterThisTool (ClassID toolclass)=0
 
virtual IDFile GetDefaultFile (PMString docName, bool16 *useSystemDefaultDir)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Static Public Member Functions

static IInCopyAppQuery ()
 

Detailed Description

Interface on the application providing app wide access methods. Often queried to determine if running in InCopy - now can use LocaleSetting.

Member Function Documentation

virtual bool IInCopyApp::FilterThisTool (ClassID toolclass)
pure virtual

Filters tools except kIBeamToolBoss, kZoomToolBoss, kLoupeToolBoss, kGrabberHandToolBoss, kNoteToolBoss, kCropToolBoss. Called by ToolInitializer::RegisterByStream.

Parameters
ClassIDclass for tool to be filtered or not.
Returns
bool whether or not tool was filtered.
virtual IDFile IInCopyApp::GetDefaultFile (PMString docName,
bool16 * useSystemDefaultDir 
)
pure virtual

Utility method to get a sysfile pointing to the current saveas folder. Typically this will be the starting point in a save as dialog.

Parameters
docNamename of document to get save as folder of
useSystemDefaultDirwill be kTrue on return if we are using the system default rather than application
Returns
IDFile pointing to the correct starting directory to do the "save as" in.
static IInCopyApp* IInCopyApp::Query ()
inlinestatic

Interface query.

Returns
IInCopyApp* ptr to IInCopyApp.