Rogue Wave Views 5.6
Rogue Wave Views
Foundation Package API Reference Guide
Rogue Wave Views
Documentation Home
Rogue Wave Views 5.6 |
Rogue Wave Views |
Rogue Wave Views Documentation Home |
This class defines a layout using a given size on the paper. More...
#include <ilviews/printing/flayout.h>
Public Member Functions | |
| IlvPrintableLayoutFixedSize (IlvPrintUnit const &width, IlvPrintUnit const &height) | |
| Default constructor. More... | |
| virtual int | getPageNumber (IlvPrintableJob &job) const |
| Gets the number of logical pages for this layout and the print settings given as argument. More... | |
 Public Member Functions inherited from IlvPrintableLayoutMultiplePages | |
| IlvPrintableLayoutMultiplePages (int columns=2, int rows=2) | |
| Default constructor. More... | |
| virtual int | getColumns () const |
| Returns the number of columns of the layout. More... | |
| virtual IlvDim | getFooterAreaHeight () const |
| Returns the height of the footer area. More... | |
| virtual IlvDim | getHeaderAreaHeight () const |
| Returns the height of the header area. More... | |
| IlvRect | getPrintableArea (IlvPrinter const &printer) const |
| Returns the total usable area. More... | |
| virtual int | getRows () const |
| Returns the number of rows of the layout. More... | |
| virtual void | initializeBackgroundArea (IlvPrintableJob &job) const |
| Initializes the background area. More... | |
| virtual void | initializeFooterArea (IlvPrintableJob &job) const |
| Initializes the footer area. More... | |
| virtual void | initializeForegroundArea (IlvPrintableJob &job) const |
| Initializes the foreground area. More... | |
| virtual void | initializeHeaderArea (IlvPrintableJob &job) const |
| Initializes the header area. More... | |
| virtual void | initializeMainArea (IlvPrintableJob &job) const |
| Initializes the main area. More... | |
| void | setColumns (int columns) |
| Sets the number of columns of the layout. More... | |
| virtual void | setFooterAreaHeight (IlvDim height) |
| Sets the height of the footer area. More... | |
| virtual void | setHeaderAreaHeight (IlvDim height) |
| Sets the height of the header area. More... | |
| void | setRows (int rows) |
| Sets the number of rows of the layout. More... | |
| virtual void | updateBackgroundArea (IlvPrintableJob &job, int pageIndex) const |
| Updates the background area. More... | |
| virtual void | updateFooterArea (IlvPrintableJob &job, int pageIndex) const |
| Updates the footer area. More... | |
| virtual void | updateForegroundArea (IlvPrintableJob &job, int pageIndex) const |
| Updates the foreground area. More... | |
| virtual void | updateHeaderArea (IlvPrintableJob &job, int pageIndex) const |
| Updates the header area. More... | |
| Public Member Functions inherited from IlvPrintableLayout | |
| IlvPrintableLayout () | |
| Default constructor. More... | |
| virtual | ~IlvPrintableLayout () |
| Destructor. More... | |
| IlvPrintableArea const & | getBackgroundArea (IlvPrintableJob &job, int pageIndex) const |
| Gets the updated background area. More... | |
| IlvPrintable * | getBackgroundPrintable () const |
Gets the IlvPrintable used to print the background. More... | |
| IlvDim | getBottomMargin () const |
| Returns the bottom margin. More... | |
| IlvPrintableArea const & | getFooterArea (IlvPrintableJob &job, int pageIndex) const |
| Gets the updated footer area. More... | |
| IlvPrintable * | getFooterPrintable () const |
Gets the IlvPrintable used to print the footer. More... | |
| IlvPrintableArea const & | getForegroundArea (IlvPrintableJob &job, int pageIndex) const |
| Gets the updated foreground area. More... | |
| IlvPrintable * | getForegroundPrintable () const |
Gets the IlvPrintable used to print the foreground. More... | |
| IlvDim | getGutterMargin () const |
| Returns the gutter margin. More... | |
| IlvPrintableArea const & | getHeaderArea (IlvPrintableJob &job, int pageIndex) const |
| Gets the updated header area. More... | |
| IlvPrintable * | getHeaderPrintable () const |
Gets the IlvPrintable used to print the header. More... | |
| IlvDim | getLeftMargin () const |
| Returns the left margin. More... | |
| IlvPrintableArea const & | getMainArea (IlvPrintableJob &job, int pageIndex) const |
| Gets the updated main area. More... | |
| void | getMargins (IlvDim &left, IlvDim &right, IlvDim &top, IlvDim &bottom, IlvDim &gutter) const |
| Returns the margins. More... | |
| IlUInt | getRefCount () const |
| Returns the number of references on this instance. More... | |
| IlvDim | getRightMargin () const |
| Returns the right margin. More... | |
| IlvDim | getTopMargin () const |
| Returns the top margin. More... | |
| IlvRect | getUsableArea (IlvPrinter const &printer, IlBoolean isGutterOnLeft=IlTrue) const |
| Returns the usable logical printable area for a page. More... | |
| IlBoolean | isRatioKept () const |
| Returns whether the ratio is kept. More... | |
| void | lock () |
| Locks the current instance. More... | |
| IlBoolean | print (IlvPrintableJob &job, int copyNumber) const |
Prints an IlvPrintable according to the layout specified by this object. More... | |
| void | setBackgroundPrintable (IlvPrintable *printable) |
Sets the IlvPrintable used to print the background. More... | |
| void | setBottomMargin (IlvDim margin) |
| Sets the bottom margin. More... | |
| void | setFooterPrintable (IlvPrintable *printable) |
Sets the IlvPrintable used to print the footer. More... | |
| void | setForegroundPrintable (IlvPrintable *printable) |
Sets the IlvPrintable used to print the foreground. More... | |
| void | setGutterMargin (IlvDim margin) |
| Sets the gutter margin. More... | |
| void | setHeaderPrintable (IlvPrintable *printable) |
Sets the IlvPrintable used to print the header. More... | |
| void | setKeepingRatio (IlBoolean keepRatio) |
| Sets whether the ratio is kept. More... | |
| void | setLeftMargin (IlvDim margin) |
| Sets the left margin. More... | |
| void | setMargins (IlvDim left, IlvDim right, IlvDim top, IlvDim bottom, IlvDim gutter=0) |
| Sets the margins. More... | |
| void | setRightMargin (IlvDim margin) |
| Sets the right margin. More... | |
| void | setTopMargin (IlvDim margin) |
| Sets the top margin. More... | |
| void | unlock () |
| Unlocks the current instance. More... | |
Protected Member Functions | |
| virtual void | updateMainArea (IlvPrintableJob &job, int pageIndex) const |
| Updates the main area. More... | |
This class defines a layout using a given size on the paper.
Library: ilvprint
This layout can produce multiple pages.
| IlvPrintableLayoutFixedSize::IlvPrintableLayoutFixedSize | ( | IlvPrintUnit const & | width, |
| IlvPrintUnit const & | height | ||
| ) |
Default constructor.
This is the default constructor. It initializes the object in a coherent state. There are no additional margins by default.
|
virtual |
Gets the number of logical pages for this layout and the print settings given as argument.
| job | The current print settings. |
Reimplemented from IlvPrintableLayoutMultiplePages.
|
protectedvirtual |
Updates the main area.
The purpose of this function is to update the IlvPrintableArea main object. The job as well as the page index given as parameters may be used to compute the current size of the area.
| job | The current print settings. |
| pageIndex | The current logical page index (for this layout). |
Reimplemented from IlvPrintableLayoutMultiplePages.
© 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.