PdfTk::PtlCustomProperties クラス

#include <PtlCustomProperties.h>

公開メンバ関数
int	getHandle () const
	PtlCustomProperties ()
	コンストラクタ
	PtlCustomProperties (const PtlCustomProperties &obj)
	コピーコンストラクタ alias copy
	~PtlCustomProperties ()
	デストラクタ
PtlCustomProperties &	operator= (const PtlCustomProperties &obj)
	コピーオペレータ alias copy
bool	isEmpty () const
	空かどうかを取得。
int	getCount () const
	カスタムプロパティ数を取得。
PtlCustomProperty	get (int index)
	カスタムプロパティを取得。
void	append (const PtlCustomProperty &custProp)
	カスタムプロパティを追加。
void	remove (int index)
	カスタムプロパティを削除。
void	removeAll ()
	カスタムプロパティを全て削除。

詳解

カスタムプロパティのコンテナを表現するクラスです。

PtlCustomProperties.h の 17 行目に定義があります。

構築子と解体子

PtlCustomProperties() [1/2]

PdfTk::PtlCustomProperties::PtlCustomProperties

(

)

コンストラクタ

例外

PtlException

PtlCustomProperties() [2/2]

PdfTk::PtlCustomProperties::PtlCustomProperties

(

const PtlCustomProperties &

obj

)

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

引数

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

例外

PtlException

関数詳解

append()

void PdfTk::PtlCustomProperties::append

(

const PtlCustomProperty &

custProp

)

カスタムプロパティを追加。

最後に、カスタムプロパティを追加します。

引数

custProp

カスタムプロパティ

例外

PtlException

get()

PtlCustomProperty PdfTk::PtlCustomProperties::get

(

int

index

)

カスタムプロパティを取得。

指定した番号のカスタムプロパティを取得します。

引数

index

Index番号。0が先頭。 indexが負やカスタムプロパティ数以上の場合は、例外が発生します。

戻り値

PtlCustomProperty。

例外

PtlException

getCount()

int PdfTk::PtlCustomProperties::getCount

(

)

const

カスタムプロパティ数を取得。

戻り値

カスタムプロパティ数。

例外

PtlException

isEmpty()

bool PdfTk::PtlCustomProperties::isEmpty

(

)

const

空かどうかを取得。

戻り値

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

例外

PtlException

operator=()

PtlCustomProperties & PdfTk::PtlCustomProperties::operator=

(

const PtlCustomProperties &

obj

)

コピーオペレータ alias copy

引数

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

remove()

void PdfTk::PtlCustomProperties::remove

(

int

index

)

カスタムプロパティを削除。

指定した番号のカスタムプロパティを削除します。

引数

index

削除するIndex番号。0が先頭。 indexが負やカスタムプロパティ数以上の場合は、例外が発生します。

例外

PtlException

removeAll()

void PdfTk::PtlCustomProperties::removeAll

(

)

カスタムプロパティを全て削除。

例外

PtlException