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

#include <PdfField.h>

Inherits PoDoFo::PdfButton.

Public Member Functions

 PdfCheckBox (PdfAnnotation *pWidget, PdfAcroForm *pParent)
 
 PdfCheckBox (PdfPage *pPage, const PdfRect &rRect, PdfAcroForm *pParent)
 
 PdfCheckBox (PdfPage *pPage, const PdfRect &rRect, PdfDocument *pDoc)
 
 PdfCheckBox (PdfPage *pPage, const PdfRect &rRect, PdfStreamedDocument *pDoc)
 
 PdfCheckBox (const PdfField &rhs)
 
void SetAppearanceChecked (const PdfXObject &rXObject)
 
void SetAppearanceUnchecked (const PdfXObject &rXObject)
 
void SetChecked (bool bChecked)
 
bool IsChecked () const
 

Detailed Description

A checkbox can be checked or unchecked by the user

Constructor & Destructor Documentation

PoDoFo::PdfCheckBox::PdfCheckBox ( PdfAnnotation pWidget,
PdfAcroForm *  pParent 
)

Create a new PdfCheckBox

PoDoFo::PdfCheckBox::PdfCheckBox ( PdfPage pPage,
const PdfRect rRect,
PdfAcroForm *  pParent 
)

Create a new PdfCheckBox

PoDoFo::PdfCheckBox::PdfCheckBox ( PdfPage pPage,
const PdfRect rRect,
PdfDocument pDoc 
)

Create a new PdfCheckBox

PoDoFo::PdfCheckBox::PdfCheckBox ( PdfPage pPage,
const PdfRect rRect,
PdfStreamedDocument pDoc 
)

Create a new PdfCheckBox

PoDoFo::PdfCheckBox::PdfCheckBox ( const PdfField &  rhs)

Create a PdfCheckBox from a PdfField

Parameters
rhsa PdfField that is a check box

Raises an error if PdfField::GetType() != ePdfField_CheckBox

Member Function Documentation

bool PoDoFo::PdfCheckBox::IsChecked ( ) const
Returns
true if the checkbox is checked
void PoDoFo::PdfCheckBox::SetAppearanceChecked ( const PdfXObject rXObject)

Set the appearance stream which is displayed when the checkbox is checked.

Parameters
rXObjectan xobject which contains the drawing commands for a checked checkbox
void PoDoFo::PdfCheckBox::SetAppearanceUnchecked ( const PdfXObject rXObject)

Set the appearance stream which is displayed when the checkbox is unchecked.

Parameters
rXObjectan xobject which contains the drawing commands for an unchecked checkbox
void PoDoFo::PdfCheckBox::SetChecked ( bool  bChecked)

Sets the state of this checkbox

Parameters
bCheckedif true the checkbox will be checked