PoDoFo  0.9.1
Public Member Functions
PoDoFo::PdfPushButton Class Reference

#include <PdfField.h>

Inherits PoDoFo::PdfButton.

List of all members.

Public Member Functions

 PdfPushButton (PdfAnnotation *pWidget, PdfAcroForm *pParent)
 PdfPushButton (PdfPage *pPage, const PdfRect &rRect, PdfAcroForm *pParent)
 PdfPushButton (PdfPage *pPage, const PdfRect &rRect, PdfDocument *pDoc)
 PdfPushButton (PdfPage *pPage, const PdfRect &rRect, PdfStreamedDocument *pDoc)
 PdfPushButton (const PdfField &rhs)
void SetRolloverCaption (const PdfString &rsText)
const PdfString GetRolloverCaption () const
void SetAlternateCaption (const PdfString &rsText)
const PdfString GetAlternateCaption () const
- Public Member Functions inherited from PoDoFo::PdfButton
 PdfButton (const PdfField &rhs)
bool IsPushButton () const
bool IsCheckBox () const
bool IsRadioButton () const
void SetCaption (const PdfString &rsText)
const PdfString GetCaption () const
- Public Member Functions inherited from PoDoFo::PdfField
 PdfField (PdfObject *pObject, PdfAnnotation *pWidget)
 PdfField (const PdfField &rhs)
PdfPageGetPage () const
void SetHighlightingMode (EPdfHighlightingMode eMode)
EPdfHighlightingMode GetHighlightingMode () const
void SetBorderColorTransparent ()
void SetBorderColor (double dGray)
void SetBorderColor (double dRed, double dGreen, double dBlue)
void SetBorderColor (double dCyan, double dMagenta, double dYellow, double dBlack)
void SetBackgroundColorTransparent ()
void SetBackgroundColor (double dGray)
void SetBackgroundColor (double dRed, double dGreen, double dBlue)
void SetBackgroundColor (double dCyan, double dMagenta, double dYellow, double dBlack)
void SetFieldName (const PdfString &rsName)
PdfString GetFieldName () const
void SetAlternateName (const PdfString &rsName)
PdfString GetAlternateName () const
void SetMappingName (const PdfString &rsName)
PdfString GetMappingName () const
void SetReadOnly (bool bReadOnly)
bool IsReadOnly () const
void SetRequired (bool bRequired)
bool IsRequired () const
void SetExport (bool bExport)
bool IsExport () const
EPdfField GetType () const

Additional Inherited Members

- Protected Member Functions inherited from PoDoFo::PdfButton
 PdfButton (EPdfField eField, PdfAnnotation *pWidget, PdfAcroForm *pParent)
 PdfButton (EPdfField eField, PdfPage *pPage, const PdfRect &rRect, PdfAcroForm *pParent)
 PdfButton (EPdfField eField, PdfPage *pPage, const PdfRect &rRect, PdfDocument *pDoc)
 PdfButton (EPdfField eField, PdfPage *pPage, const PdfRect &rRect, PdfStreamedDocument *pDoc)
- Protected Member Functions inherited from PoDoFo::PdfField
 PdfField (EPdfField eField, PdfAnnotation *pWidget, PdfAcroForm *pParent)
void SetFieldFlag (long lValue, bool bSet)
bool GetFieldFlag (long lValue, bool bDefault) const
PdfObjectGetAppearanceCharacteristics (bool bCreate) const

Detailed Description

A push button is a button which has no state and value but can toggle actions.


Constructor & Destructor Documentation

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

Create a new PdfPushButton

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

Create a new PdfPushButton

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

Create a new PdfPushButton

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

Create a new PdfPushButton

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

Create a PdfPushButton from a PdfField

Parameters:
rhsa PdfField that is a push button button

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


Member Function Documentation

const PdfString PoDoFo::PdfPushButton::GetAlternateCaption ( ) const
Returns:
the rollover caption of this button
const PdfString PoDoFo::PdfPushButton::GetRolloverCaption ( ) const
Returns:
the rollover caption of this button
void PoDoFo::PdfPushButton::SetAlternateCaption ( const PdfString rsText)

Set the alternate caption of this button which is displayed when the button is pressed.

Parameters:
rsTextthe caption
void PoDoFo::PdfPushButton::SetRolloverCaption ( const PdfString rsText)

Set the rollover caption of this button which is displayed when the cursor enters the field without the mouse button being pressed

Parameters:
rsTextthe caption