PoDoFo  0.9.4
Public Member Functions | List of all members
PoDoFo::PdfRect Class Reference

#include <PdfRect.h>

Public Member Functions

 PdfRect ()
 
 PdfRect (double left, double bottom, double width, double height)
 
 PdfRect (const PdfArray &inArray)
 
 PdfRect (const PdfRect &rhs)
 
void ToVariant (PdfVariant &var) const
 
std::string ToString () const
 
void FromArray (const PdfArray &inArray)
 
void Intersect (const PdfRect &rRect)
 
double GetBottom () const
 
void SetBottom (double dBottom)
 
double GetLeft () const
 
void SetLeft (double lLeft)
 
double GetWidth () const
 
void SetWidth (double lWidth)
 
double GetHeight () const
 
void SetHeight (double lHeight)
 

Detailed Description

A rectangle as defined by the PDF reference

Constructor & Destructor Documentation

PoDoFo::PdfRect::PdfRect ( )

Create an empty rectangle with bottom=left=with=height=0

PoDoFo::PdfRect::PdfRect ( double  left,
double  bottom,
double  width,
double  height 
)

Create a rectangle with a given size and position All values are in PDF units NOTE: since PDF is bottom-left origined, we pass the bottom instead of the top

PoDoFo::PdfRect::PdfRect ( const PdfArray inArray)

Create a rectangle from an array All values are in PDF units

PoDoFo::PdfRect::PdfRect ( const PdfRect rhs)

Copy constructor

Member Function Documentation

void PoDoFo::PdfRect::FromArray ( const PdfArray inArray)

Assigns the values of this PdfRect from the 4 values in the array

Parameters
inArraythe array to load the values from
double PoDoFo::PdfRect::GetBottom ( ) const
inline

Get the bottom coordinate of the rectangle

Returns
bottom
double PoDoFo::PdfRect::GetHeight ( ) const
inline

Get the height of the rectangle

Returns
height in PDF units
double PoDoFo::PdfRect::GetLeft ( ) const
inline

Get the left coordinate of the rectangle

Returns
left in PDF units
double PoDoFo::PdfRect::GetWidth ( ) const
inline

Get the width of the rectangle

Returns
width in PDF units
void PoDoFo::PdfRect::Intersect ( const PdfRect rRect)

Intersect with another rect

Parameters
rRectthe rect to intersect with
void PoDoFo::PdfRect::SetBottom ( double  dBottom)
inline

Set the bottom coordinate of the rectangle

Parameters
dBottom
void PoDoFo::PdfRect::SetHeight ( double  lHeight)
inline

Set the height of the rectangle

Parameters
lHeightin PDF units
void PoDoFo::PdfRect::SetLeft ( double  lLeft)
inline

Set the left coordinate of the rectangle

Parameters
lLeftin PDF units
void PoDoFo::PdfRect::SetWidth ( double  lWidth)
inline

Set the width of the rectangle

Parameters
lWidthin PDF units
std::string PoDoFo::PdfRect::ToString ( ) const

Returns a string representation of the PdfRect

Returns
std::string representation as [ left bottom right top ]
void PoDoFo::PdfRect::ToVariant ( PdfVariant var) const

Converts the rectangle into an array based on PDF units and adds the array into an variant.

Parameters
varthe variant to store the Rect