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

#include <NetOutline.h>

Public Types
enum	ITEM_FLAG { ITEM_FLAG::FLAG_NORMAL = 0x00000000, ITEM_FLAG::FLAG_ITALIC = 0x00000001, ITEM_FLAG::FLAG_BOLD = 0x00000002 }
	Outline Item Flagsのビット定義 More...

Public Member Functions
PdfTk::PtlOutline *	getNative ()

	PtlOutline ()
	コンストラクタ More...

	PtlOutline (PtlOutline^ obj)
	コピーコンストラクタ More...

	‾PtlOutline ()
	デストラクタ

	!PtlOutline ()
	ファイナライザ。

PtlOutline	operator= (PtlOutline^ obj)
	コピーオペレータ More...

bool	isRoot ()
	ルートかどうかを取得。 More...

String	getTitle ()
	アウトラインタイトル文字列を取得。 More...

void	setTitle (String^title)
	アウトラインタイトル文字列を設定。 More...

PtlAction	getAction ()
	アクションを取得。 More...

void	setAction (PtlAction^ action)
	アクションを設定。 More...

void	removeAction ()
	アクションの削除。 More...

PtlDest	getDest ()
	宛先を取得。 More...

void	setDest (PtlDest^ dest)
	宛先を設定。 More...

PtlColorDeviceRGB	getColor ()
	アウトラインタイトルの色を取得。 More...

void	setColor (PtlColorDeviceRGB^ color)
	アウトラインタイトルの色を設定。 More...

ITEM_FLAG	getFlags ()
	アウトラインフラグを取得。 More...

void	setFlags (ITEM_FLAG flags)
	アウトラインフラグを設定。 More...

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

void	setOpen (bool open)
	PDF表示時の子アウトラインをオープンするかどうかを設定。 More...

bool	hasParent ()
	親アウトラインを持つかを取得。 More...

PtlOutline	getParent ()
	親アウトラインを取得。 More...

bool	hasChild ()
	子アウトラインを持つかどうかを取得。 More...

PtlOutline	getFirstChild ()
	最初の子アウトラインを取得。 More...

PtlOutline	getLastChild ()
	最後の子アウトラインを取得。 More...

bool	hasPrevSibling ()
	前の兄弟アウトラインを持つかどうかを取得。 More...

PtlOutline	getPrevSibling ()
	前の兄弟アウトラインを取得。 More...

bool	hasNextSibling ()
	次の兄弟アウトラインを持つかどうかを取得。 More...

PtlOutline	getNextSibling ()
	次の兄弟アウトラインを取得。 More...

void	appendLastChild (PtlOutline^ item)
	子アウトラインを追加。 More...

void	appendNextSibling (PtlOutline^ item)
	兄弟アウトラインを追加。 More...

void	removeChildren ()
	子アウトラインを削除。 More...

void	destroy ()
	自分自身及び子アウトラインの削除。 More...

Protected Attributes
PdfTk::PtlOutline *	m_native

Detailed Description

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

Member Enumeration Documentation

◆ ITEM_FLAG

enum PdfTkNet::PtlOutline::ITEM_FLAG

strong

Outline Item Flagsのビット定義

Enumerator
FLAG_NORMAL	ノーマル
FLAG_ITALIC	イタリック
FLAG_BOLD	ボールド

Constructor & Destructor Documentation

◆ PtlOutline() [1/2]

PdfTkNet::PtlOutline::PtlOutline ( )

コンストラクタ

Exceptions

PtlException

◆ PtlOutline() [2/2]

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

コピーコンストラクタ

Parameters

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

Exceptions

PtlException

Member Function Documentation

◆ appendLastChild()

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

子アウトラインを追加。

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

Parameters

item 子アウトライン

◆ appendNextSibling()

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

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

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

Parameters

item 兄弟アウトライン

◆ destroy()

void PdfTkNet::PtlOutline::destroy ( )

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

Exceptions

PtlException

◆ getAction()

PtlAction PdfTkNet::PtlOutline::getAction ( )

アクションを取得。

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

Returns: アクション

Exceptions

PtlException

◆ getColor()

PtlColorDeviceRGB PdfTkNet::PtlOutline::getColor ( )

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

Returns: 色

Exceptions

PtlException

◆ getDest()

PtlDest PdfTkNet::PtlOutline::getDest ( )

宛先を取得。

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

Returns: 宛先

Exceptions

PtlException

◆ getFirstChild()

PtlOutline PdfTkNet::PtlOutline::getFirstChild ( )

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

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

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

Exceptions

PtlException

◆ getFlags()

ITEM_FLAG PdfTkNet::PtlOutline::getFlags ( )

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

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

Returns: フラグ。FLAG_XXXのフラグ。

Exceptions

PtlException

◆ getLastChild()

PtlOutline PdfTkNet::PtlOutline::getLastChild ( )

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

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

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

Exceptions

PtlException

◆ getNextSibling()

PtlOutline PdfTkNet::PtlOutline::getNextSibling ( )

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

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

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

Exceptions

PtlException

◆ getParent()

PtlOutline PdfTkNet::PtlOutline::getParent ( )

親アウトラインを取得。

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

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

Exceptions

PtlException

◆ getPrevSibling()

PtlOutline PdfTkNet::PtlOutline::getPrevSibling ( )

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

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

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

Exceptions

PtlException

◆ getTitle()

String PdfTkNet::PtlOutline::getTitle ( )

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

Returns: アウトラインタイトル

Exceptions

PtlException

◆ hasChild()

bool PdfTkNet::PtlOutline::hasChild ( )

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

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

Exceptions

PtlException

◆ hasNextSibling()

bool PdfTkNet::PtlOutline::hasNextSibling ( )

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

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

Exceptions

PtlException

◆ hasParent()

bool PdfTkNet::PtlOutline::hasParent ( )

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

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

Exceptions

PtlException

◆ hasPrevSibling()

bool PdfTkNet::PtlOutline::hasPrevSibling ( )

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

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

Exceptions

PtlException

◆ isOpen()

bool PdfTkNet::PtlOutline::isOpen ( )

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

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

Exceptions

PtlException

◆ isRoot()

bool PdfTkNet::PtlOutline::isRoot ( )

ルートかどうかを取得。

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

Returns: true: ルート項目である。false: ルート項目でない。

Exceptions

PtlException

◆ operator=()

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

コピーオペレータ

Parameters

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

◆ removeAction()

void PdfTkNet::PtlOutline::removeAction ( )

アクションの削除。

Exceptions

PtlException

◆ removeChildren()

void PdfTkNet::PtlOutline::removeChildren ( )

子アウトラインを削除。

Exceptions

PtlException

◆ setAction()

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

アクションを設定。

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

Parameters

action アクション

Exceptions

PtlException

◆ setColor()

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

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

Parameters

color 色

Exceptions

PtlException

◆ setDest()

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

宛先を設定。

Parameters

dest 宛先

Exceptions

PtlException

◆ setFlags()

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

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

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

Parameters

flags フラグ。FLAG_XXXのフラグ。

Exceptions

PtlException

◆ setOpen()

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

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

Parameters

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

Exceptions

PtlException

◆ setTitle()

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

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

Parameters

title アウトラインタイトル

Exceptions

PtlException

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ ITEM_FLAG

Constructor & Destructor Documentation

◆ PtlOutline() [1/2]

◆ PtlOutline() [2/2]

Member Function Documentation

◆ appendLastChild()

◆ appendNextSibling()

◆ destroy()

◆ getAction()

◆ getColor()

◆ getDest()

◆ getFirstChild()

◆ getFlags()

◆ getLastChild()

◆ getNextSibling()

◆ getParent()

◆ getPrevSibling()

◆ getTitle()

◆ hasChild()

◆ hasNextSibling()

◆ hasParent()

◆ hasPrevSibling()

◆ isOpen()

◆ isRoot()

◆ operator=()

◆ removeAction()

◆ removeChildren()

◆ setAction()

◆ setColor()

◆ setDest()

◆ setFlags()

◆ setOpen()

◆ setTitle()