Rogue Wave Views
Gadgets Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvPostScriptPrinterDialog Class Reference

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

#include <ilviews/printing/dialogs.h>

Inheritance diagram for IlvPostScriptPrinterDialog:
IlvDialog IlvGadgetContainer IlvContainer IlvStylist IlvDrawingView IlvDrawingView IlvView IlvView IlvAbstractView IlvAbstractView IlvSystemPort IlvStylable IlvSystemPort IlvStylable IlvPort IlvPort IlvValueInterface IlvValueInterface

Public Member Functions

 IlvPostScriptPrinterDialog (IlvDisplay *display, IlvSystemView transientFor=0)
 Constructor. More...
 
IlBoolean get (IlBoolean grab=IlFalse, IlvCursor *cursor=0)
 Shows the dialog and returns the result. More...
 
IlUInt getCopiesNumber () const
 Returns the selected number of copies. More...
 
IlString getFilename () const
 Returns the selected file name. More...
 
void getMargins (IlvDim &left, IlvDim &right, IlvDim &top, IlvDim &bottom) const
 Gets the selected margin values. More...
 
IlvPrinter::Orientation getOrientation () const
 Returns the selected printer orientation. More...
 
IlvPaperFormat const & getPaperFormat () const
 Returns the selected paper format. More...
 
IlBoolean isCollateOn () const
 Returns whether collate is selected. More...
 
IlBoolean isColorModeOn () const
 Returns a Boolean indicating the color mode. More...
 
void setCollate (IlBoolean collate, IlBoolean redraw=IlFalse)
 Sets whether collate is selected by default. More...
 
void setColorMode (IlBoolean useColor, IlBoolean redraw=IlFalse)
 Sets the default color mode. More...
 
void setCopiesNumber (IlUInt copies, IlBoolean redraw=IlFalse)
 Sets the default number of copies. More...
 
void setFilename (IlString const &name, IlBoolean redraw=IlFalse)
 Sets the default file name. More...
 
void setMargins (IlvDim left, IlvDim right, IlvDim top, IlvDim bottom)
 Sets the default margin values. More...
 
void setOrientation (IlvPrinter::Orientation orientation, IlBoolean redraw=IlFalse)
 Sets the default printer orientation. More...
 
void setPaperFormat (IlString const &format, IlBoolean redraw=IlFalse)
 Sets the default paper format. More...
 
void setUnit (IlvPrintUnit &unit, IlBoolean redraw=IlFalse)
 Sets the default unit. More...
 
- Public Member Functions inherited from IlvDialog
 IlvDialog (IlvDisplay *display, const char *name, const char *title, const IlvRect &rect, IlUInt properties=0, IlvSystemView transientFor=0)
 Constructor. More...
 
 IlvDialog (IlvDisplay *display, const char *name, const char *title, const char *filename, const IlvRect *rect=0)
 Constructor. More...
 
 IlvDialog (IlvDisplay *display, const char *name, const char *title, const char *filename, IlUInt properties, const IlvRect *rect=0, IlvSystemView transientFor=0)
 Constructor. More...
 
virtual void apply ()
 Is called when the callback associated with the apply symbol is triggered. More...
 
virtual void cancel ()
 Is called when the callback associated with the cancel symbol is triggered. More...
 
virtual void wait (IlBoolean grab=IlFalse, IlvCursor *cursor=0)
 Displays a modal dialog. More...
 
IlBoolean wasCanceled () const
 Returns the status of the dialog after closing it. More...
 
- Public Member Functions inherited from IlvGadgetContainer
 IlvGadgetContainer (IlvDisplay *display, const char *name, const char *title, const IlvRect &rect, IlBoolean useacc=IlFalse, IlBoolean visible=IlTrue)
 Constructor. More...
 
 IlvGadgetContainer (IlvDisplay *display, const char *name, const char *title, const IlvRect &rect, IlUInt properties, IlBoolean useacc=IlFalse, IlBoolean visible=IlTrue, IlvSystemView transientFor=0)
 Constructor. More...
 
 IlvGadgetContainer (IlvAbstractView *parent, const IlvRect &rect, IlBoolean useacc=IlFalse, IlBoolean visible=IlTrue)
 Constructor. More...
 
 IlvGadgetContainer (IlvDisplay *display, IlvSystemView parent, const IlvRect &rect, IlBoolean useacc=IlFalse, IlBoolean visible=IlTrue)
 Constructor. More...
 
 IlvGadgetContainer (IlvDisplay *display, IlvSystemView window, IlBoolean useacc=IlFalse)
 Constructor. More...
 
virtual IlBoolean allowFocus (IlBoolean value)
 Specifies whether the container manages the focus. More...
 
virtual void applyResize (IlFloat sx, IlFloat sy, IlBoolean redraw=IlTrue)
 Is called to carry out the resize events applying to the gadget container. More...
 
IlBoolean autoResize (IlBoolean a)
 Sets the auto resize mode of the gadget container. More...
 
IlvButtongetDefaultButton () const
 Returns the default button of the gadget container. More...
 
virtual IlvGraphicgetFirstFocusGraphic () const
 Returns the first object that receives the focus in this container. More...
 
virtual IlvGraphicgetFocus () const
 Returns the object that has the keyboard focus in the gadget container. More...
 
virtual IlvGraphicgetGrab () const
 Returns the object that is currently grabbing events in the container. More...
 
virtual IlvGraphicgetLastFocusGraphic () const
 Returns the last object that receives the focus in this container. More...
 
IlvLookFeelHandlergetLookFeelHandler () const
 Returns the look and feel handler associated with this container. More...
 
virtual IlvGraphicgetNextFocusGraphic (IlvGraphic *object) const
 Returns the next object that will receive the focus after the specified object. More...
 
IlvGraphicgetOverriddenFocus () const
 Returns the object that will receive the focus after calling setFocus(). More...
 
virtual IlvGraphicgetPreviousFocusGraphic (IlvGraphic *object) const
 Returns the previous object that received the focus before the specified object. More...
 
IlBoolean isAutoResizing () const
 Indicates whether the gadget container gets resized when loading a file. More...
 
virtual IlBoolean isFocusAllowed () const
 Indicates whether the focus is allowed in the container. More...
 
virtual void moveFocusAfter (IlBoolean redraw=IlTrue)
 Is called to find the next focusable object. More...
 
virtual void moveFocusBefore (IlBoolean redraw=IlTrue)
 Is called to find the previous focusable object. More...
 
void overrideFocus (IlvGraphic *obj)
 Sets the object that will receive the focus after calling setFocus(). More...
 
virtual void removeGrab ()
 Cancels the grabbing settings defined with setGrab(). More...
 
void setDefaultButton (IlvButton *button, IlBoolean redraw=IlTrue)
 Sets the default button of the gadget container. More...
 
virtual void setFocus (IlvGraphic *graphic=0, IlBoolean redraw=IlTrue)
 Sets the focus to the specified object of the gadget container. More...
 
virtual void setGrab (IlvGraphic *object)
 Sets the specified object as the grabbing object. More...
 
void setLookFeelHandler (IlvLookFeelHandler *lfh)
 Sets the look and feel handler of this container. More...
 

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
displayConnection to the display.
transientForThe 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
grabSpecifies 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.
cursorThe cursor used to choose the color when the dialog is system modal.
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
leftThe left border value.
rightThe right border value.
topThe top border value.
bottomThe 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
collateAn IlBoolean indicating if collate is selected by default.
redrawIlTrue if the dialog needs to be redrawn.
void IlvPostScriptPrinterDialog::setColorMode ( IlBoolean  useColor,
IlBoolean  redraw = IlFalse 
)

Sets the default color mode.

Parameters
useColorIlTrue if color is selected by default, IlFalse if gray scale is selected.
redrawIlTrue if the dialog needs to be redrawn.
void IlvPostScriptPrinterDialog::setCopiesNumber ( IlUInt  copies,
IlBoolean  redraw = IlFalse 
)

Sets the default number of copies.

Parameters
copiesThe number of copies.
redrawIlTrue if the dialog needs to be redrawn.
void IlvPostScriptPrinterDialog::setFilename ( IlString const &  name,
IlBoolean  redraw = IlFalse 
)

Sets the default file name.

Parameters
nameThe default file name.
redrawIlTrue if the dialog needs to be redrawn.
void IlvPostScriptPrinterDialog::setMargins ( IlvDim  left,
IlvDim  right,
IlvDim  top,
IlvDim  bottom 
)

Sets the default margin values.

Parameters
leftThe default left border value.
rightThe default right border value.
topThe default top border value.
bottomThe default bottom border value.
void IlvPostScriptPrinterDialog::setOrientation ( IlvPrinter::Orientation  orientation,
IlBoolean  redraw = IlFalse 
)

Sets the default printer orientation.

Parameters
orientationThe new printer orientation.
redrawIlTrue if the dialog needs to be redrawn.
void IlvPostScriptPrinterDialog::setPaperFormat ( IlString const &  format,
IlBoolean  redraw = IlFalse 
)

Sets the default paper format.

Parameters
formatThe name of the new default format.
redrawIlTrue if the dialog needs to be redrawn.
void IlvPostScriptPrinterDialog::setUnit ( IlvPrintUnit unit,
IlBoolean  redraw = IlFalse 
)

Sets the default unit.

Parameters
unitThe default unit.
redrawIlTrue if the dialog needs to be redrawn.

© Copyright 2016, 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.