IOpenFileCmdData Class Reference

#include <IOpenFileCmdData.h>

Inheritance diagram for IOpenFileCmdData:

Public Types
enum	OpenFlags { kOpenDefault, kOpenOriginal, kOpenCopy }
enum	LockFlags { kUseLockFile, kNotUseLockFile }

Public Member Functions
virtual void	Set (const IOpenFileCmdData &data)=0
virtual void	Set (const IDFile &file, UIFlags uiFlags=kFullUI, OpenFlags openFlags=kOpenDefault, LockFlags lockFlags=kUseLockFile, IDocument::UndoSupport undoSupport=IDocument::kFullUndoSupport, const std::string assetRef="")=0
virtual const IDFile &	GetSysFile () const =0
virtual UIFlags	GetUIFlags () const =0
virtual void	SetUIFlags (UIFlags uiFlags)=0
virtual OpenFlags	GetOpenFlags () const =0
virtual LockFlags	GetLockFlags () const =0
virtual IDocument::UndoSupport	GetUndoSupport () const =0
virtual std::string	GetAssetRef () const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

This interface is used to cache data for open file related command such as kOpenDocCmdBoss, kOpenRevertedDocCmdBoss, kInCopyOpenDocCmdBoss, kOpenFileCmdBoss, kOpenFileWithWindowCmdBoss and kOpenDocFromBookCmdBoss.

Member Enumeration Documentation

enum IOpenFileCmdData::LockFlags

Define the lock options.

enum IOpenFileCmdData::OpenFlags

Define the open options.

Member Function Documentation

virtual std::string IOpenFileCmdData::GetAssetRef ( ) const

pure virtual

Get the asset ref for cloud ID

Returns

std::string

virtual LockFlags IOpenFileCmdData::GetLockFlags ( ) const

pure virtual

Get the lock option determining whether a lock file will be used or not when open.

Returns

LockFlags which could be either kUseLockFile or kNotUseLockFile.

virtual OpenFlags IOpenFileCmdData::GetOpenFlags ( ) const

pure virtual

Get the open option about how you open the file.

Returns

OpenFlags which could be kOpenDefault, kOpenOriginal and kOpenCopy.

virtual const IDFile& IOpenFileCmdData::GetSysFile ( ) const

pure virtual

Get the sysfile to import.

Returns

const IDFile& file to import.

virtual UIFlags IOpenFileCmdData::GetUIFlags ( ) const

pure virtual

Get the UI flags about how much UI to show during import.

Returns

UIFlags which could be kSuppressUI, kMinimalUI and kFullUI.

virtual IDocument::UndoSupport IOpenFileCmdData::GetUndoSupport ( ) const

pure virtual

Get the undo support option

See Also

IDocument.

Returns

IDocument::UndoSupport.

virtual void IOpenFileCmdData::Set ( const IOpenFileCmdData &  data )

pure virtual

Initialize the settings of this object from the settings of the 'data' object. It acts as a copy constructor.

Parameters

data	refers to the object used to be copied from.

Returns

void.

virtual void IOpenFileCmdData::Set ( const IDFile &  file, UIFlags  uiFlags = kFullUI, OpenFlags  openFlags = kOpenDefault, LockFlags  lockFlags = kUseLockFile, IDocument::UndoSupport  undoSupport = IDocument::kFullUndoSupport, const std::string  assetRef = ""  )

pure virtual

Set the command data through the individual setting.

Parameters

file	refers to the sysFile to import.
uiFlags	refers to how much UI to show during import.
openFlags	refers to the open option about how you open the file.
lockFlags	refers to the lock option determining whether a lock file will be used or not when open.
undoSupport	(default=IDocument::kFullUndoSupport), indicates whether commands that change the document (if this is an InDesign/InCopy document) will appear on the undo menu
assetRef	refers to the assetRef for cloud documents.

Returns

void.

virtual void IOpenFileCmdData::SetUIFlags ( UIFlags  uiFlags )

pure virtual

Set the UI flags