PoDoFo  1.0.0-dev
Public Member Functions | Friends | List of all members
PoDoFo::PdfCheckBox Class Referencefinal

A checkbox can be checked or unchecked by the user. More...

#include <PdfCheckBox.h>

Inherits PoDoFo::PdfToggleButton.

Public Member Functions

void SetAppearanceChecked (const PdfXObject &xobj)
 Set the appearance stream which is displayed when the checkbox is checked. More...
 
void SetAppearanceUnchecked (const PdfXObject &xobj)
 Set the appearance stream which is displayed when the checkbox is unchecked. More...
 
void SetChecked (bool isChecked)
 Sets the state of this checkbox. More...
 
bool IsChecked () const
 
PdfCheckBoxGetParent ()
 
const PdfCheckBoxGetParent () const
 

Friends

class PdfField
 

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
rXObjectan 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
rXObjectan xobject which contains the drawing commands for an unchecked checkbox

◆ SetChecked()

void PdfCheckBox::SetChecked ( bool  isChecked)

Sets the state of this checkbox.

Parameters
isCheckedif true the checkbox will be checked

The documentation for this class was generated from the following files: