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

#include <PdfField.h>

Inherits PoDoFo::PdfButton.

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
 

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