List of all members.
Detailed Description
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.
Constructor & Destructor Documentation
Create a new PdfPage object.
- Parameters:
-
| rSize | a PdfRect specifying the size of the page (i.e the /MediaBox key) in PDF units |
| pParent | add the page to this parent |
Create a new PdfPage object.
- Parameters:
-
| rSize | a PdfRect specifying the size of the page (i.e the /MediaBox key) in PDF units |
| pParent | add the page to this parent |
PoDoFo::PdfPage::PdfPage |
( |
PdfObject * |
pObject, |
|
|
const std::deque< PdfObject * > & |
listOfParents | |
|
) |
| | |
Create a PdfPage based on an existing PdfObject
- Parameters:
-
| pObject | an existing PdfObject |
| listOfParents | a list of PdfObjects that are parents of this page and can be queried for inherited attributes. The last object in the list is the most direct parent of this page. |
Member Function Documentation
Create a new annotation to this page.
- Parameters:
-
| eType | the type of the annotation |
| rRect | rectangle of the annotation on the page |
- Returns:
- the annotation object which is owned by the PdfPage
PdfRect PoDoFo::PdfPage::CreateStandardPageSize |
( |
const EPdfPageSize |
ePageSize, |
|
|
bool |
bLandscape = false | |
|
) |
| | [static] |
Creates a PdfRect with the page size as values which is needed to create a PdfPage object from an enum which are defined for a few standard page sizes.
- Parameters:
-
| ePageSize | the page size you want |
| bLandscape | create a landscape pagesize instead of portrait (by exchanging width and height) |
- Returns:
- a PdfRect object which can be passed to the PdfPage constructor
void PoDoFo::PdfPage::DeleteAnnotation |
( |
int |
index |
) |
|
Delete the annotation with index index from this page.
- Parameters:
-
| index | the index of the annotation to delete |
- See also:
- GetNumAnnots
void PoDoFo::PdfPage::DeleteAnnotation |
( |
const PdfReference & |
ref |
) |
|
Delete the annotation object with reference ref from this page.
- Parameters:
-
| ref | the reference of an annotation object of this page. |
- See also:
- GetNumAnnots
Get the annotation with index index of the current page.
- Parameters:
-
| index | the index of the annotation to retrieve |
- Returns:
- a annotation object. The annotation object is owned by the PdfPage.
- See also:
- GetNumAnnots
virtual const PdfRect PoDoFo::PdfPage::GetArtBox |
( |
|
) |
const [inline, virtual] |
Get the current ArtBox in PDF units.
- Returns:
- PdfRect the page box
virtual const PdfRect PoDoFo::PdfPage::GetBleedBox |
( |
|
) |
const [inline, virtual] |
Get the current BleedBox (extra area for printing purposes) in PDF units.
- Returns:
- PdfRect the page box
PdfObject * PoDoFo::PdfPage::GetContents |
( |
|
) |
const [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.
- Returns:
- a contents object
Implements PoDoFo::PdfCanvas.
PdfObject * PoDoFo::PdfPage::GetContentsForAppending |
( |
|
) |
const [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.
- Returns:
- a contents object
Implements PoDoFo::PdfCanvas.
virtual const PdfRect PoDoFo::PdfPage::GetCropBox |
( |
|
) |
const [inline, virtual] |
Get the current CropBox (visible page size) in PDF units.
- Returns:
- PdfRect the page box
PdfField PoDoFo::PdfPage::GetField |
( |
int |
index |
) |
|
Get a PdfField with a certain index.
- Parameters:
-
- See also:
- GetNumFields
- Returns:
- a PdfField
const PdfField PoDoFo::PdfPage::GetField |
( |
int |
index |
) |
const |
Get a PdfField with a certain index.
- Parameters:
-
- See also:
- GetNumFields
- Returns:
- a constP dfField
Get an element from the pages resources dictionary, using a type (category) and a key.
- Parameters:
-
| rType | the type of resource to fetch (e.g. /Font, or /XObject) |
| rKey | the key of the resource |
- Returns:
- the object of the resource or NULL if it was not found
virtual const PdfRect PoDoFo::PdfPage::GetMediaBox |
( |
|
) |
const [inline, virtual] |
Get the current MediaBox (physical page size) in PDF units.
- Returns:
- PdfRect the page box
int PoDoFo::PdfPage::GetNumAnnots |
( |
|
) |
const [virtual] |
Get the number of annotations associated with this page \ returns int number of annotations
int PoDoFo::PdfPage::GetNumFields |
( |
|
) |
const |
- Returns:
- the number of PdfFields on this page.
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()
- Returns:
- the number of the page inside of the document
- See also:
- PdfPagesTree:GetTotalNumberOfPages()
const PdfRect PoDoFo::PdfPage::GetPageSize |
( |
|
) |
const [inline, virtual] |
Get the current page size in PDF Units
- Returns:
- a PdfRect containing the page size available for drawing
Implements PoDoFo::PdfCanvas.
PdfObject * PoDoFo::PdfPage::GetResources |
( |
|
) |
const [inline, virtual] |
Get access to the resources object of this page. This is most likely an internal object.
- Returns:
- a resources object
Implements PoDoFo::PdfCanvas.
int PoDoFo::PdfPage::GetRotation |
( |
|
) |
const [virtual] |
Get the current page rotation (if any).
- Returns:
- int 0, 90, 180 or 270
virtual const PdfRect PoDoFo::PdfPage::GetTrimBox |
( |
|
) |
const [inline, virtual] |
Get the current TrimBox (cut area) in PDF units.
- Returns:
- PdfRect the page box
bool PoDoFo::PdfPage::SetPageHeight |
( |
int |
newHeight |
) |
|
Set the current page height in PDF Units
- Returns:
- true if successfull, false otherwise
bool PoDoFo::PdfPage::SetPageWidth |
( |
int |
newWidth |
) |
|
Set the current page width in PDF Units
- Returns:
- true if successfull, false otherwise