Antenna House PDF Tool API (C++) 8.0
PdfTk::PtlOutline クラス

#include <PtlOutline.h>

公開型

enum  ITEM_FLAG { FLAG_NORMAL = 0x00000000 , FLAG_ITALIC = 0x00000001 , FLAG_BOLD = 0x00000002 }

公開メンバ関数

int getHandle () const
 PtlOutline ()
 コンストラクタ
 PtlOutline (const PtlOutline &obj)
 コピーコンストラクタ
 ~PtlOutline ()
 デストラクタ
PtlOutlineoperator= (const PtlOutline &obj)
 コピーオペレータ
bool isRoot () const
 ルートかどうかを取得。
const PtlParamStringgetTitle ()
 アウトラインタイトル文字列を取得。
void setTitle (const PtlParamString &title)
 アウトラインタイトル文字列を設定。
PtlActiongetAction () const
 アクションを取得。
void setAction (const PtlAction &action)
 アクションを設定。
void removeAction ()
 アクションを削除。
PtlDestgetDest () const
 宛先を取得。
void setDest (const PtlDest &dest)
 宛先を設定。
PtlColorDeviceRGB getColor () const
 アウトラインタイトルの色を取得。
void setColor (const PtlColorDeviceRGB &color)
 アウトラインタイトルの色を設定。
int getFlags () const
 アウトラインフラグを取得。
void setFlags (int flags)
 アウトラインフラグを設定。
bool isOpen () const
 PDF表示時の子アウトラインをオープンするかどうかを取得。
void setOpen (bool open)
 PDF表示時の子アウトラインをオープンするかどうかを設定。
bool hasParent () const
 親アウトラインを持つかを取得。
PtlOutline getParent () const
 親アウトラインを取得。
bool hasChild () const
 子アウトラインを持つかどうかを取得。
PtlOutline getFirstChild () const
 最初の子アウトラインを取得。
PtlOutline getLastChild () const
 最後の子アウトラインを取得。
bool hasPrevSibling () const
 前の兄弟アウトラインを持つかどうかを取得。
PtlOutline getPrevSibling () const
 前の兄弟アウトラインを取得。
bool hasNextSibling () const
 次の兄弟アウトラインを持つかどうかを取得。
PtlOutline getNextSibling () const
 次の兄弟アウトラインを取得。
void appendLastChild (const PtlOutline &item)
 子アウトラインを追加。
void appendNextSibling (const PtlOutline &item)
 兄弟アウトラインを追加。
void removeChildren ()
 子アウトラインを削除。
void destroy ()
 自分自身及び子アウトラインを削除。

詳解

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

PtlOutline.h21 行目に定義があります。

列挙型メンバ詳解

◆ ITEM_FLAG

Outline Item Flagsのビット定義

列挙値
FLAG_NORMAL 

ノーマル

FLAG_ITALIC 

イタリック

FLAG_BOLD 

ボールド

PtlOutline.h27 行目に定義があります。

構築子と解体子

◆ PtlOutline() [1/2]

PdfTk::PtlOutline::PtlOutline ( )

コンストラクタ

例外
PtlException

◆ PtlOutline() [2/2]

PdfTk::PtlOutline::PtlOutline ( const PtlOutline & obj)

コピーコンストラクタ

引数
objコピー元オブジェクト。
例外
PtlException

関数詳解

◆ appendLastChild()

void PdfTk::PtlOutline::appendLastChild ( const PtlOutline & item)

子アウトラインを追加。

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

引数
item子アウトライン

◆ appendNextSibling()

void PdfTk::PtlOutline::appendNextSibling ( const PtlOutline & item)

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

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

引数
item兄弟アウトライン

◆ destroy()

void PdfTk::PtlOutline::destroy ( )

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

例外
PtlException

◆ getAction()

PtlAction & PdfTk::PtlOutline::getAction ( ) const

アクションを取得。

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

戻り値
アクション
例外
PtlException

◆ getColor()

PtlColorDeviceRGB PdfTk::PtlOutline::getColor ( ) const

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

戻り値
例外
PtlException

◆ getDest()

PtlDest & PdfTk::PtlOutline::getDest ( ) const

宛先を取得。

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

戻り値
宛先
例外
PtlException

◆ getFirstChild()

PtlOutline PdfTk::PtlOutline::getFirstChild ( ) const

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

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

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

◆ getFlags()

int PdfTk::PtlOutline::getFlags ( ) const

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

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

戻り値
フラグ。FLAG_XXXのフラグ。
例外
PtlException

◆ getLastChild()

PtlOutline PdfTk::PtlOutline::getLastChild ( ) const

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

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

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

◆ getNextSibling()

PtlOutline PdfTk::PtlOutline::getNextSibling ( ) const

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

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

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

◆ getParent()

PtlOutline PdfTk::PtlOutline::getParent ( ) const

親アウトラインを取得。

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

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

◆ getPrevSibling()

PtlOutline PdfTk::PtlOutline::getPrevSibling ( ) const

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

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

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

◆ getTitle()

const PtlParamString & PdfTk::PtlOutline::getTitle ( )

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

戻り値
アウトラインタイトル
例外
PtlException

◆ hasChild()

bool PdfTk::PtlOutline::hasChild ( ) const

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

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

◆ hasNextSibling()

bool PdfTk::PtlOutline::hasNextSibling ( ) const

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

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

◆ hasParent()

bool PdfTk::PtlOutline::hasParent ( ) const

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

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

◆ hasPrevSibling()

bool PdfTk::PtlOutline::hasPrevSibling ( ) const

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

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

◆ isOpen()

bool PdfTk::PtlOutline::isOpen ( ) const

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

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

◆ isRoot()

bool PdfTk::PtlOutline::isRoot ( ) const

ルートかどうかを取得。

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

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

◆ operator=()

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

コピーオペレータ

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

◆ removeAction()

void PdfTk::PtlOutline::removeAction ( )

アクションを削除。

例外
PtlException

◆ removeChildren()

void PdfTk::PtlOutline::removeChildren ( )

子アウトラインを削除。

例外
PtlException

◆ setAction()

void PdfTk::PtlOutline::setAction ( const PtlAction & action)

アクションを設定。

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

引数
actionアクション
例外
PtlException

◆ setColor()

void PdfTk::PtlOutline::setColor ( const PtlColorDeviceRGB & color)

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

引数
color
例外
PtlException

◆ setDest()

void PdfTk::PtlOutline::setDest ( const PtlDest & dest)

宛先を設定。

引数
dest宛先
例外
PtlException

◆ setFlags()

void PdfTk::PtlOutline::setFlags ( int flags)

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

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

引数
flagsフラグ。FLAG_XXXのフラグ。
例外
PtlException

◆ setOpen()

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

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

引数
openPDF表示時の子アウトラインをオープンする指定。trueならオープンする。
例外
PtlException

◆ setTitle()

void PdfTk::PtlOutline::setTitle ( const PtlParamString & title)

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

引数
titleアウトラインタイトル
例外
PtlException