#include <PtlOutline.h>
PDFのアウトライン(しおり)を表現したクラスです。
PtlOutline.h の 21 行目に定義があります。
◆ ITEM_FLAG
Outline Item Flagsのビット定義
列挙値 |
---|
FLAG_NORMAL | ノーマル
|
FLAG_ITALIC | イタリック
|
FLAG_BOLD | ボールド
|
PtlOutline.h の 27 行目に定義があります。
◆ PtlOutline() [1/2]
PdfTk::PtlOutline::PtlOutline |
( |
| ) |
|
◆ PtlOutline() [2/2]
PdfTk::PtlOutline::PtlOutline |
( |
const PtlOutline & | obj | ) |
|
◆ appendLastChild()
void PdfTk::PtlOutline::appendLastChild |
( |
const PtlOutline & | item | ) |
|
子アウトラインを追加。
最後に、子アウトラインを追加します。
自分自身がルート項目,若しくはルート項目の子孫でない場合、例外が発生します。
- 引数
-
◆ appendNextSibling()
void PdfTk::PtlOutline::appendNextSibling |
( |
const PtlOutline & | item | ) |
|
兄弟アウトラインを追加。
最後に、兄弟アウトラインを追加します。
自分自身がルート項目,若しくはルート項目の子孫でない場合、例外が発生します。
- 引数
-
◆ destroy()
void PdfTk::PtlOutline::destroy |
( |
| ) |
|
◆ getAction()
PtlAction & PdfTk::PtlOutline::getAction |
( |
| ) |
const |
アクションを取得。
PtlActionを取得後、タイプを確認の上使用して下さい。
- 戻り値
- アクション
- 例外
-
◆ getColor()
◆ getDest()
PtlDest & PdfTk::PtlOutline::getDest |
( |
| ) |
const |
宛先を取得。
PtlDestを取得後、タイプを確認の上使用して下さい。
GoToRの宛先は取得されません。GoToRの宛先はActionGoToRから取得して下さい。
- 戻り値
- 宛先
- 例外
-
◆ getFirstChild()
PtlOutline PdfTk::PtlOutline::getFirstChild |
( |
| ) |
const |
最初の子アウトラインを取得。
存在しない場合、PtlErrorCode::NO_OBJECTが例外として発生します。
この関数の使用前にhasChild関数で子アウトラインの有無を確認してください。
- 戻り値
- 子アウトライン。ない場合は例外をスローします。
- 例外
-
◆ getFlags()
int PdfTk::PtlOutline::getFlags |
( |
| ) |
const |
アウトラインフラグを取得。
フラグの定義が論理和で指定されています。
- 戻り値
- フラグ。FLAG_XXXのフラグ。
- 例外
-
◆ getLastChild()
PtlOutline PdfTk::PtlOutline::getLastChild |
( |
| ) |
const |
最後の子アウトラインを取得。
存在しない場合、PtlErrorCode::NO_OBJECTが例外として発生します。
この関数の使用前にhasChild関数で子アウトラインの有無を確認してください。
- 戻り値
- 子アウトライン。ない場合は例外をスローします。
- 例外
-
◆ getNextSibling()
PtlOutline PdfTk::PtlOutline::getNextSibling |
( |
| ) |
const |
次の兄弟アウトラインを取得。
存在しない場合、PtlErrorCode::NO_OBJECTが例外として発生します。
この関数の使用前にhasNextSibling関数で次の兄弟アウトラインの有無を確認してください。
- 戻り値
- 兄弟のアウトライン。ない場合は例外をスローします。
- 例外
-
◆ getParent()
親アウトラインを取得。
存在しない場合、PtlErrorCode::NO_OBJECTが例外として発生します。
この関数の使用前にhasParent関数で親アウトラインの有無を確認してください。
- 戻り値
- 親アウトライン。ない場合は例外をスローします。
- 例外
-
◆ getPrevSibling()
PtlOutline PdfTk::PtlOutline::getPrevSibling |
( |
| ) |
const |
前の兄弟アウトラインを取得。
存在しない場合、PtlErrorCode::NO_OBJECTが例外として発生します。
この関数の使用前にhasPrevSibling関数で前の兄弟アウトラインの有無を確認してください。
- 戻り値
- 兄弟のアウトライン。ない場合は例外をスローします。
- 例外
-
◆ getTitle()
アウトラインタイトル文字列を取得。
- 戻り値
- アウトラインタイトル
- 例外
-
◆ hasChild()
bool PdfTk::PtlOutline::hasChild |
( |
| ) |
const |
子アウトラインを持つかどうかを取得。
- 戻り値
- true: 子アウトラインを持つ。false: 子アウトラインを持たない。
- 例外
-
◆ hasNextSibling()
bool PdfTk::PtlOutline::hasNextSibling |
( |
| ) |
const |
次の兄弟アウトラインを持つかどうかを取得。
- 戻り値
- true: 次の兄弟アウトラインを持つ。false: 次の兄弟アウトラインを持たない。
- 例外
-
◆ hasParent()
bool PdfTk::PtlOutline::hasParent |
( |
| ) |
const |
親アウトラインを持つかを取得。
- 戻り値
- true: 親アウトラインを持つ。false: 親アウトラインを持たない。
- 例外
-
◆ hasPrevSibling()
bool PdfTk::PtlOutline::hasPrevSibling |
( |
| ) |
const |
前の兄弟アウトラインを持つかどうかを取得。
- 戻り値
- true: 前の兄弟アウトラインを持つ。false: 前の兄弟アウトラインを持たない。
- 例外
-
◆ isOpen()
bool PdfTk::PtlOutline::isOpen |
( |
| ) |
const |
PDF表示時の子アウトラインをオープンするかどうかを取得。
- 戻り値
- PDF表示時の子アウトラインをオープンする指定。trueならオープンする。
- 例外
-
◆ isRoot()
bool PdfTk::PtlOutline::isRoot |
( |
| ) |
const |
ルートかどうかを取得。
ルートは仮想のしおりで一番上位にあり、他のしおりをたどっていく基点となります。
ルートは基点なので名前などはありません。
- 戻り値
- true: ルート項目である。false: ルート項目でない。
- 例外
-
◆ operator=()
◆ removeAction()
void PdfTk::PtlOutline::removeAction |
( |
| ) |
|
◆ removeChildren()
void PdfTk::PtlOutline::removeChildren |
( |
| ) |
|
◆ setAction()
void PdfTk::PtlOutline::setAction |
( |
const PtlAction & | action | ) |
|
アクションを設定。
同時にsetDestを使用すると後に設定したほうが反映されます。
- 引数
-
- 例外
-
◆ setColor()
◆ setDest()
void PdfTk::PtlOutline::setDest |
( |
const PtlDest & | dest | ) |
|
◆ setFlags()
void PdfTk::PtlOutline::setFlags |
( |
int | flags | ) |
|
アウトラインフラグを設定。
フラグの定義を論理和で指定します。
- 引数
-
- 例外
-
◆ setOpen()
void PdfTk::PtlOutline::setOpen |
( |
bool | open | ) |
|
PDF表示時の子アウトラインをオープンするかどうかを設定。
- 引数
-
open | PDF表示時の子アウトラインをオープンする指定。trueならオープンする。 |
- 例外
-
◆ setTitle()