#include <NetOutline.h>

公開型
enum class	ITEM_FLAG { FLAG_NORMAL = 0x00000000 , FLAG_ITALIC = 0x00000001 , FLAG_BOLD = 0x00000002 }

公開メンバ関数
PdfTk::PtlOutline *	getNative ()
	PtlOutline ()
	コンストラクタ
	PtlOutline (PtlOutline^ obj)
	コピーコンストラクタ
	~PtlOutline ()
	デストラクタ
	!PtlOutline ()
	ファイナライザ。
PtlOutline	operator= (PtlOutline^ obj)
	コピーオペレータ
bool	isRoot ()
	ルートかどうかを取得。
String	getTitle ()
	アウトラインタイトル文字列を取得。
void	setTitle (String^title)
	アウトラインタイトル文字列を設定。
PtlAction	getAction ()
	アクションを取得。
void	setAction (PtlAction^ action)
	アクションを設定。
void	removeAction ()
	アクションの削除。
PtlDest	getDest ()
	宛先を取得。
void	setDest (PtlDest^ dest)
	宛先を設定。
PtlColorDeviceRGB	getColor ()
	アウトラインタイトルの色を取得。
void	setColor (PtlColorDeviceRGB^ color)
	アウトラインタイトルの色を設定。
ITEM_FLAG	getFlags ()
	アウトラインフラグを取得。
void	setFlags (ITEM_FLAG flags)
	アウトラインフラグを設定。
bool	isOpen ()
	PDF表示時の子アウトラインをオープンするかどうかを取得。
void	setOpen (bool open)
	PDF表示時の子アウトラインをオープンするかどうかを設定。
bool	hasParent ()
	親アウトラインを持つかを取得。
PtlOutline	getParent ()
	親アウトラインを取得。
bool	hasChild ()
	子アウトラインを持つかどうかを取得。
PtlOutline	getFirstChild ()
	最初の子アウトラインを取得。
PtlOutline	getLastChild ()
	最後の子アウトラインを取得。
bool	hasPrevSibling ()
	前の兄弟アウトラインを持つかどうかを取得。
PtlOutline	getPrevSibling ()
	前の兄弟アウトラインを取得。
bool	hasNextSibling ()
	次の兄弟アウトラインを持つかどうかを取得。
PtlOutline	getNextSibling ()
	次の兄弟アウトラインを取得。
void	appendLastChild (PtlOutline^ item)
	子アウトラインを追加。
void	appendNextSibling (PtlOutline^ item)
	兄弟アウトラインを追加。
void	removeChildren ()
	子アウトラインを削除。
void	destroy ()
	自分自身及び子アウトラインの削除。

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

詳解

PDFのアウトライン(しおり)を表現したクラスです。

列挙型メンバ詳解

◆ ITEM_FLAG

enum class PdfTkNet::PtlOutline::ITEM_FLAG

strong

Outline Item Flagsのビット定義

列挙値
FLAG_NORMAL	ノーマル
FLAG_ITALIC	イタリック
FLAG_BOLD	ボールド

構築子と解体子

◆ PtlOutline() [1/2]

PdfTkNet::PtlOutline::PtlOutline ( )

コンストラクタ

例外

PtlException

◆ PtlOutline() [2/2]

PdfTkNet::PtlOutline::PtlOutline ( PtlOutline^ obj )

コピーコンストラクタ

引数

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

例外

PtlException

◆ ~PtlOutline()

PdfTkNet::PtlOutline::~PtlOutline ( )

デストラクタ

◆ !PtlOutline()

PdfTkNet::PtlOutline::!PtlOutline ( )

ファイナライザ。

メソッド詳解

◆ appendLastChild()

void PdfTkNet::PtlOutline::appendLastChild ( PtlOutline^ item )

子アウトラインを追加。

最後に、子アウトラインを追加します。
自分自身がルート項目，若しくはルート項目の子孫でない場合、例外が発生します。

引数

item 子アウトライン

◆ appendNextSibling()

void PdfTkNet::PtlOutline::appendNextSibling ( PtlOutline^ item )

兄弟アウトラインを追加。

最後に、兄弟アウトラインを追加します。
自分自身がルート項目，若しくはルート項目の子孫でない場合、例外が発生します。

引数

item 兄弟アウトライン

◆ destroy()

void PdfTkNet::PtlOutline::destroy ( )

自分自身及び子アウトラインの削除。

例外

PtlException

◆ getAction()

PtlAction PdfTkNet::PtlOutline::getAction ( )

アクションを取得。

PtlActionを取得後、タイプを確認の上使用して下さい。

戻り値: アクション

例外

PtlException

◆ getColor()

PtlColorDeviceRGB PdfTkNet::PtlOutline::getColor ( )

アウトラインタイトルの色を取得。

戻り値: 色

例外

PtlException

◆ getDest()

PtlDest PdfTkNet::PtlOutline::getDest ( )

宛先を取得。

PtlDestを取得後、タイプを確認の上使用して下さい。
GoToRの宛先は取得されません。GoToRの宛先はActionGoToRから取得して下さい。

戻り値: 宛先

例外

PtlException

◆ getFirstChild()

PtlOutline PdfTkNet::PtlOutline::getFirstChild ( )

最初の子アウトラインを取得。

存在しない場合、PtlErrorCode::NO_OBJECTが例外として発生します。
この関数の使用前にhasChild関数で子アウトラインの有無を確認してください。

戻り値: 子アウトライン。ない場合は例外をスローします。

例外

PtlException

◆ getFlags()

ITEM_FLAG PdfTkNet::PtlOutline::getFlags ( )

アウトラインフラグを取得。

フラグの定義が論理和で指定されています。

戻り値: フラグ。FLAG_XXXのフラグ。

例外

PtlException

◆ getLastChild()

PtlOutline PdfTkNet::PtlOutline::getLastChild ( )

最後の子アウトラインを取得。

存在しない場合、PtlErrorCode::NO_OBJECTが例外として発生します。
この関数の使用前にhasChild関数で子アウトラインの有無を確認してください。

戻り値: 子アウトライン。ない場合は例外をスローします。

例外

PtlException

◆ getNative()

PdfTk::PtlOutline * PdfTkNet::PtlOutline::getNative ( )

◆ getNextSibling()

PtlOutline PdfTkNet::PtlOutline::getNextSibling ( )

次の兄弟アウトラインを取得。

存在しない場合、PtlErrorCode::NO_OBJECTが例外として発生します。
この関数の使用前にhasNextSibling関数で次の兄弟アウトラインの有無を確認してください。

戻り値: 兄弟のアウトライン。ない場合は例外をスローします。

例外

PtlException

◆ getParent()

PtlOutline PdfTkNet::PtlOutline::getParent ( )

親アウトラインを取得。

存在しない場合、PtlErrorCode::NO_OBJECTが例外として発生します。
この関数の使用前にhasParent関数で親アウトラインの有無を確認してください。

戻り値: 親アウトライン。ない場合は例外をスローします。

例外

PtlException

◆ getPrevSibling()

PtlOutline PdfTkNet::PtlOutline::getPrevSibling ( )

前の兄弟アウトラインを取得。

存在しない場合、PtlErrorCode::NO_OBJECTが例外として発生します。
この関数の使用前にhasPrevSibling関数で前の兄弟アウトラインの有無を確認してください。

戻り値: 兄弟のアウトライン。ない場合は例外をスローします。

例外

PtlException

◆ getTitle()

String PdfTkNet::PtlOutline::getTitle ( )

アウトラインタイトル文字列を取得。

戻り値: アウトラインタイトル

例外

PtlException

◆ hasChild()

bool PdfTkNet::PtlOutline::hasChild ( )

子アウトラインを持つかどうかを取得。

戻り値: true: 子アウトラインを持つ。false: 子アウトラインを持たない。

例外

PtlException

◆ hasNextSibling()

bool PdfTkNet::PtlOutline::hasNextSibling ( )

次の兄弟アウトラインを持つかどうかを取得。

戻り値: true: 次の兄弟アウトラインを持つ。false: 次の兄弟アウトラインを持たない。

例外

PtlException

◆ hasParent()

bool PdfTkNet::PtlOutline::hasParent ( )

親アウトラインを持つかを取得。

戻り値: true: 親アウトラインを持つ。false: 親アウトラインを持たない。

例外

PtlException

◆ hasPrevSibling()

bool PdfTkNet::PtlOutline::hasPrevSibling ( )

前の兄弟アウトラインを持つかどうかを取得。

戻り値: true: 前の兄弟アウトラインを持つ。false: 前の兄弟アウトラインを持たない。

例外

PtlException

◆ isOpen()

bool PdfTkNet::PtlOutline::isOpen ( )

PDF表示時の子アウトラインをオープンするかどうかを取得。

戻り値: PDF表示時の子アウトラインをオープンする指定。trueならオープンする。

例外

PtlException

◆ isRoot()

bool PdfTkNet::PtlOutline::isRoot ( )

ルートかどうかを取得。

ルートは仮想のしおりで一番上位にあり、他のしおりをたどっていく基点となります。
ルートは基点なので名前などはありません。

戻り値: true: ルート項目である。false: ルート項目でない。

例外

PtlException

◆ operator=()

PtlOutline PdfTkNet::PtlOutline::operator= ( PtlOutline^ obj )

コピーオペレータ

引数

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

◆ removeAction()

void PdfTkNet::PtlOutline::removeAction ( )

アクションの削除。

例外

PtlException

◆ removeChildren()

void PdfTkNet::PtlOutline::removeChildren ( )

子アウトラインを削除。

例外

PtlException

◆ setAction()

void PdfTkNet::PtlOutline::setAction ( PtlAction^ action )

アクションを設定。

同時にsetDestを使用すると後に設定したほうが反映されます。

引数

action アクション

例外

PtlException

◆ setColor()

void PdfTkNet::PtlOutline::setColor ( PtlColorDeviceRGB^ color )

アウトラインタイトルの色を設定。

引数

color 色

例外

PtlException

◆ setDest()

void PdfTkNet::PtlOutline::setDest ( PtlDest^ dest )

宛先を設定。

引数

dest 宛先

例外

PtlException

◆ setFlags()

void PdfTkNet::PtlOutline::setFlags ( ITEM_FLAG flags )

アウトラインフラグを設定。

フラグの定義を論理和で指定します。

引数

flags フラグ。FLAG_XXXのフラグ。

例外

PtlException

◆ setOpen()

void PdfTkNet::PtlOutline::setOpen ( bool open )

PDF表示時の子アウトラインをオープンするかどうかを設定。

引数

open	PDF表示時の子アウトラインをオープンする指定。trueならオープンする。

例外

PtlException

◆ setTitle()

void PdfTkNet::PtlOutline::setTitle ( String^ title )

アウトラインタイトル文字列を設定。

引数

title アウトラインタイトル

例外

PtlException

メンバ詳解

◆ m_native

PdfTk::PtlOutline* PdfTkNet::PtlOutline::m_native

protected

公開型

公開メンバ関数

限定公開変数類

詳解

列挙型メンバ詳解

◆ ITEM_FLAG

構築子と解体子

◆ PtlOutline() [1/2]

◆ PtlOutline() [2/2]

◆ ~PtlOutline()

◆ !PtlOutline()

メソッド詳解

◆ appendLastChild()

◆ appendNextSibling()

◆ destroy()

◆ getAction()

◆ getColor()

◆ getDest()

◆ getFirstChild()

◆ getFlags()

◆ getLastChild()

◆ getNative()

◆ getNextSibling()

◆ getParent()

◆ getPrevSibling()

◆ getTitle()

◆ hasChild()

◆ hasNextSibling()

◆ hasParent()

◆ hasPrevSibling()

◆ isOpen()

◆ isRoot()

◆ operator=()

◆ removeAction()

◆ removeChildren()

◆ setAction()

◆ setColor()

◆ setDest()

◆ setFlags()

◆ setOpen()

◆ setTitle()

メンバ詳解

◆ m_native