PoDoFo::PdfCheckBox Class Reference

#include <PdfCheckBox.h>

Public Member Functions
void	SetAppearanceChecked (const PdfXObject &xobj)
void	SetAppearanceUnchecked (const PdfXObject &xobj)
void	SetChecked (bool isChecked)
bool	IsChecked () const

Detailed Description

A checkbox can be checked or unchecked by the user

Member Function Documentation

IsChecked()

bool PdfCheckBox::IsChecked

(

)

const

Returns

true if the checkbox is checked

SetAppearanceChecked()

void PdfCheckBox::SetAppearanceChecked

(

const PdfXObject &

xobj

)

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

SetAppearanceUnchecked()

void PdfCheckBox::SetAppearanceUnchecked

(

const PdfXObject &

xobj

)

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

SetChecked()

void PdfCheckBox::SetChecked

(

bool

isChecked

)

Sets the state of this checkbox

Parameters

isChecked

if true the checkbox will be checked