PDFTool  7.0
Public Types | Public Member Functions | List of all members
PdfTk::PtlOpenMode Class Reference

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

#include <PtlOpenMode.h>

Public Types

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
}
 ページモード
文書を開いたときのページ表示方法です。 More...
 
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
}
 ページレイアウトタイプ
文書を開いたときに使われるページレイアウトです。 More...
 
enum  WINDOWS_OPTION { WINDOWS_OPTION_NONE = 0x00000000, WINDOWS_OPTION_FIT_WINDOW = 0x00000001, WINDOWS_OPTION_CENTER_WINDOW = 0x00000002, WINDOWS_OPTION_FULL_SCREEN = 0x00000004 }
 ウィンドウオプション More...
 
enum  UI_OPTION { UI_OPTION_NONE = 0x00000000, UI_OPTION_HIDE_MENUBAR = 0x00000001, UI_OPTION_HIDE_TOOLBAR = 0x00000002, UI_OPTION_HIDE_WINDOWUI = 0x00000004 }
 ユーザーインターフェイスオプション More...
 

Public Member Functions

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

Detailed Description

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

Member Enumeration Documentation

◆ PAGE_LAYOUT

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

Enumerator
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 

奇数ページを右側にして見開きページ

◆ PAGE_MODE

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

Enumerator
PAGE_MODE_USE_NONE 

ページのみ表示

PAGE_MODE_USE_OUTLINES 

アウトラインパネルとページ

PAGE_MODE_USE_THUMBS 

サムネイルパネルとページ

PAGE_MODE_USE_OC 

レイヤーパネルとページ

PAGE_MODE_USE_ATTACHMENTS 

添付ファイルパネルとページ

◆ UI_OPTION

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

Enumerator
UI_OPTION_NONE 

なし

UI_OPTION_HIDE_MENUBAR 

メニューバーを非表示

UI_OPTION_HIDE_TOOLBAR 

ツールバーを非表示

UI_OPTION_HIDE_WINDOWUI 

ウィンドウコントロールを非表示

◆ WINDOWS_OPTION

ウィンドウオプション

Enumerator
WINDOWS_OPTION_NONE 

なし

WINDOWS_OPTION_FIT_WINDOW 

ページにウィンドウサイズを合あわせる

WINDOWS_OPTION_CENTER_WINDOW 

ウィンドウを画面中央に配置

WINDOWS_OPTION_FULL_SCREEN 

フルスクリーンモードで開く

Constructor & Destructor Documentation

◆ PtlOpenMode() [1/2]

PdfTk::PtlOpenMode::PtlOpenMode ( )

コンストラクタ

Exceptions
PtlException

◆ PtlOpenMode() [2/2]

PdfTk::PtlOpenMode::PtlOpenMode ( const PtlOpenMode obj)

コピーコンストラクタ

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

Member Function Documentation

◆ getDisplayDocTitle()

bool PdfTk::PtlOpenMode::getDisplayDocTitle ( ) const

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

Returns
true: 表示、false: 非表示。

◆ getOpenAction()

PtlAction& PdfTk::PtlOpenMode::getOpenAction ( ) const

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

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

Returns
PtlAction。
Exceptions
PtlException

◆ getOpenDest()

PtlDest& PdfTk::PtlOpenMode::getOpenDest ( ) const

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

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

Returns
宛先
Exceptions
PtlException

◆ getPageLayout()

PAGE_LAYOUT PdfTk::PtlOpenMode::getPageLayout ( ) const

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

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

◆ getPageMode()

PAGE_MODE PdfTk::PtlOpenMode::getPageMode ( ) const

ページモードを取得。

Returns
ページモード。
Exceptions
PtlException

◆ getUIOption()

int PdfTk::PtlOpenMode::getUIOption ( ) const

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

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

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

◆ getWindowOption()

int PdfTk::PtlOpenMode::getWindowOption ( ) const

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

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

Returns
ウィンドウオプション。WINDOW_OPTION_XXXのウィンドウオプション。
Exceptions
PtlException

◆ hasPageLayout()

bool PdfTk::PtlOpenMode::hasPageLayout ( ) const

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

Returns
true: 持っている、false: 持っていない。
Exceptions
PtlException

◆ hasPageMode()

bool PdfTk::PtlOpenMode::hasPageMode ( ) const

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

Returns
true: 持っている、false: 持っていない。
Exceptions
PtlException

◆ operator=()

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

コピーオペレータ

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

◆ removeOpenAction()

void PdfTk::PtlOpenMode::removeOpenAction ( )

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

Exceptions
PtlException

◆ setDisplayDocTitle()

void PdfTk::PtlOpenMode::setDisplayDocTitle ( bool  docTitle)

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

Parameters
docTitletrue: 表示、false: 非表示。

◆ setOpenAction()

void PdfTk::PtlOpenMode::setOpenAction ( const PtlAction action)

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

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

Parameters
actionアクション。
Exceptions
PtlException

◆ setOpenDest()

void PdfTk::PtlOpenMode::setOpenDest ( const PtlDest dest)

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

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

Parameters
dest宛先
Exceptions
PtlException

◆ setPageLayout()

void PdfTk::PtlOpenMode::setPageLayout ( PAGE_LAYOUT  pageLayout)

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

Parameters
pageLayoutページレイアウト。
Exceptions
PtlException

◆ setPageMode()

void PdfTk::PtlOpenMode::setPageMode ( PAGE_MODE  pageMode)

ページモードを設定。

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

Parameters
pageModeページモード。
Exceptions
PtlException

◆ setUIOption()

void PdfTk::PtlOpenMode::setUIOption ( int  option)

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

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

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

◆ setWindowOption()

void PdfTk::PtlOpenMode::setWindowOption ( int  option)

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

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

Parameters
optionウィンドウオプション。WINDOW_OPTION_XXXのウィンドウオプション。
Exceptions
PtlException