PoDoFo  0.9.1
Public Member Functions
PoDoFo::PdfComboBox Class Reference

#include <PdfField.h>

Inheritance diagram for PoDoFo::PdfComboBox:
PoDoFo::PdfListField

List of all members.

Public Member Functions

 PdfComboBox (PdfAnnotation *pWidget, PdfAcroForm *pParent)
 PdfComboBox (PdfPage *pPage, const PdfRect &rRect, PdfAcroForm *pParent)
 PdfComboBox (PdfPage *pPage, const PdfRect &rRect, PdfDocument *pDoc)
 PdfComboBox (PdfPage *pPage, const PdfRect &rRect, PdfStreamedDocument *pDoc)
 PdfComboBox (const PdfField &rhs)
void SetEditable (bool bEdit)
bool IsEditable () const
- Public Member Functions inherited from PoDoFo::PdfListField
 PdfListField (const PdfField &rhs)
void InsertItem (const PdfString &rsValue, const PdfString &rsDisplayName=PdfString::StringNull)
void RemoveItem (int nIndex)
const PdfString GetItem (int nIndex) const
const PdfString GetItemDisplayText (int nIndex) const
size_t GetItemCount () const
void SetSelectedItem (int nIndex)
int GetSelectedItem () const
bool IsComboBox () const
void SetSpellcheckingEnabled (bool bSpellcheck)
bool IsSpellcheckingEnabled () const
void SetSorted (bool bSorted)
bool IsSorted () const
void SetMultiSelect (bool bMulti)
bool IsMultiSelect () 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::PdfListField
 PdfListField (EPdfField eField, PdfAnnotation *pWidget, PdfAcroForm *pParent)
 PdfListField (EPdfField eField, PdfPage *pPage, const PdfRect &rRect, PdfAcroForm *pParent)
 PdfListField (EPdfField eField, PdfPage *pPage, const PdfRect &rRect, PdfDocument *pDoc)
 PdfListField (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 combo box with a drop down list of items.


Constructor & Destructor Documentation

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

Create a new PdfTextField

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

Create a new PdfTextField

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

Create a new PdfTextField

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

Create a new PdfTextField

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

Create a PdfComboBox from a PdfField

Parameters:
rhsa PdfField that is a PdfComboBox

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


Member Function Documentation

bool PoDoFo::PdfComboBox::IsEditable ( ) const
inline
Returns:
true if this is an editable combobox
void PoDoFo::PdfComboBox::SetEditable ( bool  bEdit)
inline

Sets the combobox to be editable

Parameters:
bEditif true the combobox can be edited by the user

By default a combobox is not editable