rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvPrintableText Class Reference

This class encapsulates a text so that it can be printed with this library. More...

#include <ilviews/printing/printables.h>

Inheritance diagram for IlvPrintableText:
IlvPrintable IlvPrintableFormattedText

List of all members.

Public Member Functions

 IlvPrintableText (IlvPalette *palette, IlString const &text, IlvPosition alignment=IlvCenter)
 The constructor.
 ~IlvPrintableText ()
 The destructor.
IlvPosition getAlignment () const
 Gets the alignment of the text to be printed.
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.
IlString getText () const
 Gets the text to be printed.
void setAlignment (IlvPosition alignment)
 Sets the alignment of the text to be printed.
void setPalette (IlvPalette *palette)
 Sets the palette used to print the text.
void setText (IlString const &text)
 Sets the text to be printed.

Protected Member Functions

virtual IlBoolean internalPrint (IlvPrintableJob const &job) const
 This function actually prints the document.
void modifyText (IlString const &newText) const
 This function modifies the text to be printed.

Detailed Description

This class encapsulates a text so that it can be printed with this library.

Library: ilvprint

See also:
IlvPrintableDocument::append

Constructor & Destructor Documentation

IlvPrintableText::IlvPrintableText ( IlvPalette palette,
IlString const &  text,
IlvPosition  alignment = IlvCenter 
)

The constructor.

It locks the palette.

Parameters:
palette The palette used to print the frame.
text The text to print.
alignment The position of the text.
IlvPrintableText::~IlvPrintableText (  ) 

The destructor.

It unlocks the palette.


Member Function Documentation

IlvPosition IlvPrintableText::getAlignment (  )  const

Gets the alignment of the text to be printed.

Returns:
The alignment of the text to be printed.
virtual IlvRect IlvPrintableText::getBBox ( IlvPrintableJob const &  job  )  const [virtual]

Gets the bounding box of the area to print.

Returns:
The bounding box.

Implements IlvPrintable.

Reimplemented in IlvPrintableFormattedText.

IlvPalette * IlvPrintableText::getPalette (  )  const

Gets the palette used to print the text.

Returns:
The palette used to print the text.
IlString IlvPrintableText::getText (  )  const

Gets the text to be printed.

Returns:
The text to be printed.
virtual IlBoolean IlvPrintableText::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.

Reimplemented in IlvPrintableFormattedText.

void IlvPrintableText::modifyText ( IlString const &  newText  )  const [protected]

This function modifies the text to be printed.

This function is intended to be used by classes such as IlPrintableFormattedText, whose text contains portions to be replaced dynamically during the printing.

Parameters:
newText The new text.
void IlvPrintableText::setAlignment ( IlvPosition  alignment  ) 

Sets the alignment of the text to be printed.

Parameters:
text The alignment of the text to be printed.
void IlvPrintableText::setPalette ( IlvPalette palette  ) 

Sets the palette used to print the text.

Parameters:
palette The palette used to print the text.
void IlvPrintableText::setText ( IlString const &  text  ) 

Sets the text to be printed.

Parameters:
text The text to be printed.

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