Views
Foundation Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions | Protected Member Functions
IlvPrintableFrame Class Reference

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

#include <ilviews/printing/printables.h>

Inheritance diagram for IlvPrintableFrame:
IlvPrintable

Public Member Functions

 IlvPrintableFrame (IlvPalette *palette)
 The constructor. More...
 
 ~IlvPrintableFrame ()
 The destructor. More...
 
virtual IlvRect getBBox (IlvPrintableJob const &job) const
 Gets the bounding box of the area to print. More...
 
IlvPalettegetPalette () const
 Gets the palette used to print the text. More...
 
void setPalette (IlvPalette *palette)
 Sets the palette used to print the text. More...
 
- Public Member Functions inherited from IlvPrintable
 IlvPrintable ()
 The default constructor.
 
 IlvPrintable (IlvPrintable const &other)
 The copy constructor. More...
 
virtual ~IlvPrintable ()
 The destructor. More...
 
void lock ()
 Locks the current instance. More...
 
IlvPrintableoperator= (IlvPrintable const &other)
 The assignment operator. More...
 
IlBoolean print (IlvPrintableJob const &job) const
 Prints the contents of the object. More...
 
void unlock ()
 Unlocks the current instance. More...
 

Protected Member Functions

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

Detailed Description

This class prints a frame (a rectangle).

Library: ilvprint

See also
IlvPrintableDocument::append

Constructor & Destructor Documentation

◆ IlvPrintableFrame()

IlvPrintableFrame::IlvPrintableFrame ( IlvPalette palette)

The constructor.

It locks the palette.

Parameters
paletteThe palette used to print the frame.

◆ ~IlvPrintableFrame()

IlvPrintableFrame::~IlvPrintableFrame ( )

The destructor.

It unlocks the palette.

Member Function Documentation

◆ getBBox()

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

Gets the bounding box of the area to print.

Returns
The bounding box.

Implements IlvPrintable.

◆ getPalette()

IlvPalette* IlvPrintableFrame::getPalette ( ) const

Gets the palette used to print the text.

Returns
The palette used to print the text.

◆ internalPrint()

virtual IlBoolean IlvPrintableFrame::internalPrint ( IlvPrintableJob const &  job) const
protectedvirtual

This function actually prints the document.

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

Implements IlvPrintable.

◆ setPalette()

void IlvPrintableFrame::setPalette ( IlvPalette palette)

Sets the palette used to print the text.

Parameters
paletteThe palette used to print the text.