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

#include <PrnSelSuiteCSB.h>

Inheritance diagram for PrnSelSuiteCSB:
CPMUnknown< IPrnSelSuite >IPrnSelSuiteIPMUnknownPrnSelSuiteLayoutCSBPrnSelSuiteTableCSBPrnSelSuiteTextCSB

Public Member Functions

 PrnSelSuiteCSB (IPMUnknown *boss)
 
virtual ~PrnSelSuiteCSB (void)
 
virtual void StoreSelectionData (void)
 
virtual bool16 CanGetPrintSelectionFlag (void)
 
virtual bool16 GetPrintSelectionFlag (void)
 
virtual bool16 CanSetPrintSelectionFlag (void)
 
virtual ErrorCode SetPrintSelectionFlag (const bool16 printSelection)
 
- Public Member Functions inherited from CPMUnknown< IPrnSelSuite >
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 IPrnSelSuite
enum  { kDefaultIID = IID_IPRNSELSUITE }
 
- Protected Member Functions inherited from CPMUnknown< IPrnSelSuite >
 CPMUnknown (IPMUnknown *boss)
 
- Protected Attributes inherited from CPMUnknown< IPrnSelSuite >
HelperInterface fHelperInterface
 

Detailed Description

Base class for CSB (concrete selection boss) suite implementations of IPrnSelSuite; the CSB suites are responsible for doing all of the model specific work involved in accessing and manipulating features of this plug-in. Utilities methods for the CSB suite implementations are provided in this base class.

Sub-classes must implement PrnSelSuiteCSB::GetItemList to populate the list of page items that are to be printed by this plugin.

Constructor & Destructor Documentation

PrnSelSuiteCSB::PrnSelSuiteCSB (IPMUnknownboss)

Constructor

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

Destructor.

Member Function Documentation

bool16 PrnSelSuiteCSB::CanGetPrintSelectionFlag (void )
virtual

Can the print selection flag be retrieved?

Returns
kTrue if it can be retrieved (i.e. a selection is available), kFalse if not.

Implements IPrnSelSuite.

bool16 PrnSelSuiteCSB::CanSetPrintSelectionFlag (void )
virtual

Can the print selection flag be set?

Returns
kTrue if it can be set (i.e. a selection is available), kFalse if not.

Implements IPrnSelSuite.

bool16 PrnSelSuiteCSB::GetPrintSelectionFlag (void )
virtual

Get the print selection flag.

Returns
The current flag value

Implements IPrnSelSuite.

ErrorCode PrnSelSuiteCSB::SetPrintSelectionFlag (const bool16 printSelection)
virtual

Set the print selection flag.

Parameters
printSelectionIN Set the print selection flag.
Returns
kSuccess if success, other value if error.

Implements IPrnSelSuite.

void PrnSelSuiteCSB::StoreSelectionData (void )
virtual

Populates 2 data structures: (1)page UIDs for pages that contained selected items and (2) page item UIDs of selected page items.

Implements IPrnSelSuite.