rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvPSPrinter::DialogHandle Class Reference

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

#include <views/include.doc/ilviews/printing/psprinter.h>

List of all members.

Classes

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

Public Member Functions

virtual ~DialogHandle ()
 Destructor.
virtual IlBoolean get ()=0
 Shows the dialog and returns the result.
virtual IlUInt getCopiesNumber () const =0
 Returns the selected number of copies.
virtual IlString getFilename () const =0
 Returns the selected file name.
virtual void getMargins (IlvDim &left, IlvDim &right, IlvDim &top, IlvDim &bottom) const =0
 Gets the selected margin values.
virtual IlvPrinter::Orientation getOrientation () const =0
 Returns the selected printer orientation.
virtual IlvPaperFormat const & getPaperFormat () const =0
 Returns the selected paper format.
virtual IlBoolean isCollateOn () const =0
 Returns whether collate is selected.
virtual IlBoolean isColorModeOn () const =0
 Returns a Boolean indicting the color mode.
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.
virtual void setColorMode (IlBoolean useColor)=0
 Sets the default color mode.
virtual void setCopiesNumber (IlUInt copies)=0
 Sets the default number of copies.
virtual void setFilename (IlString const &name)=0
 Sets the default file name.
virtual void setOrientation (IlvPrinter::Orientation orientation)=0
 Sets the default printer orientation.
virtual void setPaperFormat (IlString const &format)=0
 Sets the default paper format.

Static Public Member Functions

static FactoryGetFactory ()
 Gets the dialog handle factory.
static void SetFactory (Factory *factory)
 Sets the dialog handle factory.

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

virtual IlvPSPrinter::DialogHandle::~DialogHandle (  )  [virtual]

Destructor.

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


Member Function Documentation

virtual IlUInt IlvPSPrinter::DialogHandle::getCopiesNumber (  )  const [pure virtual]

Returns the selected number of copies.

Returns:
The selected number of copies.
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.
virtual IlString IlvPSPrinter::DialogHandle::getFilename (  )  const [pure virtual]

Returns the selected file name.

Returns:
The selected file name.
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.
virtual IlvPrinter::Orientation IlvPSPrinter::DialogHandle::getOrientation (  )  const [pure virtual]

Returns the selected printer orientation.

Returns:
The printer orientation.
virtual IlvPaperFormat const& IlvPSPrinter::DialogHandle::getPaperFormat (  )  const [pure virtual]

Returns the selected paper format.

Returns:
The paper format.
virtual IlBoolean IlvPSPrinter::DialogHandle::isCollateOn (  )  const [pure virtual]

Returns whether collate is selected.

Returns:
IlTrue if collate is selected, IlFalse if not.
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.
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.
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.
virtual void IlvPSPrinter::DialogHandle::setCopiesNumber ( IlUInt  copies  )  [pure virtual]

Sets the default number of copies.

Parameters:
copies The number of copies.
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.
virtual void IlvPSPrinter::DialogHandle::setFilename ( IlString const &  name  )  [pure virtual]

Sets the default file name.

Parameters:
name The default file name.
virtual void IlvPSPrinter::DialogHandle::setOrientation ( IlvPrinter::Orientation  orientation  )  [pure virtual]

Sets the default printer orientation.

Parameters:
orientation The new printer orientation.
virtual void IlvPSPrinter::DialogHandle::setPaperFormat ( IlString const &  format  )  [pure virtual]

Sets the default paper format.

Parameters:
format The name of the new default format.

© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.