PDFTool  5.0
Public Types | Public Member Functions | List of all members
PdfTk::PtlOutline Class Reference

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

#include <PtlOutline.h>

Public Types

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

Public Member Functions

int getHandle () const
 
 PtlOutline ()
 コンストラクタ

Exceptions
PtlException

 
 PtlOutline (const PtlOutline &obj)
 コピーコンストラクタ More...
 
 ‾PtlOutline ()
 デストラクタ
 
PtlOutlineoperator= (const PtlOutline &obj)
 コピーオペレータ More...
 
bool isRoot () const
 ルートかどうかを取得。 More...
 
PtlParamString getTitle () const
 アウトラインタイトル文字列を取得。 More...
 
void setTitle (const PtlParamString &title)
 アウトラインタイトル文字列を設定。 More...
 
PtlActiongetAction () const
 アクションの取得。 More...
 
void setAction (const PtlAction &action)
 アクションの設定。 More...
 
void removeAction ()
 アクションの削除。

Exceptions
PtlException

 
PtlDestgetDest () const
 宛先の取得。 More...
 
void setDest (const PtlDest &dest)
 宛先の設定。 More...
 
PtlColorDeviceRGB getColor () const
 アウトラインタイトルの色を取得。 More...
 
void setColor (const PtlColorDeviceRGB &color)
 アウトラインタイトルの色を設定。 More...
 
int getFlags () const
 アウトラインフラグを取得。 More...
 
void setFlags (int flags)
 アウトラインフラグを設定。 More...
 
bool isOpen () const
 PDF表示時の子アウトラインをオープンするかどうかの取得。 More...
 
void setOpen (bool open)
 PDF表示時の子アウトラインをオープンするかどうかの設定。 More...
 
bool hasParent () const
 親アウトラインを持つかの取得。 More...
 
PtlOutline getParent () const
 親アウトラインの取得。 More...
 
bool hasChild () const
 子アウトラインを持つかどうかの取得。 More...
 
PtlOutline getFirstChild () const
 最初の子アウトラインの取得。 More...
 
PtlOutline getLastChild () const
 最後の子アウトラインの取得。 More...
 
bool hasPrevSibling () const
 前の兄弟アウトラインを持つかどうかの取得。 More...
 
PtlOutline getPrevSibling () const
 前の兄弟アウトラインの取得。 More...
 
bool hasNextSibling () const
 次の兄弟アウトラインを持つかどうかの取得。 More...
 
PtlOutline getNextSibling () const
 次の兄弟アウトラインの取得。 More...
 
void appendLastChild (const PtlOutline &item)
 子アウトラインの追加。 More...
 
void appendNextSibling (const PtlOutline &item)
 兄弟アウトラインの追加。 More...
 
void removeChildren ()
 子アウトラインの削除。

Exceptions
PtlException

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

Exceptions
PtlException

 

Detailed Description

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

Member Enumeration Documentation

Outline Item Flagsのビット定義

Enumerator
FLAG_NORMAL 

ノーマル

FLAG_ITALIC 

イタリック

FLAG_BOLD 

ボールド

Constructor & Destructor Documentation

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

コピーコンストラクタ

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

Member Function Documentation

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

子アウトラインの追加。

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

Parameters
item子アウトライン
void PdfTk::PtlOutline::appendNextSibling ( const PtlOutline item)

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

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

Parameters
item兄弟アウトライン
PtlAction& PdfTk::PtlOutline::getAction ( ) const

アクションの取得。

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

Returns
アクション
Exceptions
PtlException
PtlColorDeviceRGB PdfTk::PtlOutline::getColor ( ) const

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

Returns
Exceptions
PtlException
PtlDest& PdfTk::PtlOutline::getDest ( ) const

宛先の取得。

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

Returns
宛先
Exceptions
PtlException
PtlOutline PdfTk::PtlOutline::getFirstChild ( ) const

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

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

Returns
子アウトライン。ない場合は例外をスローします。
Exceptions
PtlException
int PdfTk::PtlOutline::getFlags ( ) const

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

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

Returns
フラグ。FLAG_XXXのフラグ。
Exceptions
PtlException
PtlOutline PdfTk::PtlOutline::getLastChild ( ) const

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

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

Returns
子アウトライン。ない場合は例外をスローします。
Exceptions
PtlException
PtlOutline PdfTk::PtlOutline::getNextSibling ( ) const

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

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

Returns
兄弟のアウトライン。ない場合は例外をスローします。
Exceptions
PtlException
PtlOutline PdfTk::PtlOutline::getParent ( ) const

親アウトラインの取得。

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

Returns
親アウトライン。ない場合は例外をスローします。
Exceptions
PtlException
PtlOutline PdfTk::PtlOutline::getPrevSibling ( ) const

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

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

Returns
兄弟のアウトライン。ない場合は例外をスローします。
Exceptions
PtlException
PtlParamString PdfTk::PtlOutline::getTitle ( ) const

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

Returns
アウトラインタイトル
Exceptions
PtlException
bool PdfTk::PtlOutline::hasChild ( ) const

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

Returns
true: 子アウトラインを持つ。false: 子アウトラインを持たない。
Exceptions
PtlException
bool PdfTk::PtlOutline::hasNextSibling ( ) const

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

Returns
true: 次の兄弟アウトラインを持つ。false: 次の兄弟アウトラインを持たない。
Exceptions
PtlException
bool PdfTk::PtlOutline::hasParent ( ) const

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

Returns
true: 親アウトラインを持つ。false: 親アウトラインを持たない。
Exceptions
PtlException
bool PdfTk::PtlOutline::hasPrevSibling ( ) const

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

Returns
true: 前の兄弟アウトラインを持つ。false: 前の兄弟アウトラインを持たない。
Exceptions
PtlException
bool PdfTk::PtlOutline::isOpen ( ) const

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

Returns
PDF表示時の子アウトラインをオープンする指定。trueならオープンする。
Exceptions
PtlException
bool PdfTk::PtlOutline::isRoot ( ) const

ルートかどうかを取得。

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

Returns
true: ルート項目である。false: ルート項目でない。
Exceptions
PtlException
PtlOutline& PdfTk::PtlOutline::operator= ( const PtlOutline obj)

コピーオペレータ

Parameters
objコピー元オブジェクト。
void PdfTk::PtlOutline::setAction ( const PtlAction action)

アクションの設定。

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

Parameters
actionアクション
Exceptions
PtlException
void PdfTk::PtlOutline::setColor ( const PtlColorDeviceRGB color)

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

Parameters
color
Exceptions
PtlException
void PdfTk::PtlOutline::setDest ( const PtlDest dest)

宛先の設定。

Parameters
dest宛先
Exceptions
PtlException
void PdfTk::PtlOutline::setFlags ( int  flags)

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

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

Parameters
flagsフラグ。FLAG_XXXのフラグ。
Exceptions
PtlException
void PdfTk::PtlOutline::setOpen ( bool  open)

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

Parameters
openPDF表示時の子アウトラインをオープンする指定。trueならオープンする。
Exceptions
PtlException
void PdfTk::PtlOutline::setTitle ( const PtlParamString title)

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

Parameters
titleアウトラインタイトル
Exceptions
PtlException