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

#include <ICloseAllDocsCmdData.h>

Inheritance diagram for ICloseAllDocsCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ICLOSEALLDOCSCMDDATA }
 

Public Member Functions

virtual void SetAllowCancel (bool16 allowCancel)=0
 
virtual bool16 GetAllowCancel () const =0
 
virtual void SetPromptForSave (IDocumentUtils::PromptForSave promptForSave)=0
 
virtual
IDocumentUtils::PromptForSave 
GetPromptForSave () const =0
 
virtual void SetWhatToClose (IDocumentUtils::WhatToClose whatToClose)=0
 
virtual IDocumentUtils::WhatToClose GetWhatToClose () 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

This interface is used for the close all documents commands: kCloseAllAndQuitCmdBoss, kCloseAllCmdBoss.

Member Function Documentation

virtual bool16 ICloseAllDocsCmdData::GetAllowCancel () const
pure virtual

Get whether the command may be canceled.

Returns
whether the command may be canceled.
virtual IDocumentUtils::PromptForSave ICloseAllDocsCmdData::GetPromptForSave () const
pure virtual

Get whether users should be allowed to save modified documents.

Returns
whether users should be allowed to save modified documents.
virtual IDocumentUtils::WhatToClose ICloseAllDocsCmdData::GetWhatToClose () const
pure virtual

Get what to close (documents, books, libraries, etc.).

Returns
what to close.
virtual void ICloseAllDocsCmdData::SetAllowCancel (bool16 allowCancel)
pure virtual

Set whether the command may be canceled. Defaults to kTrue.

Parameters
whetherthe command may be canceled.
virtual void ICloseAllDocsCmdData::SetPromptForSave (IDocumentUtils::PromptForSave promptForSave)
pure virtual

Set whether users should be allowed to save modified documents. Defaults to kAsk.

Parameters
promptForSavewhether users should be allowed to save modified documents.
virtual void ICloseAllDocsCmdData::SetWhatToClose (IDocumentUtils::WhatToClose whatToClose)
pure virtual

Set what to close (documents, books, libraries, etc.). Defaults to kCloseDocOnly.

Parameters
whatToClosewhat to close.