rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvPrintableFrame Class Reference

This class prints a frame (a rectangle). More...

#include <ilviews/printing/printables.h>

Inheritance diagram for IlvPrintableFrame:
IlvPrintable

List of all members.

Public Member Functions

 IlvPrintableFrame (IlvPalette *palette)
 The constructor.
 ~IlvPrintableFrame ()
 The destructor.
virtual IlvRect getBBox (IlvPrintableJob const &job) const
 Gets the bounding box of the area to print.
IlvPalettegetPalette () const
 Gets the palette used to print the text.
void setPalette (IlvPalette *palette)
 Sets the palette used to print the text.

Protected Member Functions

virtual IlBoolean internalPrint (IlvPrintableJob const &job) const
 This function actually prints the document.

Detailed Description

This class prints a frame (a rectangle).

Library: ilvprint

See also:
IlvPrintableDocument::append

Constructor & Destructor Documentation

IlvPrintableFrame::IlvPrintableFrame ( IlvPalette palette  ) 

The constructor.

It locks the palette.

Parameters:
palette The palette used to print the frame.
IlvPrintableFrame::~IlvPrintableFrame (  ) 

The destructor.

It unlocks the palette.


Member Function Documentation

virtual IlvRect IlvPrintableFrame::getBBox ( IlvPrintableJob const &  job  )  const [virtual]

Gets the bounding box of the area to print.

Returns:
The bounding box.

Implements IlvPrintable.

IlvPalette * IlvPrintableFrame::getPalette (  )  const

Gets the palette used to print the text.

Returns:
The palette used to print the text.
virtual IlBoolean IlvPrintableFrame::internalPrint ( IlvPrintableJob const &  job  )  const [protected, virtual]

This function actually prints the document.

Parameters:
job The settings of the current print job.
Returns:
IlFalse if an error occurred during the printing, IlTrue otherwise.

Implements IlvPrintable.

void IlvPrintableFrame::setPalette ( IlvPalette palette  ) 

Sets the palette used to print the text.

Parameters:
palette The palette used to print the text.

© 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.