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

#include <PdfExtGState.h>

Inheritance diagram for PoDoFo::PdfExtGState:
PoDoFo::PdfElement

Public Member Functions

 PdfExtGState (PdfVecObjects *pParent)
 
 PdfExtGState (PdfDocument *pParent)
 
const PdfNameGetIdentifier () const
 
void SetFillOpacity (float opac)
 
void SetStrokeOpacity (float opac)
 
void SetBlendMode (const char *blendMode)
 
void SetOverprint (bool enable=true)
 
void SetFillOverprint (bool enable=true)
 
void SetStrokeOverprint (bool enable=true)
 
void SetNonZeroOverprint (bool enable=true)
 
void SetRenderingIntent (const char *intent)
 
void SetFrequency (double frequency)
 
- 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 wraps the ExtGState object used in the Resource Dictionary of a Content-supporting element (page, Pattern, etc.) The main usage is for transparency, but it also support a variety of prepress features.

Constructor & Destructor Documentation

PoDoFo::PdfExtGState::PdfExtGState ( PdfVecObjects pParent)

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

Parameters
pParentparent vector of objects
PoDoFo::PdfExtGState::PdfExtGState ( PdfDocument pParent)

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

Parameters
pParentparent document

Member Function Documentation

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

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

Returns
PdfName containing the identifier (e.g. /ExtGS13)
void PoDoFo::PdfExtGState::SetBlendMode ( const char *  blendMode)

Sets the transparency blend mode

Parameters
blendModeone of the predefined blending modes (see PodofoDefines.h)
void PoDoFo::PdfExtGState::SetFillOpacity ( float  opac)

Sets the opacity value to be used for fill operations

Parameters
opaca floating point value from 0 (transparent) to 1 (opaque)
void PoDoFo::PdfExtGState::SetFillOverprint ( bool  enable = true)

Enables/Disables overprinting for Fill operations

Parameters
enableenable or disable
void PoDoFo::PdfExtGState::SetFrequency ( double  frequency)

Set the frequency for halftones

Parameters
frequencyscreen frequency, measured in halftone cells per inch in device space
void PoDoFo::PdfExtGState::SetNonZeroOverprint ( bool  enable = true)

Enables/Disables non-zero overprint mode

Parameters
enableenable or disable
void PoDoFo::PdfExtGState::SetOverprint ( bool  enable = true)

Enables/Disables overprinting for both Fill & Stroke

Parameters
enableenable or disable
void PoDoFo::PdfExtGState::SetRenderingIntent ( const char *  intent)

Set the Rendering Intent

Parameters
intentone of the predefined intents (see Podofo.h)
void PoDoFo::PdfExtGState::SetStrokeOpacity ( float  opac)

Sets the opacity value to be used for stroking operations

Parameters
opaca floating point value from 0 (transparent) to 1 (opaque)
void PoDoFo::PdfExtGState::SetStrokeOverprint ( bool  enable = true)

Enables/Disables overprinting for Stroke operations

Parameters
enableenable or disable