OdGsPageParams Class Reference

#include <GsPageParams.h>

Public Member Functions
	OdGsPageParams ()
	OdGsPageParams (double dPaperWidth, double dPaperHeight)
	~OdGsPageParams ()
	OdGsPageParams (const OdGsPageParams &data)
OdGsPageParams &	operator= (const OdGsPageParams &from)
double	getPaperWidth () const
double	getPaperHeight () const
double	getLeftMargin () const
double	getRightMargin () const
double	getTopMargin () const
double	getBottomMargin () const
void	set (double dPaperWidth, double dPaperHeight, double dLeftMargin=0., double dRightMargin=0., double dTopMargin=0., double dBottomMargin=0.)
void	scale (double dScale)

Detailed Description

This class stores printing page size and margins.

Remarks

All values are in millimeters.

See also

TD_Gs

<group OdGs_Classes>

Definition at line 42 of file GsPageParams.h.

Constructor & Destructor Documentation

OdGsPageParams() [1/3]

OdGsPageParams::OdGsPageParams ( )

inline

Default constructor for the OdGsPageParams class. Sets the following data members:

member Value Description m_dPaperWidth 210. Paper width of the page. m_dPaperHeight 297. Paper height of the page. m_dLeftMargin 0. Left margin of the page. m_dRightMargin 0. Right margin of the page. m_dTopMargin 0. Top margin of the page. m_dBottomMargin 0. Bottom margin of the page.

Definition at line 64 of file GsPageParams.h.

OdGsPageParams() [2/3]

OdGsPageParams::OdGsPageParams ( double  dPaperWidth, double  dPaperHeight  )

inline

Constructor for the OdGsPageParams class. Sets the specified page width and height. Page margin parameters are set to 0.

Parameters

dPaperWidth	[in] Page width.
dPaperHeight	[in] Page height.

Definition at line 80 of file GsPageParams.h.

~OdGsPageParams()

OdGsPageParams::~OdGsPageParams ( )

inline

Destructor for the OdGsOverlayDataContainer class.

Definition at line 93 of file GsPageParams.h.

OdGsPageParams() [3/3]

OdGsPageParams::OdGsPageParams ( const OdGsPageParams &  data )

inline

Copy constructor for the OdGsPageParams class. Copies the passed object with page parameters.

Parameters

data	[in] Page parameters object to copy.

Definition at line 102 of file GsPageParams.h.

Member Function Documentation

getBottomMargin()

double OdGsPageParams::getBottomMargin ( ) const

inline

Retrieves page bottom margin in mm.

Definition at line 151 of file GsPageParams.h.

getLeftMargin()

double OdGsPageParams::getLeftMargin ( ) const

inline

Retrieves page left margin in mm.

Definition at line 136 of file GsPageParams.h.

getPaperHeight()

double OdGsPageParams::getPaperHeight ( ) const

inline

Retrieves page paper height in mm.

Definition at line 131 of file GsPageParams.h.

getPaperWidth()

double OdGsPageParams::getPaperWidth ( ) const

inline

Retrieves page paper width in mm.

Definition at line 126 of file GsPageParams.h.

getRightMargin()

double OdGsPageParams::getRightMargin ( ) const

inline

Retrieves page right margin in mm.

Definition at line 141 of file GsPageParams.h.

getTopMargin()

double OdGsPageParams::getTopMargin ( ) const

inline

Retrieves page top margin in mm.

Definition at line 146 of file GsPageParams.h.

operator=()

OdGsPageParams & OdGsPageParams::operator= ( const OdGsPageParams &  from )

inline

Assignment operator for the OdGsPageParams class.

Parameters

from	[in] Object from which to assign page parameters.

Definition at line 112 of file GsPageParams.h.

scale()

void OdGsPageParams::scale ( double  dScale )

inline

Scales page parameters.

Parameters

dScale

[in] Scale factor.

Definition at line 206 of file GsPageParams.h.

set()

void OdGsPageParams::set ( double  dPaperWidth, double  dPaperHeight, double  dLeftMargin = 0., double  dRightMargin = 0., double  dTopMargin = 0., double  dBottomMargin = 0.  )

inline

Sets page parameters.

Parameters

dPaperWidth	[in] Page width.
dPaperHeight	[in] Page height.
dLeftMargin	[in] Left margin of the page.
dRightMargin	[in] Right margin of the page.
dTopMargin	[in] Top margin of the page.
dBottomMargin	[in] Bottom margin of the page.

Definition at line 163 of file GsPageParams.h.

---

The documentation for this class was generated from the following file:

• GsPageParams.h