PoDoFo
0.9.6
|
#include <PdfPage.h>
Public Member Functions | |
PdfPage (const PdfRect &rSize, PdfDocument *pParent) | |
PdfPage (const PdfRect &rSize, PdfVecObjects *pParent) | |
PdfPage (PdfObject *pObject, const std::deque< PdfObject * > &listOfParents) | |
virtual const PdfRect | GetPageSize () const |
bool | SetPageWidth (int newWidth) |
bool | SetPageHeight (int newHeight) |
void | SetTrimBox (const PdfRect &rSize) |
unsigned int | GetPageNumber () const |
virtual PdfObject * | GetContents () const |
virtual PdfObject * | GetContentsForAppending () const |
virtual PdfObject * | GetResources () const |
virtual const PdfRect | GetMediaBox () const |
virtual const PdfRect | GetCropBox () const |
virtual const PdfRect | GetTrimBox () const |
virtual const PdfRect | GetBleedBox () const |
virtual const PdfRect | GetArtBox () const |
virtual int | GetRotation () const |
virtual void | SetRotation (int nRotation) |
virtual int | GetNumAnnots () const |
PdfAnnotation * | CreateAnnotation (EPdfAnnotation eType, const PdfRect &rRect) |
PdfAnnotation * | GetAnnotation (int index) |
void | DeleteAnnotation (int index) |
void | DeleteAnnotation (const PdfReference &ref) |
int | GetNumFields () const |
PdfField | GetField (int index) |
const PdfField | GetField (int index) const |
PdfObject * | GetFromResources (const PdfName &rType, const PdfName &rKey) |
const PdfObject * | GetInheritedKey (const PdfName &rName) const |
virtual void | SetICCProfile (const char *pszCSTag, PdfInputStream *pStream, pdf_int64 nColorComponents, EPdfColorSpace eAlternateColorSpace=ePdfColorSpace_DeviceRGB) |
![]() | |
PdfObject * | GetObject () |
const PdfObject * | GetObject () const |
![]() | |
virtual | ~PdfCanvas () |
void | AddColorResource (const PdfColor &rColor) |
void | AddResource (const PdfName &rIdentifier, const PdfReference &rRef, const PdfName &rName) |
Static Public Member Functions | |
static PdfRect | CreateStandardPageSize (const EPdfPageSize ePageSize, bool bLandscape=false) |
![]() | |
static const PdfArray | GetProcSet () |
Additional Inherited Members | |
![]() | |
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 |
PdfObject * | CreateObject (const char *pszType=NULL) |
PdfObject * | GetNonConstObject () const |
PdfPage is one page in the pdf document. It is possible to draw on a page using a PdfPainter object. Every document needs at least one page.
PoDoFo::PdfPage::PdfPage | ( | const PdfRect & | rSize, |
PdfDocument * | pParent | ||
) |
PoDoFo::PdfPage::PdfPage | ( | const PdfRect & | rSize, |
PdfVecObjects * | pParent | ||
) |
PdfAnnotation * PoDoFo::PdfPage::CreateAnnotation | ( | EPdfAnnotation | eType, |
const PdfRect & | rRect | ||
) |
Create a new annotation to this page.
eType | the type of the annotation |
rRect | rectangle of the annotation on the page |
|
static |
void PoDoFo::PdfPage::DeleteAnnotation | ( | const PdfReference & | ref | ) |
Delete the annotation object with reference ref from this page.
ref | the reference of an annotation object of this page. |
void PoDoFo::PdfPage::DeleteAnnotation | ( | int | index | ) |
Delete the annotation with index index from this page.
index | the index of the annotation to delete |
PdfAnnotation * PoDoFo::PdfPage::GetAnnotation | ( | int | index | ) |
Get the annotation with index index of the current page.
index | the index of the annotation to retrieve |
|
inlinevirtual |
Get the current ArtBox in PDF units.
|
inlinevirtual |
Get the current BleedBox (extra area for printing purposes) in PDF units.
|
virtual |
Get access to the contents object of this page. If you want to draw onto the page, you have to add drawing commands to the stream of the Contents object.
Implements PoDoFo::PdfCanvas.
|
virtual |
Get access an object that you can use to ADD drawing to. If you want to draw onto the page, you have to add drawing commands to the stream of the Contents object.
Implements PoDoFo::PdfCanvas.
|
inlinevirtual |
Get the current CropBox (visible page size) in PDF units.
PdfField PoDoFo::PdfPage::GetField | ( | int | index | ) |
Get a PdfField with a certain index.
index | of the PdfField (must be smaller than GetNumFields() ) |
const PdfField PoDoFo::PdfPage::GetField | ( | int | index | ) | const |
Get a PdfField with a certain index.
index | of the PdfField (must be smaller than GetNumFields() ) |
Get an element from the pages resources dictionary, using a type (category) and a key.
rType | the type of resource to fetch (e.g. /Font, or /XObject) |
rKey | the key of the resource |
Method for getting a value that can be inherited Possible names that can be inherited according to the PDF specification are: Resources, MediaBox, CropBox and Rotate
|
inlinevirtual |
Get the current MediaBox (physical page size) in PDF units.
|
virtual |
Get the number of annotations associated with this page \ returns int number of annotations
int PoDoFo::PdfPage::GetNumFields | ( | ) | const |
unsigned int PoDoFo::PdfPage::GetPageNumber | ( | ) | const |
Page number inside of the document. The first page has the number 1, the last page has the number PdfPagesTree:GetTotalNumberOfPages()
|
inlinevirtual |
Get the current page size in PDF Units
Implements PoDoFo::PdfCanvas.
|
inlinevirtual |
Get access to the resources object of this page. This is most likely an internal object.
Implements PoDoFo::PdfCanvas.
|
virtual |
Get the current page rotation (if any).
|
inlinevirtual |
Get the current TrimBox (cut area) in PDF units.
|
virtual |
Set an ICC profile for this page
pszCSTag | a ColorSpace tag |
pStream | an input stream from which the ICC profiles data can be read |
nColorComponents | the number of colorcomponents of the ICC profile (expected is 1, 3 or 4 components) |
eAlternateColorSpace | an alternate colorspace to use if the ICC profile cannot be used |
bool PoDoFo::PdfPage::SetPageHeight | ( | int | newHeight | ) |
Set the current page height in PDF Units
bool PoDoFo::PdfPage::SetPageWidth | ( | int | newWidth | ) |
Set the current page width in PDF Units
|
virtual |
Set the current page rotation.
iRotation | Rotation to set to the page. Valid value are 0, 90, 180, 270. |