IBookOutputActionCmdData Class Reference

#include <IBookOutputActionCmdData.h>

Inheritance diagram for IBookOutputActionCmdData:

Public Types
enum	{ kDefaultIID = IID_IBOOKOUTPUTACTIONCMDDATA }
enum	OutputUIOptions {   kSuppressNothing = 0x0, kSuppressOutputProgress = 0x1, kSuppressOutputWarnings = 0x2, kSuppressOutputDialog = 0x4,   kSuppressEverything = 0xFF }

Public Member Functions
virtual void	Set (IDFile &sysFile, UIDList *itemList, bool16 outputAll=kTrue)=0
virtual IDFile	GetBookFile ()=0
virtual void	SetBookFile (const IDFile &BookFile)=0
virtual UIDList *	GetUIDList ()=0
virtual void	SetUIDList (UIDList *uidList)=0
virtual bool16	IsOutputAll ()=0
virtual void	SetOutputUIOptions (const OutputUIOptions uiOptions)=0
virtual OutputUIOptions	GetOutputUIOptions () const =0
virtual void	SetOutputFile (IDFile &sysFile, bool16 validFile=kFalse)=0
virtual IDFile	GetOutputFile (bool16 &isValidOutputFile)=0
virtual void	SetExportProviderClassID (const ClassID &classID)=0
virtual ClassID	GetExportProviderClassID () const =0
virtual void	SetPDFStyleRef (const UIDRef &styleRef)=0
virtual UIDRef	GetPDFStyleRef () const =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

Command data interface relating to commands to output books (kBookBoss).

See Also

kBookExportActionCmdBoss

kBookPrintActionCmdBoss

Member Enumeration Documentation

enum IBookOutputActionCmdData::OutputUIOptions

Output UI options. Options may be ORed together.

Enumerator
kSuppressNothing	Don't suppress any UI.
kSuppressOutputProgress	Suppress progress bar.
kSuppressOutputWarnings	Suppress output warnings.
kSuppressOutputDialog	Suppress output dialog.
kSuppressEverything	Suppress all UI.

Member Function Documentation

virtual IDFile IBookOutputActionCmdData::GetBookFile ( )

pure virtual

Return the book file.

virtual ClassID IBookOutputActionCmdData::GetExportProviderClassID ( ) const

pure virtual

Get the export provider class ID.

Returns

ClassID of the output export provider, may be kInvalidClass if not set

virtual IDFile IBookOutputActionCmdData::GetOutputFile ( bool16 &  isValidOutputFile )

pure virtual

Get the export destination file.

Parameters

isValidOutputFile

OUT kTrue if the output file is valid, kFalse otherwise

Returns

IDFile of the output file

virtual OutputUIOptions IBookOutputActionCmdData::GetOutputUIOptions ( ) const

pure virtual

Get method for the output UI options.

Returns

OutputUIOption enum value for current output UI option

virtual UIDRef IBookOutputActionCmdData::GetPDFStyleRef ( ) const

pure virtual

Get the preset for PDF export.

Returns

preset for PDF export, may be kInvalidUIDRef if not set

virtual UIDList* IBookOutputActionCmdData::GetUIDList ( )

pure virtual

Return the UID list containing the pubs being output.

virtual bool16 IBookOutputActionCmdData::IsOutputAll ( )

pure virtual

Determine whether all pubs being output.

Returns

bool16 kTrue if all pubs being output, kFalse otherwise

virtual void IBookOutputActionCmdData::Set ( IDFile &  sysFile, UIDList *  itemList, bool16  outputAll = kTrue  )

pure virtual

All inclusive set method to initialize data members.

Parameters

sysFile	IN the book file
itemList	IN UIDs of the pubs being output
outputAll	IN if kTrue, all pubs are output, itemList is ignored

virtual void IBookOutputActionCmdData::SetBookFile ( const IDFile &  BookFile )

pure virtual

Set the book file.

Parameters

BookFile

IN the book file being output

virtual void IBookOutputActionCmdData::SetExportProviderClassID ( const ClassID &  classID )

pure virtual

Set the book export provider class ID. Set to kInvalidClass to use the default book export provider.

Parameters

classID

IN the export book provider classID

virtual void IBookOutputActionCmdData::SetOutputFile ( IDFile &  sysFile, bool16  validFile = kFalse  )

pure virtual

Set export destination file.

Parameters

sysFile	IN the export destination file
validFile	IN kTrue if the file is valid, kFalse otherwise

virtual void IBookOutputActionCmdData::SetOutputUIOptions ( const OutputUIOptions  uiOptions )

pure virtual

Set method for the output UI options.

Parameters

uiOptions

IN the desired UI options

virtual void IBookOutputActionCmdData::SetPDFStyleRef ( const UIDRef &  styleRef )

pure virtual

Set the preset for PDF export. Set to kInvalidUIDRef to use the default PDF preset.

Parameters

styleRef

IN the preset for PDF Export

virtual void IBookOutputActionCmdData::SetUIDList ( UIDList *  uidList )

pure virtual

Set the pub list of the pubs being output.

Parameters

uidList

IN a list of pub UIDs to output