PoDoFo::PdfPushButton Class Reference

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

#include <PdfPushButton.h>

Inherits PoDoFo::PdfButton.

Public Member Functions
void	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.
nullable< const PdfString & >	GetRolloverCaption () const
void	SetAlternateCaption (nullable< const PdfString & > text)
	Set the alternate caption of this button which is displayed when the button is pressed.
nullable< const PdfString & >	GetAlternateCaption () const
PdfPushButton *	GetParent ()
const PdfPushButton *	GetParent () const

Friends
class	PdfField

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

text	the 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

text	the caption

---

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

• src/podofo/main/PdfPushButton.h
• src/podofo/main/PdfPushButton.cpp