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

#include <IPDFPlacePrefs.h>

Inheritance diagram for IPDFPlacePrefs:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IPDFPLACEPREFS }
 
enum  {
  kCropToContentVisibleOnly = 0, kCropToUnused, kCropToArt, kCropToPage,
  kCropToTrim, kCropToBleed, kCropToMedia, kCropToContentAllLayers
}
 

Public Member Functions

virtual void CopyData (IPDFPlacePrefs *dataToCopy)=0
 
virtual void SetPage (int32 nPage)=0
 
virtual int32 GetPage ()=0
 
virtual void SetCropTo (int32 newCropTo)=0
 
virtual int32 GetCropTo ()=0
 
virtual void SetPreserveScreens (bool16 bPreserve)=0
 
virtual bool16 GetPreserveScreens ()=0
 
virtual void SetTransparentBackground (bool16 bTransparent)=0
 
virtual bool16 GetTransparentBackground ()=0
 
virtual void SetStream (IPMStream *pStream)=0
 
virtual IPMStreamGetStream ()=0
 
virtual void SetUserPassword (PMString strPassword)=0
 
virtual PMString GetUserPassword ()=0
 
virtual void SetProxyResolution (int32 nDPI)=0
 
virtual int32 GetProxyResolution ()=0
 
virtual void SetPageRange (const K2Vector< uint32 > &list)=0
 
virtual void GetPageRange (K2Vector< uint32 > &list)=0
 
virtual void SetAllPages (uint32 totalPages, bool16 allPages)=0
 
virtual bool16 GetAllPages (uint32 *totalPages=nil)=0
 
virtual bool16 GetShowPreview ()=0
 
virtual void SetShowPreview (bool16 b)=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

Public interface used to remember the PDF place options.

This interface is used by the PDF place code to hold the settings the user selects in the PDF options dialog. The workspace has this interface to hold the default values.

Member Function Documentation

virtual void IPDFPlacePrefs::CopyData (IPDFPlacePrefsdataToCopy)
pure virtual

Method to copy all the stored information from one interface to another.

Parameters
dataToCopyis where the information is copied from.
virtual bool16 IPDFPlacePrefs::GetAllPages (uint32 * totalPages = nil)
pure virtual

Method to get the total pages of the PDF and whether all pages are being placed.

Parameters
totalPagesis returned. totalPages is optional, pass nil if you don't want it.
Returns
the allPages setting.
virtual int32 IPDFPlacePrefs::GetCropTo ()
pure virtual

Method to get the CropTo information.

Returns
the CropTo number.
virtual int32 IPDFPlacePrefs::GetPage ()
pure virtual

Method to get the stored PDF page number.

Returns
the page number.
virtual void IPDFPlacePrefs::GetPageRange (K2Vector< uint32 > & list)
pure virtual

Method to get the stored page range.

Parameters
listis filled with the page numbers to place.
virtual bool16 IPDFPlacePrefs::GetPreserveScreens ()
pure virtual

Method

virtual int32 IPDFPlacePrefs::GetProxyResolution ()
pure virtual

Method

virtual bool16 IPDFPlacePrefs::GetShowPreview ()
pure virtual

Determine wether we show a preview in the import options dialog.

virtual IPMStream* IPDFPlacePrefs::GetStream ()
pure virtual

Method

virtual bool16 IPDFPlacePrefs::GetTransparentBackground ()
pure virtual

Method

virtual PMString IPDFPlacePrefs::GetUserPassword ()
pure virtual

Method

virtual void IPDFPlacePrefs::SetAllPages (uint32 totalPages,
bool16 allPages 
)
pure virtual

Method to store the total pages when all pages are placed.

Parameters
totalPagesis the total number of pages in the PDF file. A value of 0xffffffff for totalPages, means the interal total page value is not changed. You can use this when you only want to set the allPages value.
allPagesis true to place all the pages. When it is false the page range is used. We place the current page (GetPage value). The subsequent pages placed are sequential until the total is reached. To place all pages, set the current page to 1 using SetPage(1).
virtual void IPDFPlacePrefs::SetCropTo (int32 newCropTo)
pure virtual

Method to store the CropTo information.

Parameters
newCropTo
virtual void IPDFPlacePrefs::SetPage (int32 nPage)
pure virtual

Method to store the PDF page number of the placed page.

Parameters
nPageis the page number (1 is the first page).
virtual void IPDFPlacePrefs::SetPageRange (const K2Vector< uint32 > & list)
pure virtual

Method to store the page range to place.

Parameters
listcontains the page numbers to place (page numbers start at 0). We place the current page (GetPage value). The subsequent pages placed come from this list. We linear search the list for the first instance of the current page then place all the remaining items in the list. If the list does not contain the current page, no items from the list are placed.
virtual void IPDFPlacePrefs::SetPreserveScreens (bool16 bPreserve)
pure virtual

Method to store the preserve screens information.

Parameters
bPreserveis true to preserve screens.
virtual void IPDFPlacePrefs::SetProxyResolution (int32 nDPI)
pure virtual

Method

virtual void IPDFPlacePrefs::SetStream (IPMStreampStream)
pure virtual

Method

virtual void IPDFPlacePrefs::SetTransparentBackground (bool16 bTransparent)
pure virtual

Method

virtual void IPDFPlacePrefs::SetUserPassword (PMString strPassword)
pure virtual

Method