PdfTk::PtlEmbeddedFiles クラス

#include <PtlEmbeddedFiles.h>

公開メンバ関数
int	getHandle () const
	PtlEmbeddedFiles ()
	コンストラクタ
	PtlEmbeddedFiles (const PtlEmbeddedFiles &obj)
	コピーコンストラクタ alias copy
	~PtlEmbeddedFiles ()
	デストラクタ
PtlEmbeddedFiles &	operator= (const PtlEmbeddedFiles &obj)
	コピーオペレータ alias copy
bool	isEmpty () const
	空かどうかを取得。
int	getCount () const
	添付ファイル数を取得。
PtlEmbeddedFile	get (int index)
	添付ファイルを取得。
void	append (const PtlEmbeddedFile &emfile)
	添付ファイルを追加。
void	remove (int index)
	添付ファイルを削除。
void	removeAll ()
	添付ファイルを全て削除。

詳解

添付ファイルのコンテナを表現するクラスです。
※ この添付ファイルコンテナには添付ファイル注釈の添付ファイルは含まれません。

PtlEmbeddedFiles.h の 18 行目に定義があります。

構築子と解体子

PtlEmbeddedFiles() [1/2]

PdfTk::PtlEmbeddedFiles::PtlEmbeddedFiles

(

)

コンストラクタ

例外

PtlException

PtlEmbeddedFiles() [2/2]

PdfTk::PtlEmbeddedFiles::PtlEmbeddedFiles

(

const PtlEmbeddedFiles &

obj

)

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

引数

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

例外

PtlException

関数詳解

append()

void PdfTk::PtlEmbeddedFiles::append

(

const PtlEmbeddedFile &

emfile

)

添付ファイルを追加。

引数

emfile

追加する添付ファイル。

例外

PtlException

get()

PtlEmbeddedFile PdfTk::PtlEmbeddedFiles::get

(

int

index

)

添付ファイルを取得。

指定した番号の添付ファイルを取得します。

引数

index

Index番号。0が先頭。 indexが負や添付ファイル数以上の場合は、例外が発生します。

戻り値

添付ファイル。

例外

PtlException

getCount()

int PdfTk::PtlEmbeddedFiles::getCount

(

)

const

添付ファイル数を取得。

戻り値

添付ファイル数。

例外

PtlException

isEmpty()

bool PdfTk::PtlEmbeddedFiles::isEmpty

(

)

const

空かどうかを取得。

戻り値

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

例外

PtlException

operator=()

PtlEmbeddedFiles & PdfTk::PtlEmbeddedFiles::operator=

(

const PtlEmbeddedFiles &

obj

)

コピーオペレータ alias copy

引数

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

remove()

void PdfTk::PtlEmbeddedFiles::remove

(

int

index

)

添付ファイルを削除。

指定した番号の添付ファイルを削除します。

引数

index

削除するIndex番号。0が先頭。 indexが負や添付ファイル数以上の場合は、例外が発生します。

例外

PtlException

removeAll()

void PdfTk::PtlEmbeddedFiles::removeAll

(

)

添付ファイルを全て削除。

例外

PtlException