PoDoFo::PdfCheckBox Class Reference
#include <PdfField.h>
Inherits PoDoFo::PdfButton.
List of all members.
Detailed Description
A checkbox can be checked or unchecked by the user
Constructor & Destructor Documentation
PoDoFo::PdfCheckBox::PdfCheckBox |
( |
PdfAnnotation * |
pWidget, |
|
|
PdfAcroForm * |
pParent | |
|
) |
| | |
PoDoFo::PdfCheckBox::PdfCheckBox |
( |
PdfPage * |
pPage, |
|
|
const PdfRect & |
rRect, |
|
|
PdfAcroForm * |
pParent | |
|
) |
| | |
PoDoFo::PdfCheckBox::PdfCheckBox |
( |
const PdfField & |
rhs |
) |
|
Create a PdfCheckBox from a PdfField
- Parameters:
-
| rhs | a 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:
-
| rXObject | an 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:
-
| rXObject | an xobject which contains the drawing commands for an unchecked checkbox |
void PoDoFo::PdfCheckBox::SetChecked |
( |
bool |
bChecked |
) |
|
Sets the state of this checkbox
- Parameters:
-
| bChecked | if true the checkbox will be checked |