#include <PtlPages.h>

公開型
enum	INSERT_OPTION { OPTION_NONE = 0x00000000 , OPTION_EXECPT_ANNOTS = 0x00000001 , OPTION_EXCEPT_FORMS = 0x00000002 , OPTION_COPY_OUTLINES = 0x00000004 , OPTION_COPY_ATTACHEDFILES = 0x00000008 }
enum	NUM_PAGES { PAGE_ALL = -1 }
enum	INSERT_POS { INSERT_LAST = -1 }

公開メンバ関数
int	getHandle () const
	PtlPages ()
	コンストラクタ
	PtlPages (const PtlPages &obj)
	コピーコンストラクタ alias copy
	~PtlPages ()
	デストラクタ
PtlPages &	operator= (const PtlPages &obj)
	コピーオペレータ alias copy
bool	isEmpty () const
	空かどうかを取得。
int	getCount () const
	ページ数を取得。
PtlPage	get (int index)
	ページを取得。
void	append (PtlPage &page, int param)
	ページを追加。
void	append (const PtlPDFDocument &doc, int fromNum, int numPages, int param)
	ページを追加。
void	append (const PtlParamImagePage &paramImagePage)
	画像ページを追加。
void	insert (int index, PtlPage &page, int param)
	ページを挿入。
void	insert (int index, const PtlPDFDocument &doc, int fromNum, int numPages, int param)
	ページを挿入。
void	insert (int index, const PtlParamImagePage &paramImagePage)
	画像ページを挿入。
void	move (int index, int fromNum, int numPages)
	ページを移動。
void	remove (int index)
	ページを削除。
void	remove (int index, int numPages)
	複数ページを削除。
void	removeAll ()
	全ページを削除。

詳解

ページのコンテナを表現するクラスです。

ページ番号は0オリジンとなっています。indexが0のものが先頭ページとなります。

PtlPages.h の 22 行目に定義があります。

列挙型メンバ詳解

◆ INSERT_OPTION

enum PdfTk::PtlPages::INSERT_OPTION

ページ挿入オプション

列挙値
OPTION_NONE	オプションはありません。
OPTION_EXECPT_ANNOTS	注釈を除外してページ挿入します。
OPTION_EXCEPT_FORMS	フォームを除外してページ挿入します。
OPTION_COPY_OUTLINES	ページ挿入時にあわせてしおりをコピーします。他PDFのページ挿入時に有効となります。
OPTION_COPY_ATTACHEDFILES	ページ挿入時にあわせて添付ファイルをコピーします。ここで言う添付ファイルは文書に添付されているものを指し、注釈に添付されているものは対象とはしません。他PDFのページ挿入時に有効となります。

PtlPages.h の 28 行目に定義があります。

◆ INSERT_POS

enum PdfTk::PtlPages::INSERT_POS

挿入する位置。

列挙値
INSERT_LAST	最後に挿入

PtlPages.h の 53 行目に定義があります。

◆ NUM_PAGES

enum PdfTk::PtlPages::NUM_PAGES

挿入/削除するページ数。開始ページ以降全ページ対象。

列挙値
PAGE_ALL	全ページ対象

PtlPages.h の 46 行目に定義があります。

構築子と解体子

◆ PtlPages() [1/2]

PdfTk::PtlPages::PtlPages ( )

コンストラクタ

例外

PtlException

◆ PtlPages() [2/2]

PdfTk::PtlPages::PtlPages ( const PtlPages & obj )

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

引数

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

例外

PtlException

関数詳解

◆ append() [1/3]

void PdfTk::PtlPages::append ( const PtlParamImagePage & paramImagePage )

画像ページを追加。

最後に、画像ページを追加します。
画像がTiffの場合、PtlParamImagePageでsetImagePageNumberに-1を設定すると、
Tiffのページ数分ページが追加されます。

引数

paramImagePage 画像ページ挿入パラメータ。

例外

PtlException

◆ append() [2/3]

void PdfTk::PtlPages::append	(	const PtlPDFDocument &	doc,
		int	fromNum,
		int	numPages,
		int	param )

ページを追加。

最後に、ページを追加します。

引数

doc	PDF文書
fromNum	開始ページ(ページ番号は0オリジン)
numPages	追加するページ数 PAGE_ALLの指定も可能です。
param	ページ挿入オプションを論理和で指定

例外

PtlException

◆ append() [3/3]

void PdfTk::PtlPages::append	(	PtlPage &	page,
		int	param )

ページを追加。

最後に、ページを追加します。

引数

page	ページ
param	ページ挿入オプションを論理和で指定

例外

PtlException

◆ get()

PtlPage PdfTk::PtlPages::get ( int index )

ページを取得。

指定位置にあるページを取得します。

引数

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

戻り値: ページ

例外

PtlException

◆ getCount()

int PdfTk::PtlPages::getCount ( ) const

ページ数を取得。

戻り値: ページ数

例外

PtlException

◆ insert() [1/3]

void PdfTk::PtlPages::insert	(	int	index,
		const PtlParamImagePage &	paramImagePage )

画像ページを挿入。

指定位置に、画像ページを挿入します。
指定位置にあったページと後続のページは後ろに移動します。
画像がTiffの場合、PtlParamImagePageでsetImagePageNumberに-1を設定すると、
Tiffのページ数分ページが挿入されます。

引数

index	位置。0が先頭。 indexが負やページ数以上の場合、例外が発生します。
paramImagePage	画像ページ挿入パラメータ。

例外

PtlException

◆ insert() [2/3]

void PdfTk::PtlPages::insert	(	int	index,
		const PtlPDFDocument &	doc,
		int	fromNum,
		int	numPages,
		int	param )

ページを挿入。

指定位置に、指定されたページを挿入します。
指定位置にあったページと後続のページは後ろに移動します。

引数

index	位置。0が先頭ページ。 indexが負やページ数以上の場合、例外が発生します。
doc	PDF文書
fromNum	開始ページ(ページ番号は0オリジン)
numPages	挿入するページ数 PAGE_ALLの指定も可能です。
param	ページ挿入オプションを論理和で指定

例外

PtlException

◆ insert() [3/3]

void PdfTk::PtlPages::insert	(	int	index,
		PtlPage &	page,
		int	param )

ページを挿入。

指定位置に、指定されたページを挿入します。
指定位置にあったページと後続のページは後ろに移動します。

引数

index	位置。0が先頭ページ。 indexが負やページ数以上の場合、例外が発生します。
page	ページ
param	ページ挿入オプションを論理和で指定

例外

PtlException

◆ isEmpty()

bool PdfTk::PtlPages::isEmpty ( ) const

空かどうかを取得。

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

例外

PtlException

◆ move()

void PdfTk::PtlPages::move	(	int	index,
		int	fromNum,
		int	numPages )

ページを移動。

指定位置に、指定されたページを移動します。

引数

index	位置。0が先頭ページ。 INSERT_LASTの指定も可能です。
fromNum	開始ページ(ページ番号は0オリジン)
numPages	移動するページ数 PAGE_ALLの指定も可能です。

例外

PtlException

◆ operator=()

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

コピーオペレータ alias copy

引数

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

◆ remove() [1/2]

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

ページを削除。

指定位置のページを削除し、後続のページを前につめます。
削除して全ページがなくなった場合、そのまま保存すると例外が発生します。

引数

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

例外

PtlException

◆ remove() [2/2]

void PdfTk::PtlPages::remove	(	int	index,
		int	numPages )

複数ページを削除。

指定位置のページから指定ページ数を削除し、後続のページを前につめます。
削除して全ページがなくなった場合、そのまま保存すると例外が発生します。

引数

index	位置。0が先頭ページ。 indexが負やページ数以上の場合、例外が発生します。
numPages	削除するページ数 PAGE_ALLの指定も可能です。

例外

PtlException

◆ removeAll()

void PdfTk::PtlPages::removeAll ( )

全ページを削除。

全ページ削除してそのまま保存すると例外が発生します。
削除後はなんらかの形でページを追加してください。
全ページ削除しても文書情報などは元のままなので元の文書情報を引き継ぎたい場合などに利用できます。

例外

PtlException

公開型

公開メンバ関数

詳解

列挙型メンバ詳解

◆ INSERT_OPTION

◆ INSERT_POS

◆ NUM_PAGES

構築子と解体子

◆ PtlPages() [1/2]

◆ PtlPages() [2/2]

関数詳解

◆ append() [1/3]

◆ append() [2/3]

◆ append() [3/3]

◆ get()

◆ getCount()

◆ insert() [1/3]

◆ insert() [2/3]

◆ insert() [3/3]

◆ isEmpty()

◆ move()

◆ operator=()

◆ remove() [1/2]

◆ remove() [2/2]

◆ removeAll()