PdfTk::PtlFieldText クラス

#include <PtlFieldText.h>

PdfTk::PtlFieldText の継承関係図

PdfTk::PtlFieldText 連携図

公開メンバ関数
	PtlFieldText ()
	コンストラクタ
	PtlFieldText (const PtlFieldText &obj)
	コピーコンストラクタ alias copy
	~PtlFieldText ()
	デストラクタ
PtlFieldText &	operator= (const PtlFieldText &obj)
	コピーオペレータ alias copy
const PtlParamString &	getValue ()
	フィールドに設定されている文字を取得。
void	setFont (const PtlParamFont &font)
	フォントの設定。
void	setValue (const PtlParamString &value)
	フィールドに値を設定。
void	setDefaultValue (const PtlParamString &value)
	フィールドにデフォルト値を設定。
bool	isMultiline () const
	複数行の設定が可能かを取得。
void	setMultiline (bool multi)
	複数行の設定が可能かを設定。
基底クラス PdfTk::PtlField に属する継承公開メンバ関数
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)
	ウィジット注釈のフィールドへの紐づけ。

その他の継承メンバ
基底クラス 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 }
基底クラス PdfTk::PtlField に属する継承限定公開変数類
int	m_dataField

詳解

PDFのテキストフィールドを表現したクラスです。

PtlFieldText.h の 19 行目に定義があります。

構築子と解体子

PtlFieldText() [1/2]

PdfTk::PtlFieldText::PtlFieldText

(

)

コンストラクタ

例外

PtlException

PtlFieldText() [2/2]

PdfTk::PtlFieldText::PtlFieldText

(

const PtlFieldText &

obj

)

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

引数

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

例外

PtlException

関数詳解

getValue()

const PtlParamString & PdfTk::PtlFieldText::getValue

(

)

フィールドに設定されている文字を取得。

フィールドに設定されていなくてデフォルト値が設定されている場合は、デフォルト値が取得されます。

戻り値

文字。

例外

PtlException

isMultiline()

bool PdfTk::PtlFieldText::isMultiline

(

)

const

複数行の設定が可能かを取得。

戻り値

true: 設定可能、false: 設定不可。

例外

PtlException

operator=()

PtlFieldText & PdfTk::PtlFieldText::operator=

(

const PtlFieldText &

obj

)

コピーオペレータ alias copy

引数

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

例外

PtlException

setDefaultValue()

void PdfTk::PtlFieldText::setDefaultValue

(

const PtlParamString &

value

)

フィールドにデフォルト値を設定。

デフォルト値とはユーザーがフィールドに入力しなかった場合の値です。

引数

value

設定する値

例外

PtlException

setFont()

void PdfTk::PtlFieldText::setFont

(

const PtlParamFont &

font

)

フォントの設定。

引数

font

フォント。

例外

PtlException

setMultiline()

void PdfTk::PtlFieldText::setMultiline

(

bool

multi

)

複数行の設定が可能かを設定。

設定しない場合はデフォルト値としてfalseが使用されます。

引数

multi

trueなら設定可能

例外

PtlException

setValue()

void PdfTk::PtlFieldText::setValue

(

const PtlParamString &

value

)

フィールドに値を設定。

引数

value

設定する値

例外

PtlException