InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
PrnSelUtils Class Reference
Inheritance diagram for PrnSelUtils:
CPMUnknown< IPrnSelUtils >IPrnSelUtilsIPMUnknown

Public Member Functions

 PrnSelUtils (IPMUnknown *boss)
 
virtual ~PrnSelUtils (void)
 
virtual bool16 _CanGetPrintSelectionFlag (const UIDList &itemList)
 
virtual bool16 _CanGetPrintSelectionFlag (IDocument *doc)
 
virtual bool16 _GetPrintSelectionFlag (IDataBase *db)
 
virtual bool16 _GetPrintSelectionFlag (IDocument *doc)
 
virtual bool16 _CanSetPrintSelectionFlag (const UIDList &itemList)
 
virtual bool16 _CanSetPrintSelectionFlag (IDocument *doc)
 
virtual ErrorCode _SetPrintSelectionFlag (IDataBase *db, const bool16 printSelection)
 
virtual ErrorCode _SetPrintSelectionFlag (IDocument *doc, const bool16 printSelection)
 
- Public Member Functions inherited from CPMUnknown< IPrnSelUtils >
IPMUnknownQueryInterface (PMIID interfaceID) const
 
void AddRef () const
 
void Release () const
 
void PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
void PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
 CPMUnknown (const CPMUnknown &)=delete
 
CPMUnknownoperator= (const CPMUnknown &)=delete
 

Additional Inherited Members

- Public Types inherited from IPrnSelUtils
enum  { kDefaultIID = IID_IPRNSELUTILS }
 
- Protected Member Functions inherited from CPMUnknown< IPrnSelUtils >
 CPMUnknown (IPMUnknown *boss)
 
- Protected Attributes inherited from CPMUnknown< IPrnSelUtils >
HelperInterface fHelperInterface
 

Detailed Description

Implementation of utility methods for manipuating the print selection flag.

Constructor & Destructor Documentation

PrnSelUtils::PrnSelUtils (IPMUnknownboss)
inline

Constructor.

Parameters
bossinterface ptr from boss object on which this interface is aggregated.
virtual PrnSelUtils::~PrnSelUtils (void )
inlinevirtual

Destructor

Member Function Documentation

Binds the C implementation class to its ImplementationID making the C code callable by the application *bool16 PrnSelUtils::_CanGetPrintSelectionFlag (const UIDListitemList)
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.

Implements IPrnSelUtils.

bool16 PrnSelUtils::_CanGetPrintSelectionFlag (IDocumentdoc)
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.

Implements IPrnSelUtils.

bool16 PrnSelUtils::_CanSetPrintSelectionFlag (const UIDListitemList)
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.

Implements IPrnSelUtils.

bool16 PrnSelUtils::_CanSetPrintSelectionFlag (IDocumentdoc)
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.

Implements IPrnSelUtils.

bool16 PrnSelUtils::_GetPrintSelectionFlag (IDataBasedb)
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.

Implements IPrnSelUtils.

bool16 PrnSelUtils::_GetPrintSelectionFlag (IDocumentdoc)
virtual

Get the print selection flag on the specified document

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

Implements IPrnSelUtils.

ErrorCode PrnSelUtils::_SetPrintSelectionFlag (IDataBasedb,
const bool16 printSelection 
)
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.

Implements IPrnSelUtils.

ErrorCode PrnSelUtils::_SetPrintSelectionFlag (IDocumentdoc,
const bool16 printSelection 
)
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.

Implements IPrnSelUtils.