PdfTk::PtlField クラス

#include <PtlField.h>

PdfTk::PtlField の継承関係図

公開型
enum	FIELD_TYPE {   TYPE_PUSHBUTTON = 1 , TYPE_CHECKBOX = 2 , TYPE_RADIOGROUP = 3 , TYPE_RADIOBUTTON = 4 ,   TYPE_TEXT = 5 , TYPE_LISTBOX = 6 , TYPE_DROPDOWN = 7 , TYPE_SIGNATURE = 10 ,   TYPE_UNKNOWN = 100 }

公開メンバ関数
int	getHandle () const
	PtlField (FIELD_TYPE type)
	コンストラクタ
	PtlField (const PtlField &obj)
	コピーコンストラクタ alias copy
virtual	~PtlField ()
	デストラクタ
PtlField &	operator= (const PtlField &obj)
	コピーオペレータ alias copy
FIELD_TYPE	getType () const
	フィールドタイプを取得。
const PtlParamString &	getFieldName ()
	フィールド名を取得。
void	setFieldName (const PtlParamString &fieldName)
	フィールド名を設定。
bool	hasWidget () const
	ウィジット注釈を持つかどうかを取得。
PtlAnnotWidget &	getWidget ()
	ウィジット注釈を取得。
void	setWidget (const PtlAnnotWidget &widget)
	ウィジット注釈のフィールドへの紐づけ。

限定公開変数類
int	m_dataField

詳解

フォームのフィールドを表現したクラスです。
すべてのフィールドクラスのベースクラスです。

PtlField.h の 21 行目に定義があります。

列挙型メンバ詳解

FIELD_TYPE

enum PdfTk::PtlField::FIELD_TYPE

フィールドのタイプ

列挙値
TYPE_PUSHBUTTON	プッシュボタン
TYPE_CHECKBOX	チェックボックス
TYPE_RADIOGROUP	ラジオグループ
TYPE_RADIOBUTTON	ラジオボタン
TYPE_TEXT	テキスト
TYPE_LISTBOX	リストボックス
TYPE_DROPDOWN	ドロップダウン
TYPE_SIGNATURE	署名
TYPE_UNKNOWN	未対応フィールド

PtlField.h の 27 行目に定義があります。

構築子と解体子

PtlField() [1/2]

PdfTk::PtlField::PtlField

(

FIELD_TYPE

type

)

コンストラクタ

引数

type

タイプ

例外

PtlException

PtlField() [2/2]

PdfTk::PtlField::PtlField

(

const PtlField &

obj

)

コピーコンストラクタ alias copy

引数

obj	コピー元オブジェクト。

例外

PtlException

関数詳解

getFieldName()

const PtlParamString & PdfTk::PtlField::getFieldName

(

)

フィールド名を取得。

ラジオボタンはフィールド名が存在しないのでラジオグループのフィールド名に連番を振った値で取得される。

戻り値

フィールド名。

例外

PtlException

getType()

FIELD_TYPE PdfTk::PtlField::getType

(

)

const

フィールドタイプを取得。

戻り値

フィールドタイプ

例外

PtlException

getWidget()

PtlAnnotWidget & PdfTk::PtlField::getWidget

(

)

ウィジット注釈を取得。

ウィジット注釈を取得します。 存在しない場合、PtlErrorCode::NO_OBJECTが例外として発生します。
この関数の使用前にhasWidget関数で次の兄弟アウトラインの有無を確認してください。

戻り値

ウィジット注釈

例外

PtlException

hasWidget()

bool PdfTk::PtlField::hasWidget

(

)

const

ウィジット注釈を持つかどうかを取得。

戻り値

true: ウィジット注釈を持つ。false: ウィジット注釈を持たない。

例外

PtlException

operator=()

PtlField & PdfTk::PtlField::operator=

(

const PtlField &

obj

)

コピーオペレータ alias copy

引数

obj	コピー元オブジェクト。

setFieldName()

void PdfTk::PtlField::setFieldName

(

const PtlParamString &

fieldName

)

フィールド名を設定。

引数

fieldName

フィールド名

例外

PtlException

setWidget()

void PdfTk::PtlField::setWidget

(

const PtlAnnotWidget &

widget

)

ウィジット注釈のフィールドへの紐づけ。

引数

widget

ウィジット注釈

例外

PtlException

メンバ詳解

m_dataField

int PdfTk::PtlField::m_dataField

protected

PtlField.h の 40 行目に定義があります。