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

#include <PdfTilingPattern.h>

Inheritance diagram for PoDoFo::PdfTilingPattern:
PoDoFo::PdfElement

Public Member Functions

const PdfNameGetIdentifier () const
 
 PdfTilingPattern (EPdfTilingPatternType eTilingType, double strokeR, double strokeG, double strokeB, bool doFill, double fillR, double fillG, double fillB, double offsetX, double offsetY, PdfImage *pImage, PdfVecObjects *pParent)
 
 PdfTilingPattern (EPdfTilingPatternType eTilingType, double strokeR, double strokeG, double strokeB, bool doFill, double fillR, double fillG, double fillB, double offsetX, double offsetY, PdfImage *pImage, PdfDocument *pParent)
 
- Public Member Functions inherited from PoDoFo::PdfElement
PdfObjectGetObject ()
 
const PdfObjectGetObject () const
 

Additional Inherited Members

- Protected Member Functions inherited from PoDoFo::PdfElement
 PdfElement (const char *pszType, PdfVecObjects *pParent)
 
 PdfElement (const char *pszType, PdfDocument *pParent)
 
 PdfElement (const char *pszType, PdfObject *pObject)
 
 PdfElement (EPdfDataType eExpectedDataType, PdfObject *pObject)
 
const char * TypeNameForIndex (int i, const char **ppTypes, long lLen) const
 
int TypeNameToIndex (const char *pszType, const char **ppTypes, long lLen, int nUnknownValue) const
 
PdfObjectCreateObject (const char *pszType=NULL)
 
PdfObjectGetNonConstObject () const
 

Detailed Description

This class defined a tiling pattern which can be used to fill abitrary shapes with a pattern using PdfPainter.

Constructor & Destructor Documentation

PoDoFo::PdfTilingPattern::PdfTilingPattern ( EPdfTilingPatternType  eTilingType,
double  strokeR,
double  strokeG,
double  strokeB,
bool  doFill,
double  fillR,
double  fillG,
double  fillB,
double  offsetX,
double  offsetY,
PdfImage pImage,
PdfVecObjects pParent 
)

Create a new PdfTilingPattern object, which will introduce itself automatically to every page object it is used on.

Parameters
eTilingTypethe type of this tiling pattern
strokeRstrok color red component
strokeGstrok color green component
strokeBstrok color blue component
doFillwhether tile fills content first, with fill color
fillRfill color red component
fillGfill color green component
fillBfill color blue component
offsetXtile offset on X axis
offsetYtile offset on Y axis
pImageimage to use - can be set only if eTilingType is ePdfTilingPatternType_Image
pParentparent vector of objects
 \note stroke and fill colors are ignored if eTilingType is ePdfTilingPatternType_Image
 \note fill color is ignored if doFill is false
 \note pImage is ignored for all but ePdfTilingPatternType_Image eTilingType types, where it cannot be NULL
PoDoFo::PdfTilingPattern::PdfTilingPattern ( EPdfTilingPatternType  eTilingType,
double  strokeR,
double  strokeG,
double  strokeB,
bool  doFill,
double  fillR,
double  fillG,
double  fillB,
double  offsetX,
double  offsetY,
PdfImage pImage,
PdfDocument pParent 
)

Create a new PdfTilingPattern object, which will introduce itself automatically to every page object it is used on.

Parameters
eTilingTypethe type of this tiling pattern
strokeRstrok color red component
strokeGstrok color green component
strokeBstrok color blue component
doFillwhether tile fills content first, with fill color
fillRfill color red component
fillGfill color green component
fillBfill color blue component
offsetXtile offset on X axis
offsetYtile offset on Y axis
pImageimage to use - can be set only if eTilingType is ePdfTilingPatternType_Image
pParentparent document
 \note stroke and fill colors are ignored if eTilingType is ePdfTilingPatternType_Image
 \note fill color is ignored if doFill is false
 \note pImage is ignored for all but ePdfTilingPatternType_Image eTilingType types, where it cannot be NULL

Member Function Documentation

const PdfName & PoDoFo::PdfTilingPattern::GetIdentifier ( ) const
inline

Returns the identifier of this TilingPattern how it is known in the pages resource dictionary.

Returns
PdfName containing the identifier (e.g. /PtrnXXXXX)