Rogue Wave Views Foundation Package API Reference Guide |
Rogue Wave Views Documentation Home |
Base class for the paper format classes. More...
#include <ilviews/printing/pformat.h>
Public Member Functions | |
IlUShort | getDmPaperSize () const |
Returns the Windows predefined value for the size of the paper associated with the format. More... | |
IlString | getName () const |
Returns the name (if any) of the paper physical format. More... | |
IlvDim | getPaperHeight () const |
Returns the paper height in points. More... | |
IlvRect const & | getPaperSize () const |
Returns the paper format in points. More... | |
IlvDim | getPaperWidth () const |
Returns the paper width in points. More... | |
void | setDmPaperSize (IlUShort dmPaperSize) |
Sets the Windows predefined value for the size of the paper associated with the format. More... | |
Static Public Member Functions | |
static IlvPaperFormat * | Get (IlString const &name) |
This static method returns a registered paper format. More... | |
static IlvPaperFormat * | Get (IlUShort dmPaperSize) |
This static method returns a registered paper format. More... | |
static IlvPaperFormat ** | GetRegisteredPaperFormats (IlUInt &count) |
Returns a list of registered paper formats. More... | |
static void | LoadFromXML (ILVSTDPREF istream &stream) |
Loads custom paper formats from a specified XML file. The format of the file must be: <?xml version="1.0"?> <paperFormats> <paperFormat name="name" width="width" height="height"/> .... </paperFormats> More... | |
static IlvPaperFormat & | Register (IlString const &name, IlvDim width, IlvDim height) |
This static method creates and registers a paper format. More... | |
static IlBoolean | UnRegister (IlvPaperFormat *format) |
This static method unregisters a paper format. More... | |
Base class for the paper format classes.
Library: ilvprint
Its purpose is to describe a physical paper format. A paper format is always described in portrait mode (width is smaller than height).
|
static |
This static method returns a registered paper format.
name | The paper format name. |
0
if none is found.
|
static |
This static method returns a registered paper format.
This is Windows specific. See the description of the field dmPaperSize of the structure DEVMODE in the documentation of the Windows SDK.
dmPaperSize | The Windows predefined value for the size of the paper. |
0
if none is found. IlUShort IlvPaperFormat::getDmPaperSize | ( | ) | const |
Returns the Windows predefined value for the size of the paper associated with the format.
This is Windows specific. See the description of the field dmPaperSize
of the structure DEVMODE in the documentation of the Windows SDK.
IlString IlvPaperFormat::getName | ( | ) | const |
Returns the name (if any) of the paper physical format.
IlvDim IlvPaperFormat::getPaperHeight | ( | ) | const |
Returns the paper height in points.
IlvRect const& IlvPaperFormat::getPaperSize | ( | ) | const |
Returns the paper format in points.
IlvDim IlvPaperFormat::getPaperWidth | ( | ) | const |
Returns the paper width in points.
|
static |
Returns a list of registered paper formats.
count | The number of register paper formats. |
IlvPaperFormats
.
|
static |
Loads custom paper formats from a specified XML file. The format of the file must be: <?xml version="1.0"?>
<paperFormats>
<paperFormat name="name" width="width" height="height"/>
....
</paperFormats>
Dimensions should be given in points.
stream | The stream to read from. |
|
static |
This static method creates and registers a paper format.
name | The name of the paper format. |
width | The width of the paper in points. |
height | The height of the paper in points. |
void IlvPaperFormat::setDmPaperSize | ( | IlUShort | dmPaperSize | ) |
Sets the Windows predefined value for the size of the paper associated with the format.
This is Windows specific. See the description of the field dmPaperSize of the structure DEVMODE in the documentation of the Windows SDK.
dmPaperSize | The Windows predefined value for the size of the paper associated with the format. |
|
static |
This static method unregisters a paper format.
format | The paper format to unregister. |
IlBoolean
value indicating the success of the unregistering. © Copyright 2016, 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.