IlvPSPrinter::DialogHandle Class Reference

Class to handle a dialog to initialize or modify the settings. More...

#include <C:/jenkins/workspace/Views-all/views/include.doc/ilviews/printing/psprinter.h>

Classes
class	Factory
	Factory class to create a dialog handle. More...

Public Member Functions
virtual	~DialogHandle ()
	Destructor. More...
virtual IlBoolean	get ()=0
	Shows the dialog and returns the result.
virtual IlUInt	getCopiesNumber () const =0
	Returns the selected number of copies. More...
virtual IlString	getFilename () const =0
	Returns the selected file name. More...
virtual void	getMargins (IlvDim &left, IlvDim &right, IlvDim &top, IlvDim &bottom) const =0
	Gets the selected margin values. More...
virtual IlvPrinter::Orientation	getOrientation () const =0
	Returns the selected printer orientation. More...
virtual IlvPaperFormat const &	getPaperFormat () const =0
	Returns the selected paper format. More...
virtual IlBoolean	isCollateOn () const =0
	Returns whether collate is selected. More...
virtual IlBoolean	isColorModeOn () const =0
	Returns a Boolean indicting the color mode. More...
virtual void	setCollate (IlBoolean collate)=0
	Sets whether collate is selected by default. When printing N copies of a document, if collate is 'off', each page of the document is printed N times. If collate is 'on' the whole document is printed N times. Collate works only when printing multiple copies of a document. More...
virtual void	setColorMode (IlBoolean useColor)=0
	Sets the default color mode. More...
virtual void	setCopiesNumber (IlUInt copies)=0
	Sets the default number of copies. More...
virtual void	setFilename (IlString const &name)=0
	Sets the default file name. More...
virtual void	setOrientation (IlvPrinter::Orientation orientation)=0
	Sets the default printer orientation. More...
virtual void	setPaperFormat (IlString const &format)=0
	Sets the default paper format. More...

Static Public Member Functions
static Factory *	GetFactory ()
	Gets the dialog handle factory. More...
static void	SetFactory (Factory *factory)
	Sets the dialog handle factory. More...

Detailed Description

Class to handle a dialog to initialize or modify the settings.

Library: ilvprint
ilviews/printing/psprinter.h ilviews/printing/psprinter.h

This class is abstract and must be inherited.

Constructor & Destructor Documentation

~DialogHandle()

virtual IlvPSPrinter::DialogHandle::~DialogHandle ( )

virtual

Destructor.

This function does not do anything. Its purpose is to be overridden if needed.

Member Function Documentation

getCopiesNumber()

virtual IlUInt IlvPSPrinter::DialogHandle::getCopiesNumber ( ) const

pure virtual

Returns the selected number of copies.

Returns

The selected number of copies.

GetFactory()

IlvPSPrinter::DialogHandle::Factory * IlvPSPrinter::DialogHandle::GetFactory ( )

static

Gets the dialog handle factory.

This factory, if it exists, is used to build a DialogHandle.

Returns

A pointer to the current Factory.

getFilename()

virtual IlString IlvPSPrinter::DialogHandle::getFilename ( ) const

pure virtual

Returns the selected file name.

Returns

The selected file name.

getMargins()

virtual void IlvPSPrinter::DialogHandle::getMargins ( IlvDim &  left, IlvDim &  right, IlvDim &  top, IlvDim &  bottom  ) const

pure virtual

Gets the selected margin values.

Parameters

left	The left border value.
right	The right border value.
top	The top border value.
bottom	The bottom border value.

getOrientation()

virtual IlvPrinter::Orientation IlvPSPrinter::DialogHandle::getOrientation ( ) const

pure virtual

Returns the selected printer orientation.

Returns

The printer orientation.

getPaperFormat()

virtual IlvPaperFormat const& IlvPSPrinter::DialogHandle::getPaperFormat ( ) const

pure virtual

Returns the selected paper format.

Returns

The paper format.

isCollateOn()

virtual IlBoolean IlvPSPrinter::DialogHandle::isCollateOn ( ) const

pure virtual

Returns whether collate is selected.

Returns

IlTrue if collate is selected, IlFalse if not.

isColorModeOn()

virtual IlBoolean IlvPSPrinter::DialogHandle::isColorModeOn ( ) const

pure virtual

Returns a Boolean indicting the color mode.

Returns

IlTrue if color is selected, IlFalse if gray scale is selected.

setCollate()

virtual void IlvPSPrinter::DialogHandle::setCollate ( IlBoolean  collate )

pure virtual

Sets whether collate is selected by default. When printing N copies of a document, if collate is 'off', each page of the document is printed N times. If collate is 'on' the whole document is printed
N times. Collate works only when printing multiple copies of a document.

Parameters

collate

An IlBoolean indicating if collate is selected by default.

setColorMode()

virtual void IlvPSPrinter::DialogHandle::setColorMode ( IlBoolean  useColor )

pure virtual

Sets the default color mode.

Parameters

useColor

IlTrue if color is selected by default, IlFalse if gray scale is selected.

setCopiesNumber()

virtual void IlvPSPrinter::DialogHandle::setCopiesNumber ( IlUInt  copies )

pure virtual

Sets the default number of copies.

Parameters

copies

The number of copies.

SetFactory()

void IlvPSPrinter::DialogHandle::SetFactory ( Factory *  factory )

static

Sets the dialog handle factory.

This factory, if it exists, is used to build a DialogHandle.

Parameters

factory

A pointer to a Factory.

setFilename()

virtual void IlvPSPrinter::DialogHandle::setFilename ( IlString const &  name )

pure virtual

Sets the default file name.

Parameters

name	The default file name.

setOrientation()

virtual void IlvPSPrinter::DialogHandle::setOrientation ( IlvPrinter::Orientation  orientation )

pure virtual

Sets the default printer orientation.

Parameters

orientation

The new printer orientation.

setPaperFormat()

virtual void IlvPSPrinter::DialogHandle::setPaperFormat ( IlString const &  format )

pure virtual

Sets the default paper format.

Parameters

format

The name of the new default format.