PdfTkNet::PtlAnnots クラス

#include <NetAnnots.h>

PdfTkNet::PtlAnnots の継承関係図

PdfTkNet::PtlAnnots 連携図

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

限定公開変数類
PdfTk::PtlAnnots *	m_native

詳解

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

構築子と解体子

PtlAnnots() [1/2]

PdfTkNet::PtlAnnots::PtlAnnots

(

)

コンストラクタ

例外

PtlException

PtlAnnots() [2/2]

PdfTkNet::PtlAnnots::PtlAnnots

(

PtlAnnots^

obj

)

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

引数

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

例外

PtlException

~PtlAnnots()

PdfTkNet::PtlAnnots::~PtlAnnots

(

)

デストラクタ

!PtlAnnots()

PdfTkNet::PtlAnnots::!PtlAnnots

(

)

ファイナライザ。

メソッド詳解

append()

void PdfTkNet::PtlAnnots::append

(

PtlAnnot^

annot

)

注釈を追加。

注釈を追加します。

引数

annot

注釈

get()

PtlAnnot PdfTkNet::PtlAnnots::get

(

int

index

)

注釈を取得。

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

引数

index

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

戻り値

注釈

例外

PtlException

getCount()

int PdfTkNet::PtlAnnots::getCount

(

)

注釈数を取得。

戻り値

注釈数

例外

PtlException

getNative()

PdfTk::PtlAnnots * PdfTkNet::PtlAnnots::getNative

(

)

isEmpty()

bool PdfTkNet::PtlAnnots::isEmpty

(

)

空かどうかを取得。

戻り値

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

例外

PtlException

operator=()

PtlAnnots PdfTkNet::PtlAnnots::operator=

(

PtlAnnots^

obj

)

コピーオペレータ alias copy

引数

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

remove()

void PdfTkNet::PtlAnnots::remove

(

int

index

)

注釈を削除。

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

引数

index

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

例外

PtlException

removeAll()

void PdfTkNet::PtlAnnots::removeAll

(

)

全ての注釈を削除。

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

例外

PtlException

メンバ詳解

m_native

PdfTk::PtlAnnots* PdfTkNet::PtlAnnots::m_native

protected