IlvPostScriptPrinterDialog Class Reference

Dialog to initialize or modify the settings of a printer. More...

#include <ilviews/printing/dialogs.h>

Inheritance diagram for IlvPostScriptPrinterDialog:

List of all members.

Public Member Functions
	IlvPostScriptPrinterDialog (IlvDisplay *display, IlvSystemView transientFor=0)
	Constructor.
IlBoolean	get (IlBoolean grab=IlFalse, IlvCursor *cursor=0)
	Shows the dialog and returns the result.
IlUInt	getCopiesNumber () const
	Returns the selected number of copies.
IlString	getFilename () const
	Returns the selected file name.
void	getMargins (IlvDim &left, IlvDim &right, IlvDim &top, IlvDim &bottom) const
	Gets the selected margin values.
IlvPrinter::Orientation	getOrientation () const
	Returns the selected printer orientation.
IlvPaperFormat const &	getPaperFormat () const
	Returns the selected paper format.
IlBoolean	isCollateOn () const
	Returns whether collate is selected.
IlBoolean	isColorModeOn () const
	Returns a Boolean indicating the color mode.
void	setCollate (IlBoolean collate, IlBoolean redraw=IlFalse)
	Sets whether collate is selected by default.
void	setColorMode (IlBoolean useColor, IlBoolean redraw=IlFalse)
	Sets the default color mode.
void	setCopiesNumber (IlUInt copies, IlBoolean redraw=IlFalse)
	Sets the default number of copies.
void	setFilename (IlString const &name, IlBoolean redraw=IlFalse)
	Sets the default file name.
void	setMargins (IlvDim left, IlvDim right, IlvDim top, IlvDim bottom)
	Sets the default margin values.
void	setOrientation (IlvPrinter::Orientation orientation, IlBoolean redraw=IlFalse)
	Sets the default printer orientation.
void	setPaperFormat (IlString const &format, IlBoolean redraw=IlFalse)
	Sets the default paper format.
void	setUnit (IlvPrintUnit &unit, IlBoolean redraw=IlFalse)
	Sets the default unit.

---

Detailed Description

Dialog to initialize or modify the settings of a printer.

Library: ilvprtdlg

An example using this class is provided in the samples/foundation/printing directory.

See also:

IlvPSPrinter

---

Constructor & Destructor Documentation

IlvPostScriptPrinterDialog::IlvPostScriptPrinterDialog	(	IlvDisplay *	display,
		IlvSystemView	transientFor = 0
	)

Constructor.

Initializes a new instance of an IlvPostScriptPrinterDialog class.

Parameters:

	display	Connection to the display.
	transientFor	The view for which the dialog is transient. For more information about transient windows, see the IlvView constructors.

---

Member Function Documentation

IlBoolean IlvPostScriptPrinterDialog::get	(	IlBoolean	grab = IlFalse,
		IlvCursor *	cursor = 0
	)

Shows the dialog and returns the result.

Parameters:

	grab	A Boolean value specifying whether the dialog should be system modal, that is, grabs input events on the whole system so that, until the function returns, other applications will not be able to get any keyboard or mouse event. In this case, you can specify the cursor to be displayed in the parameter cursor. If grab is set to IlFalse (the default), the dialog is application modal, that is, the application does not receive input events in other windows.
	cursor	The cursor used to choose the color when the dialog is system modal.

Warning:

[note] Some operating systems, such as Windows NT and Windows 95, do not allow system modal dialogs. On these operating systems, dialogs are always application modal.

IlUInt IlvPostScriptPrinterDialog::getCopiesNumber

(

)

const

Returns the selected number of copies.

Returns:

The selected number of copies.

IlString IlvPostScriptPrinterDialog::getFilename

(

)

const

Returns the selected file name.

Returns:

The selected file name.

void IlvPostScriptPrinterDialog::getMargins	(	IlvDim &	left,
		IlvDim &	right,
		IlvDim &	top,
		IlvDim &	bottom
	)			const

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.

IlvPrinter::Orientation IlvPostScriptPrinterDialog::getOrientation

(

)

const

Returns the selected printer orientation.

Returns:

The printer orientation.

IlvPaperFormat const & IlvPostScriptPrinterDialog::getPaperFormat

(

)

const

Returns the selected paper format.

Returns:

The paper format.

IlBoolean IlvPostScriptPrinterDialog::isCollateOn

(

)

const

Returns whether collate is selected.

Returns:

IlTrue if collate is selected, IlFalse if not.

IlBoolean IlvPostScriptPrinterDialog::isColorModeOn

(

)

const

Returns a Boolean indicating the color mode.

Returns:

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

void IlvPostScriptPrinterDialog::setCollate	(	IlBoolean	collate,
		IlBoolean	redraw = IlFalse
	)

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.
	redraw	IlTrue if the dialog needs to be redrawn.

void IlvPostScriptPrinterDialog::setColorMode	(	IlBoolean	useColor,
		IlBoolean	redraw = IlFalse
	)

Sets the default color mode.

Parameters:

	useColor	IlTrue if color is selected by default, IlFalse if gray scale is selected.
	redraw	IlTrue if the dialog needs to be redrawn.

void IlvPostScriptPrinterDialog::setCopiesNumber	(	IlUInt	copies,
		IlBoolean	redraw = IlFalse
	)

Sets the default number of copies.

Parameters:

	copies	The number of copies.
	redraw	IlTrue if the dialog needs to be redrawn.

void IlvPostScriptPrinterDialog::setFilename	(	IlString const &	name,
		IlBoolean	redraw = IlFalse
	)

Sets the default file name.

Parameters:

	name	The default file name.
	redraw	IlTrue if the dialog needs to be redrawn.

void IlvPostScriptPrinterDialog::setMargins	(	IlvDim	left,
		IlvDim	right,
		IlvDim	top,
		IlvDim	bottom
	)

Sets the default margin values.

Parameters:

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

void IlvPostScriptPrinterDialog::setOrientation	(	IlvPrinter::Orientation	orientation,
		IlBoolean	redraw = IlFalse
	)

Sets the default printer orientation.

Parameters:

	orientation	The new printer orientation.
	redraw	IlTrue if the dialog needs to be redrawn.

void IlvPostScriptPrinterDialog::setPaperFormat	(	IlString const &	format,
		IlBoolean	redraw = IlFalse
	)

Sets the default paper format.

Parameters:

	string	The name of the new default format.
	redraw	IlTrue if the dialog needs to be redrawn.

void IlvPostScriptPrinterDialog::setUnit	(	IlvPrintUnit &	unit,
		IlBoolean	redraw = IlFalse
	)

Sets the default unit.

Parameters:

	unit	The default unit.
	redraw	IlTrue if the dialog needs to be redrawn.