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

#include <IDocSavePrefsCmdData.h>

Inheritance diagram for IDocSavePrefsCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IDOCSAVEPREFSCMDDATA }
 

Public Member Functions

virtual void SetDocument (IDocument *theDocument)=0
 
virtual IDocumentGetDocument () const =0
 
virtual void SetThumbnailOptions (IDocSavePrefs::ThumbnailOptions thumbnail)=0
 
virtual
IDocSavePrefs::ThumbnailOptions 
GetThumbnailOptions () const =0
 
virtual void SetPreviewSizeOptions (IDocSavePrefs::PreviewSizeOptions Previewsize)=0
 
virtual
IDocSavePrefs::PreviewSizeOptions 
GetPreviewSizeOptions () const =0
 
virtual void SetSaveThumbnailWithDocument (bool16 saveThumbnail)=0
 
virtual bool16 GetSaveThumbnailWithDocument () 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

IDocSavePrefsCmdData is a data interface for the kSetDocSavePrefsCmdBoss.  It is used

by the client of the command to specify the preview and thumbnail options for InDesign documents.

See Also
IDocSavePrefs.h

Member Enumeration Documentation

anonymous enum

Default IID enum

Member Function Documentation

virtual IDocument* IDocSavePrefsCmdData::GetDocument () const
pure virtual

Called by the command to obtain the target document.

Parameters
none
Returns
IDocument - returns the document set by a call to SetDocument().
virtual IDocSavePrefs::PreviewSizeOptions IDocSavePrefsCmdData::GetPreviewSizeOptions () const
pure virtual

GetPreviewSizeOptions() is called by the command to obtain the desired Preview size options.

Parameters
none
Returns
IDocSavePrefs::PreviewSizeOptions - returns the Preview size options set by SetPreviewSizeOptions().
virtual bool16 IDocSavePrefsCmdData::GetSaveThumbnailWithDocument () const
pure virtual

Get the preference of whether or not to save previews with documents

Parameters
void
Returns
true if we're saving thumbnails
virtual IDocSavePrefs::ThumbnailOptions IDocSavePrefsCmdData::GetThumbnailOptions () const
pure virtual

GetThumbnailOptions() is called by the command to obtain the desired thumbnail options.

Parameters
none
Returns
IDocSavePrefs::ThumbnailOptions - returns the thumbnail options set by SetThumbnailOptions().
virtual void IDocSavePrefsCmdData::SetDocument (IDocumenttheDocument)
pure virtual

Set the target document

Parameters
*theDocumentIN - Called by the client to specify the target document.
virtual void IDocSavePrefsCmdData::SetPreviewSizeOptions (IDocSavePrefs::PreviewSizeOptions Previewsize)
pure virtual

SetPreviewSizeOptions is called by the client to specify the new Preview size options.

Parameters
previewsize IN - the new setting
virtual void IDocSavePrefsCmdData::SetSaveThumbnailWithDocument (bool16 saveThumbnail)
pure virtual

Set the preference of whether or not to save previews with documents

Parameters
saveThumbnailIN - the new setting
virtual void IDocSavePrefsCmdData::SetThumbnailOptions (IDocSavePrefs::ThumbnailOptions thumbnail)
pure virtual

SetThumbnailOptions is called by the client to specify the new thumbnail options.

Parameters
thumbnailIN - the new setting