IlvPaperFormat Class Reference

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

Detailed Description

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

Member Function Documentation

static IlvPaperFormat* IlvPaperFormat::Get ( IlString const &  name )

static

This static method returns a registered paper format.

Parameters

name	The paper format name.

Returns

The registered paper format named name, or 0 if none is found.

static IlvPaperFormat* IlvPaperFormat::Get ( IlUShort  dmPaperSize )

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.

Parameters

dmPaperSize

The Windows predefined value for the size of the paper.

Returns

The registered paper format that is related to dmPaperSize, or 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.

Returns

The Windows predefined value for the size of the paper associated with the format.

IlString IlvPaperFormat::getName

(

)

const

Returns the name (if any) of the paper physical format.

Returns

The name of the paper format.

IlvDim IlvPaperFormat::getPaperHeight

(

)

const

Returns the paper height in points.

Returns

The paper height.

IlvRect const & IlvPaperFormat::getPaperSize

(

)

const

Returns the paper format in points.

Returns

The dimensions of the paper format.

IlvDim IlvPaperFormat::getPaperWidth

(

)

const

Returns the paper width in points.

Returns

The paper width.

static IlvPaperFormat** IlvPaperFormat::GetRegisteredPaperFormats ( IlUInt &  count )

static

Returns a list of registered paper formats.

Parameters

count

The number of register paper formats.

Returns

An array of count IlvPaperFormats.

static void IlvPaperFormat::LoadFromXML ( ILVSTDPREF istream &  stream )

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.

Parameters

stream

The stream to read from.

static IlvPaperFormat& IlvPaperFormat::Register ( IlString const &  name, IlvDim  width, IlvDim  height  )

static

This static method creates and registers a paper format.

Parameters

name	The name of the paper format.
width	The width of the paper in points.
height	The height of the paper in points.
specific	This parameter is useful only for Windows. The value is the same as those defined for the field dmPaperSize of the Windows structure DEVMODE (declared in wingdi.h).

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.

Parameters

The	Windows predefined value for the size of the paper associated with the format.

static IlBoolean IlvPaperFormat::UnRegister ( IlvPaperFormat *  format )

static

This static method unregisters a paper format.

Parameters

format

The paper format to unregister.

Returns

An IlBoolean value indicating the success of the unregistering.