DWFToolkit::DWFPaper Class Reference
[DWF Package API]

#include "dwf/package/Paper.h"

Inheritance diagram for DWFToolkit::DWFPaper:

Inheritance graph
[legend]
Collaboration diagram for DWFToolkit::DWFPaper:

Collaboration graph
[legend]
List of all members.

Detailed Description

This class represents the virtual paper upon which all 2D graphics are plotted.

Since:
7.0.1
Examples:

3DPublish/3DPublish_UTF8.cpp, SimpleEPlotWriter/SimpleEPlotWriter_UTF8.cpp, and WriteContent/WriteContent.cpp.

Definition at line 48 of file Paper.h.

Public Types

enum  teUnits

Public Member Functions

typedef _DWFTK_STD_VECTOR (DWFPaper *) tList
 This type defines a list of DWFPaper pointers.
_DWFTK_API DWFPaper () throw ()
_DWFTK_API DWFPaper (double nWidth, double nHeight, teUnits eUnits=eUnknown, unsigned int nColorARGB=0x00ffffff, const double *anClip=NULL, bool bShow=true) throw ()
_DWFTK_API DWFPaper (const DWFPaper &rPaper) throw ()
_DWFTK_API DWFPaperoperator= (const DWFPaper &rPaper) throw ()
virtual _DWFTK_API ~DWFPaper () throw ()
_DWFTK_API bool show () const throw ()
_DWFTK_API double width () const throw ()
_DWFTK_API double height () const throw ()
_DWFTK_API unsigned int color () const throw ()
_DWFTK_API const double *const clip () const throw ()
_DWFTK_API const teUnits units () const throw ()
virtual _DWFTK_API void parseAttributeList (const char **ppAttributeList) throw ( DWFException )
_DWFTK_API void serializeXML (DWFXMLSerializer &rSerializer, unsigned int nFlags) throw ( DWFException )


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFPaper::DWFPaper  )  throw ()
 

Constructor

Exceptions:
None 

_DWFTK_API DWFToolkit::DWFPaper::DWFPaper double  nWidth,
double  nHeight,
teUnits  eUnits = eUnknown,
unsigned int  nColorARGB = 0x00ffffff,
const double *  anClip = NULL,
bool  bShow = true
throw ()
 

Constructor

Parameters:
nWidth The paper width in eUnits.
nHeight The paper height in eUnits.
eUnits The units in which the paper dimensions apply.
nColorARGB The paper color (as a 32-bit value)
anClip An optional clipping path to be applied to the paper graphics.
bShow Indicates whether or not the paper should be shown under the graphics.
Exceptions:
None 

_DWFTK_API DWFToolkit::DWFPaper::DWFPaper const DWFPaper rPaper  )  throw ()
 

Copy Constructor

Parameters:
rPaper The source paper from which to copy.
Exceptions:
None 

virtual _DWFTK_API DWFToolkit::DWFPaper::~DWFPaper  )  throw () [virtual]
 

Destructor

Exceptions:
None 


Member Function Documentation

_DWFTK_API const double* const DWFToolkit::DWFPaper::clip  )  const throw () [inline]
 

Returns the path by which the graphic data should be clipped.

Returns:
The clipping path. This pointer should not be deleted by the caller.
Exceptions:
None 

Definition at line 193 of file Paper.h.

_DWFTK_API unsigned int DWFToolkit::DWFPaper::color  )  const throw () [inline]
 

Returns the 32-bit paper color.

Returns:
The color value.
Exceptions:
None 

Definition at line 179 of file Paper.h.

_DWFTK_API double DWFToolkit::DWFPaper::height  )  const throw () [inline]
 

Returns the vertical dimension in units().

Returns:
The paper height.
Exceptions:
None 

Definition at line 166 of file Paper.h.

_DWFTK_API DWFPaper& DWFToolkit::DWFPaper::operator= const DWFPaper rPaper  )  throw ()
 

Assignment Operator

Parameters:
rPaper The source paper from which to copy.
Exceptions:
None 

virtual _DWFTK_API void DWFToolkit::DWFPaper::parseAttributeList const char **  ppAttributeList  )  throw ( DWFException ) [virtual]
 

Implements DWFCore::DWFXMLBuildable.

_DWFTK_API void DWFToolkit::DWFPaper::serializeXML DWFXMLSerializer rSerializer,
unsigned int  nFlags
throw ( DWFException )
 

_DWFTK_API bool DWFToolkit::DWFPaper::show  )  const throw () [inline]
 

Indicates whether or not the paper should be shown under the graphics.

The graphics must still be drawn on the paper regardless of this setting.

Returns:
The show state.
Exceptions:
None 

Definition at line 140 of file Paper.h.

_DWFTK_API const teUnits DWFToolkit::DWFPaper::units  )  const throw () [inline]
 

Returns the units that apply to the paper dimensions.

Returns:
The units enumeration.
Exceptions:
None 

Definition at line 206 of file Paper.h.

_DWFTK_API double DWFToolkit::DWFPaper::width  )  const throw () [inline]
 

Returns the horizontal dimension in units().

Returns:
The paper width.
Exceptions:
None 

Definition at line 153 of file Paper.h.


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:40:31 2009 for Autodesk DWF Toolkit by  doxygen 1.4.5