rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvPrintableFormattedText Class Reference

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

#include <ilviews/printing/printables.h>

Inheritance diagram for IlvPrintableFormattedText:
IlvPrintableText IlvPrintable

List of all members.

Public Member Functions

 IlvPrintableFormattedText (IlvPalette *palette, IlString const &text, IlvPosition alignment=IlvCenter)
 The constructor.
virtual IlvRect getBBox (IlvPrintableJob const &job) const
 Gets the bounding box of the area to print.

Protected Member Functions

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

Detailed Description

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

Library: ilvprint

The index of the page will be printed by replacing the occurrences of p found in the text.

The total number of pages will be printed by replacing the occurrences of P found in the text.

The document name will be printed by replacing the occurrences of N found in the text.

The year will be printed by replacing the occurrences of y found in the text.

The month will be printed by replacing the occurrences of M found in the text.

The day of the month will be printed by replacing the occurrences of d found in the text.

The hour of the day (0-24) will be printed by replacing the occurrences of h found in the text.

The hour will be printed by replacing the occurrences of H found in the text.

The minute will be printed by replacing the occurrences of m found in the text.

The second will be printed by replacing the occurrences of s found in the text.

The AM or PM indicator will be printed by replacing the occurrences of AM for capitals and am for lowercase found in the text.

You still may print a p or a P, by replacing them by % or %. You may also print % or % by doubling the "<code>\</code>" and so on. Note that the "<code>\</code>" must be doubled in a C string.

See also:
IlvPrintableDocument::append

Constructor & Destructor Documentation

IlvPrintableFormattedText::IlvPrintableFormattedText ( 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.

Member Function Documentation

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

Gets the bounding box of the area to print.

Returns:
The bounding box.

Reimplemented from IlvPrintableText.

virtual IlBoolean IlvPrintableFormattedText::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.

Reimplemented from IlvPrintableText.


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