IPrnSelSuite Class Reference

#include <IPrnSelSuite.h>

Inheritance diagram for IPrnSelSuite:

Public Types
enum	{ kDefaultIID = IID_IPRNSELSUITE }

Public Member Functions
virtual void	StoreSelectionData (void)=0
virtual bool16	CanGetPrintSelectionFlag (void)=0
virtual bool16	GetPrintSelectionFlag (void)=0
virtual bool16	CanSetPrintSelectionFlag (void)=0
virtual ErrorCode	SetPrintSelectionFlag (const bool16 printSelection)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

From SDK sample; a suite interface used to gather selected page and pagitem information. The information, i.e., the UIDs of object need to print, is collect and stored in interface IPrnSelData.

Member Function Documentation

virtual bool16 IPrnSelSuite::CanGetPrintSelectionFlag ( void  )

pure virtual

Can the print selection flag be retrieved?

Returns

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

Implemented in PrnSelSuiteCSB, and PrnSelSuiteASB.

virtual bool16 IPrnSelSuite::CanSetPrintSelectionFlag ( void  )

pure virtual

Can the print selection flag be set?

Returns

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

Implemented in PrnSelSuiteCSB, and PrnSelSuiteASB.

virtual bool16 IPrnSelSuite::GetPrintSelectionFlag ( void  )

pure virtual

Get the print selection flag.

Returns

The current flag value

Implemented in PrnSelSuiteCSB, and PrnSelSuiteASB.

virtual ErrorCode IPrnSelSuite::SetPrintSelectionFlag ( const bool16  printSelection )

pure virtual

Set the print selection flag.

Parameters

printSelection

IN Set the print selection flag.

Returns

kSuccess if success, other value if error.

Implemented in PrnSelSuiteCSB, and PrnSelSuiteASB.

virtual void IPrnSelSuite::StoreSelectionData ( void  )

pure virtual

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

Implemented in PrnSelSuiteCSB, and PrnSelSuiteASB.