PdfTk::PtlOpenMode クラス

#include <PtlOpenMode.h>

公開型
enum	PAGE_MODE {   PAGE_MODE_USE_NONE = 1 , PAGE_MODE_USE_OUTLINES = 2 , PAGE_MODE_USE_THUMBS = 3 , PAGE_MODE_USE_OC = 5 ,   PAGE_MODE_USE_ATTACHMENTS = 6 }
enum	PAGE_LAYOUT {   PAGE_LAYOUT_SINGLE_PAGE = 1 , PAGE_LAYOUT_ONE_COLUMN = 2 , PAGE_LAYOUT_TWO_COLUMN_LEFT = 3 , PAGE_LAYOUT_TWO_COLUMN_RIGHT = 4 ,   PAGE_LAYOUT_TWO_PAGE_LEFT = 5 , PAGE_LAYOUT_TWO_PAGE_RIGHT = 6 }
enum	WINDOWS_OPTION { WINDOWS_OPTION_NONE = 0x00000000 , WINDOWS_OPTION_FIT_WINDOW = 0x00000001 , WINDOWS_OPTION_CENTER_WINDOW = 0x00000002 , WINDOWS_OPTION_FULL_SCREEN = 0x00000004 }
enum	UI_OPTION { UI_OPTION_NONE = 0x00000000 , UI_OPTION_HIDE_MENUBAR = 0x00000001 , UI_OPTION_HIDE_TOOLBAR = 0x00000002 , UI_OPTION_HIDE_WINDOWUI = 0x00000004 }

公開メンバ関数
int	getHandle () const
	PtlOpenMode ()
	コンストラクタ
	PtlOpenMode (const PtlOpenMode &obj)
	コピーコンストラクタ
	~PtlOpenMode ()
	デストラクタ
PtlOpenMode &	operator= (const PtlOpenMode &obj)
	コピーオペレータ
bool	hasPageMode () const
	ページモードを持っているかを取得。
PAGE_MODE	getPageMode () const
	ページモードを取得。
void	setPageMode (PAGE_MODE pageMode)
	ページモードを設定。
bool	hasPageLayout () const
	ページレイアウトを持っているかを取得。
PAGE_LAYOUT	getPageLayout () const
	ページレイアウトを取得。
void	setPageLayout (PAGE_LAYOUT pageLayout)
	ページレイアウトを設定。
PtlAction &	getOpenAction () const
	オープンアクションを取得。
void	setOpenAction (const PtlAction &action)
	オープンアクションを設定。
PtlDest &	getOpenDest () const
	オープン時の宛先を取得。
void	setOpenDest (const PtlDest &dest)
	オープン時の宛先を設定。
void	removeOpenAction ()
	オープンアクションを削除。
int	getWindowOption () const
	ウィンドウオプションを取得。
void	setWindowOption (int option)
	ウィンドウオプションを設定。
bool	getDisplayDocTitle () const
	ウィンドウのタイトルバーに文書タイトルを表示するかどうかを取得。
void	setDisplayDocTitle (bool docTitle)
	ウィンドウのタイトルバーに文書タイトルを表示するかどうかを設定。
int	getUIOption () const
	ユーザーインターフェイスオプションを取得。
void	setUIOption (int option)
	ユーザーインターフェイスオプションを設定。

詳解

PDFの開き方を表現したクラスです。
PtlOpenModeはPtlDocPropertyから取得して使用します。

PtlOpenMode.h の 21 行目に定義があります。

列挙型メンバ詳解

PAGE_LAYOUT

enum PdfTk::PtlOpenMode::PAGE_LAYOUT

ページレイアウトタイプ
文書を開いたときに使われるページレイアウトです。

列挙値
PAGE_LAYOUT_SINGLE_PAGE	単一ページ
PAGE_LAYOUT_ONE_COLUMN	連続ページ
PAGE_LAYOUT_TWO_COLUMN_LEFT	奇数ページを左側にして連続見開きページ
PAGE_LAYOUT_TWO_COLUMN_RIGHT	奇数ページを右側にして連続見開きページ
PAGE_LAYOUT_TWO_PAGE_LEFT	奇数ページを左側にして見開きページ
PAGE_LAYOUT_TWO_PAGE_RIGHT	奇数ページを右側にして見開きページ

PtlOpenMode.h の 40 行目に定義があります。

PAGE_MODE

enum PdfTk::PtlOpenMode::PAGE_MODE

ページモード
文書を開いたときのページ表示方法です。

列挙値
PAGE_MODE_USE_NONE	ページのみ表示
PAGE_MODE_USE_OUTLINES	アウトラインパネルとページ
PAGE_MODE_USE_THUMBS	サムネイルパネルとページ
PAGE_MODE_USE_OC	レイヤーパネルとページ
PAGE_MODE_USE_ATTACHMENTS	添付ファイルパネルとページ

PtlOpenMode.h の 28 行目に定義があります。

UI_OPTION

enum PdfTk::PtlOpenMode::UI_OPTION

ユーザーインターフェイスオプション

列挙値
UI_OPTION_NONE	なし
UI_OPTION_HIDE_MENUBAR	メニューバーを非表示
UI_OPTION_HIDE_TOOLBAR	ツールバーを非表示
UI_OPTION_HIDE_WINDOWUI	ウィンドウコントロールを非表示

PtlOpenMode.h の 62 行目に定義があります。

WINDOWS_OPTION

enum PdfTk::PtlOpenMode::WINDOWS_OPTION

ウィンドウオプション

列挙値
WINDOWS_OPTION_NONE	なし
WINDOWS_OPTION_FIT_WINDOW	ページにウィンドウサイズを合あわせる
WINDOWS_OPTION_CENTER_WINDOW	ウィンドウを画面中央に配置
WINDOWS_OPTION_FULL_SCREEN	フルスクリーンモードで開く

PtlOpenMode.h の 52 行目に定義があります。

構築子と解体子

PtlOpenMode() [1/2]

PdfTk::PtlOpenMode::PtlOpenMode

(

)

コンストラクタ

例外

PtlException

PtlOpenMode() [2/2]

PdfTk::PtlOpenMode::PtlOpenMode

(

const PtlOpenMode &

obj

)

コピーコンストラクタ

引数

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

例外

PtlException

関数詳解

getDisplayDocTitle()

bool PdfTk::PtlOpenMode::getDisplayDocTitle

(

)

const

ウィンドウのタイトルバーに文書タイトルを表示するかどうかを取得。

戻り値

true: 表示、false: 非表示。

getOpenAction()

PtlAction & PdfTk::PtlOpenMode::getOpenAction

(

)

const

オープンアクションを取得。

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

戻り値

PtlAction。

例外

PtlException

getOpenDest()

PtlDest & PdfTk::PtlOpenMode::getOpenDest

(

)

const

オープン時の宛先を取得。

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

戻り値

宛先

例外

PtlException

getPageLayout()

PAGE_LAYOUT PdfTk::PtlOpenMode::getPageLayout

(

)

const

ページレイアウトを取得。

戻り値

ページレイアウト。PAGE_LAYOUT_XXXのいずれかの値。

例外

PtlException

getPageMode()

PAGE_MODE PdfTk::PtlOpenMode::getPageMode

(

)

const

ページモードを取得。

戻り値

ページモード。

例外

PtlException

getUIOption()

int PdfTk::PtlOpenMode::getUIOption

(

)

const

ユーザーインターフェイスオプションを取得。

ユーザーインターフェイスオプションが論理和で指定されています。

戻り値

ユーザーインターフェイスオプション。UI_OPTION_XXXのユーザーインターフェイスオプション。

例外

PtlException

getWindowOption()

int PdfTk::PtlOpenMode::getWindowOption

(

)

const

ウィンドウオプションを取得。

ウィンドウオプションが論理和で指定されています。

戻り値

ウィンドウオプション。WINDOW_OPTION_XXXのウィンドウオプション。

例外

PtlException

hasPageLayout()

bool PdfTk::PtlOpenMode::hasPageLayout

(

)

const

ページレイアウトを持っているかを取得。

戻り値

true: 持っている、false: 持っていない。

例外

PtlException

hasPageMode()

bool PdfTk::PtlOpenMode::hasPageMode

(

)

const

ページモードを持っているかを取得。

戻り値

true: 持っている、false: 持っていない。

例外

PtlException

operator=()

PtlOpenMode & PdfTk::PtlOpenMode::operator=

(

const PtlOpenMode &

obj

)

コピーオペレータ

引数

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

removeOpenAction()

void PdfTk::PtlOpenMode::removeOpenAction

(

)

オープンアクションを削除。

例外

PtlException

setDisplayDocTitle()

void PdfTk::PtlOpenMode::setDisplayDocTitle

(

bool

docTitle

)

ウィンドウのタイトルバーに文書タイトルを表示するかどうかを設定。

引数

docTitle

true: 表示、false: 非表示。

setOpenAction()

void PdfTk::PtlOpenMode::setOpenAction

(

const PtlAction &

action

)

オープンアクションを設定。

同時にsetOpenDestを使用すると後に設定したほうが反映されます。
AcrobatではPtlActionLaunch(PDFを指定したもの)、PtlActionGoToRを設定しても動作しません。

引数

action

アクション。

例外

PtlException

setOpenDest()

void PdfTk::PtlOpenMode::setOpenDest

(

const PtlDest &

dest

)

オープン時の宛先を設定。

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

引数

dest

宛先

例外

PtlException

setPageLayout()

void PdfTk::PtlOpenMode::setPageLayout

(

PAGE_LAYOUT

pageLayout

)

ページレイアウトを設定。

引数

pageLayout

ページレイアウト。

例外

PtlException

setPageMode()

void PdfTk::PtlOpenMode::setPageMode

(

PAGE_MODE

pageMode

)

ページモードを設定。

同時にsetWindowOptionでWINDOWS_OPTION_FULL_SCREENを指定すると後に設定したほうが反映されます。

引数

pageMode

ページモード。

例外

PtlException

setUIOption()

void PdfTk::PtlOpenMode::setUIOption

(

int

option

)

ユーザーインターフェイスオプションを設定。

ユーザーインターフェイスオプションを論理和で指定します。

引数

option

ユーザーインターフェイスオプション。UI_OPTION_XXXのユーザーインターフェイスオプション。

例外

PtlException

setWindowOption()

void PdfTk::PtlOpenMode::setWindowOption

(

int

option

)

ウィンドウオプションを設定。

ウィンドウオプションを論理和で指定します。
同時にsetPageModeを使用すると後に設定したほうが反映されます。

引数

option

ウィンドウオプション。WINDOW_OPTION_XXXのウィンドウオプション。

例外

PtlException