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

#include <IPrnSelUtils.h>

Inheritance diagram for IPrnSelUtils:
IPMUnknownCPMUnknown< IPrnSelUtils >PrnSelUtils

Public Types

enum  { kDefaultIID = IID_IPRNSELUTILS }
 

Public Member Functions

virtual bool16 _CanGetPrintSelectionFlag (const UIDList &itemList)=0
 
virtual bool16 _CanGetPrintSelectionFlag (IDocument *doc)=0
 
virtual bool16 _GetPrintSelectionFlag (IDataBase *db)=0
 
virtual bool16 _GetPrintSelectionFlag (IDocument *doc)=0
 
virtual bool16 _CanSetPrintSelectionFlag (const UIDList &itemList)=0
 
virtual bool16 _CanSetPrintSelectionFlag (IDocument *doc)=0
 
virtual ErrorCode _SetPrintSelectionFlag (IDataBase *db, const bool16 printSelection)=0
 
virtual ErrorCode _SetPrintSelectionFlag (IDocument *doc, const bool16 printSelection)=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

Utility methods for manipuating the print selection flag.

Member Enumeration Documentation

anonymous enum

Specifies the default IID for this interface

Member Function Documentation

virtual bool16 IPrnSelUtils::_CanGetPrintSelectionFlag (const UIDListitemList)
pure virtual

Can the print selection flag be retrieved?

Parameters
itemListIN The item list to test, to see if they are valid selections.
Returns
kTrue if the print selection flag can be retrieved, kFalse otherwise.

Implemented in PrnSelUtils.

virtual bool16 IPrnSelUtils::_CanGetPrintSelectionFlag (IDocumentdoc)
pure virtual

Can the print selection flag be retrieved from the specified document?

Parameters
docIN The document to test.
Returns
kTrue if the print selection flag can be retrieved, kFalse otherwise.

Implemented in PrnSelUtils.

virtual bool16 IPrnSelUtils::_CanSetPrintSelectionFlag (const UIDListitemList)
pure virtual

Can the print selection flag be set?

Parameters
itemListIN The item list to test, to see if they are valid selections.
Returns
kTrue if the print selection flag can be retrieved, kFalse otherwise.

Implemented in PrnSelUtils.

virtual bool16 IPrnSelUtils::_CanSetPrintSelectionFlag (IDocumentdoc)
pure virtual

Can the print selection flag be set on the specified document?

Parameters
docIN The document to test.
Returns
kTrue if the print selection flag can be set, kFalse otherwise.

Implemented in PrnSelUtils.

virtual bool16 IPrnSelUtils::_GetPrintSelectionFlag (IDataBasedb)
pure virtual

Get the print selection flag

Parameters
dbIN The database to check. This should be a document database.
Returns
The current status of the flag.

Implemented in PrnSelUtils.

virtual bool16 IPrnSelUtils::_GetPrintSelectionFlag (IDocumentdoc)
pure virtual

Get the print selection flag on the specified document

Parameters
docIN The document to check.
Returns
The current status of the flag.

Implemented in PrnSelUtils.

virtual ErrorCode IPrnSelUtils::_SetPrintSelectionFlag (IDataBasedb,
const bool16 printSelection 
)
pure virtual

Set the print selection flag

Parameters
dbIN The database on which to set the flag. This should be a document database.
printSelectionIN the flag's new value.
Returns
kSuccess if success, other value if otherwise.

Implemented in PrnSelUtils.

virtual ErrorCode IPrnSelUtils::_SetPrintSelectionFlag (IDocumentdoc,
const bool16 printSelection 
)
pure virtual

Set the print selection flag on the specified document

Parameters
docIN The document on which to set the flag.
printSelectionIN the flag's new value.
Returns
kSuccess if success, other value if otherwise.

Implemented in PrnSelUtils.