PoDoFo 0.9.20
PoDoFo::PdfPushButton Class Reference

#include <PdfPushButton.h>

Public Member Functions

void SetRolloverCaption (nullable< const PdfString & > text)
 
nullable< const PdfString & > GetRolloverCaption () const
 
void SetAlternateCaption (nullable< const PdfString & > text)
 
nullable< const PdfString & > GetAlternateCaption () const
 

Detailed Description

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

Member Function Documentation

◆ GetAlternateCaption()

nullable< const PdfString & > PdfPushButton::GetAlternateCaption ( ) const
Returns
the rollover caption of this button

◆ GetRolloverCaption()

nullable< const PdfString & > PdfPushButton::GetRolloverCaption ( ) const
Returns
the rollover caption of this button

◆ SetAlternateCaption()

void PdfPushButton::SetAlternateCaption ( nullable< const PdfString & > text)

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

Parameters
textthe caption

◆ SetRolloverCaption()

void PdfPushButton::SetRolloverCaption ( nullable< const PdfString & > text)

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

Parameters
textthe caption