IPrintContentPrefs Class Reference

#include <IPrintContentPrefs.h>

Inheritance diagram for IPrintContentPrefs:

Public Types
enum	{ kDefaultIID = IID_IPRINTCONTENTPREFS }
enum	GridView {   kInvalidView = -1, kPerFrameGridView = 0, kGridView = 1, kZNGridView = 2,   kAlignmentGridView = 3 }
enum	WhenGrid { kAlways = 0, kWhenEmpty = 1 }

Public Member Functions
virtual void	SetPrintText (bool16 printText)=0
virtual bool16	GetPrintText () const =0
virtual void	SetPrintPageItems (bool16 printPageItems)=0
virtual bool16	GetPrintPageItems () const =0
virtual void	SetPrintLayoutGrids (bool16 printLayoutGrids)=0
virtual bool16	GetPrintLayoutGrids () const =0
virtual void	SetPrintFrameGrids (bool16 printFrameGrids)=0
virtual bool16	GetPrintFrameGrids () const =0
virtual void	SetOnlyPrintFrameGridWhenEmpty (bool16 printWhenEmpty)=0
virtual bool16	GetOnlyPrintFrameGridWhenEmpty () const =0
virtual void	SetPrintFrameGridView (int32 viewNumber)=0
virtual int32	GetPrintFrameGridView () const =0
virtual void	SetFrameGridStrokeWeight (const PMReal &points)=0
virtual PMReal	GetFrameGridStrokeWeight () const =0
virtual void	SetLayoutGridStrokeWeight (const PMReal &points)=0
virtual PMReal	GetLayoutGridStrokeWeight () const =0
virtual void	SetUIFlags (UIFlags nFlags)=0
virtual UIFlags	GetUIFlags () const =0
virtual void	CopyFrom (IPrintContentPrefs const *from)=0
virtual void	CopyFrom (IPrintData const *printData)=0
virtual void	CopyTo (IPrintData *printData) 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

IPrintContentPrefs are used to allow users to control which content they would like printed or omitted from printing. Such content includes text, page items, layout grids, and frame grids.

These preferences are only considered when IViewPortAttributes::SetViewPortFilterContent on the print port is set to true.

The printing of baseline grids and ruler guides is controlled by a different interface, IPrintData->GetPrintWYSIWYGGridsGuides(), and has core access for Roman and J products in the Print dialog, General subdialog.

See Also

IViewPortAttributes::SetViewPortFilterContent

IPrintData::GetPrintWYSIWYGGridsGuides

Member Enumeration Documentation

enum IPrintContentPrefs::GridView

Enumeration governing how grids are to be printed

enum IPrintContentPrefs::WhenGrid

Unused

Member Function Documentation

virtual void IPrintContentPrefs::CopyFrom ( IPrintContentPrefs const *  from )

pure virtual

Copies preferences from an IPrintContentPrefs instance

Parameters

from	The prefs to copy

virtual void IPrintContentPrefs::CopyFrom ( IPrintData const *  printData )

pure virtual

Copies preferences from an IPrintData instance

Parameters

printData

The data to copy

virtual void IPrintContentPrefs::CopyTo ( IPrintData *  printData ) const

pure virtual

Copies preferences to an IPrintData instance

Parameters

printData

The data to copy to

virtual PMReal IPrintContentPrefs::GetFrameGridStrokeWeight ( ) const

pure virtual

Gets preference for frame grid stroke weight

Returns

The frame grid stroke weight

virtual PMReal IPrintContentPrefs::GetLayoutGridStrokeWeight ( ) const

pure virtual

Gets preference for layout grid stroke weight

Returns

The layout grid stroke weight

virtual bool16 IPrintContentPrefs::GetOnlyPrintFrameGridWhenEmpty ( ) const

pure virtual

Gets preference for printing frame grids when empty

Returns

kTrue if printing frame grids when empty, else kFalse

virtual bool16 IPrintContentPrefs::GetPrintFrameGrids ( ) const

pure virtual

Gets preference for printing frame grids

Returns

kTrue if printing frame grids, else kFalse

virtual int32 IPrintContentPrefs::GetPrintFrameGridView ( ) const

pure virtual

Gets preference for printing frame grid view

Returns

The frame grid view to print

virtual bool16 IPrintContentPrefs::GetPrintLayoutGrids ( ) const

pure virtual

Gets preference for printing layout grids

Returns

kTrue if printing layout grids, else kFalse

virtual bool16 IPrintContentPrefs::GetPrintPageItems ( ) const

pure virtual

Gets preference for printing page items

Returns

kTrue if printing page items, else kFalse

virtual bool16 IPrintContentPrefs::GetPrintText ( ) const

pure virtual

Gets preference for printing text

Returns

kTrue if printing text, else kFalse

virtual UIFlags IPrintContentPrefs::GetUIFlags ( ) const

pure virtual

Gets preference for UI flags to use during print

Returns

The UI flags to use during print

virtual void IPrintContentPrefs::SetFrameGridStrokeWeight ( const PMReal &  points )

pure virtual

Sets preference for frame grid stroke weight

Parameters

points

The new frame grid stroke weight

virtual void IPrintContentPrefs::SetLayoutGridStrokeWeight ( const PMReal &  points )

pure virtual

Sets preference for layout grid stroke weight

Parameters

points

The new layout grid stroke weight

virtual void IPrintContentPrefs::SetOnlyPrintFrameGridWhenEmpty ( bool16  printWhenEmpty )

pure virtual

Sets preference for printing frame grids when empty

Parameters

printWhenEmpty

Flag: whether to print frame grids when empty

virtual void IPrintContentPrefs::SetPrintFrameGrids ( bool16  printFrameGrids )

pure virtual

Sets preference for printing frame grids

Parameters

printFrameGrids

Flag: whether to print frame grids

virtual void IPrintContentPrefs::SetPrintFrameGridView ( int32  viewNumber )

pure virtual

Sets preference for printing frame grid view

Parameters

viewNumber

The frame grid view to print

virtual void IPrintContentPrefs::SetPrintLayoutGrids ( bool16  printLayoutGrids )

pure virtual

Sets preference for printing layout grids

Parameters

printLayoutGrids

Flag: whether to print layout grids

virtual void IPrintContentPrefs::SetPrintPageItems ( bool16  printPageItems )

pure virtual

Sets preference for printing page items

Parameters

printPageItems

Flag: whether to print page items

virtual void IPrintContentPrefs::SetPrintText ( bool16  printText )

pure virtual

Sets preference for printing text

Parameters

printText

Flag: whether to print text

virtual void IPrintContentPrefs::SetUIFlags ( UIFlags  nFlags )

pure virtual

Sets preference for UI flags used during print

Parameters

nFlags

The new UI flags