Antenna House PDF Tool API (C++) 8.0
PdfTk::PtlFieldOptItems クラス

#include <PtlFieldOptItems.h>

公開メンバ関数

int getHandle () const
 PtlFieldOptItems ()
 コンストラクタ
 PtlFieldOptItems (const PtlFieldOptItems &obj)
 コピーコンストラクタ alias copy
 ~PtlFieldOptItems ()
 デストラクタ
PtlFieldOptItemsoperator= (const PtlFieldOptItems &obj)
 コピーオペレータ alias copy
bool isEmpty () const
 空かどうかを取得。
int getCount () const
 オプションアイテム数を取得。
PtlFieldOptItem get (int index)
 オプションアイテムを取得。
void append (PtlFieldOptItem &optItem)
 オプションアイテムを追加。
void remove (int index)
 オプションアイテムを削除。
void removeAll ()
 全てのオプションアイテムを削除。

詳解

選択オプションのオプションアイテムのコンテナを表現するクラスです。

PtlFieldOptItems.h17 行目に定義があります。

構築子と解体子

◆ PtlFieldOptItems() [1/2]

PdfTk::PtlFieldOptItems::PtlFieldOptItems ( )

コンストラクタ

例外
PtlException

◆ PtlFieldOptItems() [2/2]

PdfTk::PtlFieldOptItems::PtlFieldOptItems ( const PtlFieldOptItems & obj)

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

引数
objコピー元オブジェクト。
例外
PtlException

関数詳解

◆ append()

void PdfTk::PtlFieldOptItems::append ( PtlFieldOptItem & optItem)

オプションアイテムを追加。

選択オプションのオプションアイテムを追加します。

引数
annot注釈

◆ get()

PtlFieldOptItem PdfTk::PtlFieldOptItems::get ( int index)

オプションアイテムを取得。

指定した番号のオプションアイテムを取得します。

引数
indexIndex番号。0が先頭。
indexが負や検索結果数以上の場合は、例外が発生します。
戻り値
PtlFieldOptItem。
例外
PtlException

◆ getCount()

int PdfTk::PtlFieldOptItems::getCount ( ) const

オプションアイテム数を取得。

戻り値
PtlFieldOptItem数。
例外
PtlException

◆ isEmpty()

bool PdfTk::PtlFieldOptItems::isEmpty ( ) const

空かどうかを取得。

戻り値
true: 空、false: 空ではない。
例外
PtlException

◆ operator=()

PtlFieldOptItems & PdfTk::PtlFieldOptItems::operator= ( const PtlFieldOptItems & obj)

コピーオペレータ alias copy

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

◆ remove()

void PdfTk::PtlFieldOptItems::remove ( int index)

オプションアイテムを削除。

指定位置のオプションアイテムを削除します。

引数
index位置。0が先頭。
indexが負や注釈数以上の場合、例外が発生します。
例外
PtlException

◆ removeAll()

void PdfTk::PtlFieldOptItems::removeAll ( )

全てのオプションアイテムを削除。

注釈を取得している状態で当関数を使用しても動作は保障されません。

例外
PtlException