PdfTk::PtlAnnots クラス

#include <PtlAnnots.h>

公開メンバ関数
int	getHandle () const
	PtlAnnots ()
	コンストラクタ
	PtlAnnots (const PtlAnnots &obj)
	コピーコンストラクタ alias copy
	~PtlAnnots ()
	デストラクタ
PtlAnnots &	operator= (const PtlAnnots &obj)
	コピーオペレータ alias copy
bool	isEmpty ()
	空かどうかを取得。
int	getCount ()
	注釈数を取得。
PtlAnnot &	get (int index)
	注釈を取得。
void	append (PtlAnnot &annot)
	注釈を追加。
void	remove (int index)
	注釈を削除。
void	removeAll ()
	全ての注釈を削除。

詳解

注釈のコンテナを表現するクラスです。

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

構築子と解体子

PtlAnnots() [1/2]

PdfTk::PtlAnnots::PtlAnnots

(

)

コンストラクタ

例外

PtlException

PtlAnnots() [2/2]

PdfTk::PtlAnnots::PtlAnnots

(

const PtlAnnots &

obj

)

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

引数

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

例外

PtlException

関数詳解

append()

void PdfTk::PtlAnnots::append

(

PtlAnnot &

annot

)

注釈を追加。

注釈を追加します。

引数

annot

注釈

get()

PtlAnnot & PdfTk::PtlAnnots::get

(

int

index

)

注釈を取得。

指定位置にある注釈を取得します。
ポップアップ注釈はマークアップ注釈(PtlAnnotMarkup)のサブクラスから取得します。

引数

index

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

戻り値

注釈

例外

PtlException

getCount()

int PdfTk::PtlAnnots::getCount

(

)

注釈数を取得。

戻り値

注釈数

例外

PtlException

isEmpty()

bool PdfTk::PtlAnnots::isEmpty

(

)

空かどうかを取得。

戻り値

true: 空、false: 空ではない。

例外

PtlException

operator=()

PtlAnnots & PdfTk::PtlAnnots::operator=

(

const PtlAnnots &

obj

)

コピーオペレータ alias copy

引数

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

remove()

void PdfTk::PtlAnnots::remove

(

int

index

)

注釈を削除。

指定位置の注釈を削除し、後続の注釈を前につめます。
注釈を取得している状態で当関数を使用しても動作は保障されません。

引数

index

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

例外

PtlException

removeAll()

void PdfTk::PtlAnnots::removeAll

(

)

全ての注釈を削除。

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

例外

PtlException