PdfTk::PtlActionGoToR クラス

#include <PtlActionGoToR.h>

PdfTk::PtlActionGoToR の継承関係図

PdfTk::PtlActionGoToR 連携図

公開メンバ関数
	PtlActionGoToR ()
	コンストラクタ
	PtlActionGoToR (const PtlActionGoToR &obj)
	コピーコンストラクタ alias copy
	~PtlActionGoToR ()
	デストラクタ
PtlActionGoToR &	operator= (const PtlActionGoToR &obj)
	コピーオペレータ alias copy
PtlDest &	getDest () const
	宛先を取得。
void	setDest (const PtlDest &dest)
	宛先を設定。
const PtlParamString &	getFileName ()
	ファイル間移動用PDFファイル名を取得。
void	setFileName (const PtlParamString &filename)
	ファイル間移動用PDFファイルを設定。
bool	getNewWindowFlag () const
	新ウィンドウフラグを取得。
void	setNewWindowFlag (bool flag)
	新ウィンドウフラグを設定。
基底クラス PdfTk::PtlAction に属する継承公開メンバ関数
int	getHandle () const
	PtlAction (ACTION_TYPE type)
	コンストラクタ
	PtlAction (const PtlAction &obj)
	コピーコンストラクタ alias copy
virtual	~PtlAction ()
	デストラクタ
PtlAction &	operator= (const PtlAction &obj)
	コピーオペレータ alias copy
ACTION_TYPE	getType () const
	アクションタイプを取得。

その他の継承メンバ
基底クラス PdfTk::PtlAction に属する継承公開型
enum	ACTION_TYPE {   TYPE_NONE = 0 , TYPE_GOTO = 1 , TYPE_GOTO_R = 2 , TYPE_LAUNCH = 4 ,   TYPE_URI = 6 , TYPE_JAVASCRIPT = 14 , TYPE_UNKNOWN = 100 }

詳解

PDFのGoToRアクションを表現したクラスです。

PtlActionGoToR.h の 20 行目に定義があります。

構築子と解体子

PtlActionGoToR() [1/2]

PdfTk::PtlActionGoToR::PtlActionGoToR

(

)

コンストラクタ

例外

PtlException

PtlActionGoToR() [2/2]

PdfTk::PtlActionGoToR::PtlActionGoToR

(

const PtlActionGoToR &

obj

)

コピーコンストラクタ alias copy

引数

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

例外

PtlException

関数詳解

getDest()

PtlDest & PdfTk::PtlActionGoToR::getDest

(

)

const

宛先を取得。

PtlOptionのsetOriginでORIGIN_TOP_LEFT(左上)を設定すると宛先を正しく取得できません。
PtlActionGoToRは他のPDFの特定ページに飛ぶというアクションになります。
しかしながらそのページのサイズはわかりません。
その為、左下原点で持っている数値を左上原点への座標変換の計算が出来ません。

戻り値

宛先

例外

PtlException

getFileName()

const PtlParamString & PdfTk::PtlActionGoToR::getFileName

(

)

ファイル間移動用PDFファイル名を取得。

戻り値

外部ファイル名

例外

PtlException

getNewWindowFlag()

bool PdfTk::PtlActionGoToR::getNewWindowFlag

(

)

const

新ウィンドウフラグを取得。

宛先文書を新ウィンドウでオープンするかどうかのフラグを取得します。

戻り値

true: 新ウィンドウでオープンする。false: しない。

例外

PtlException

operator=()

PtlActionGoToR & PdfTk::PtlActionGoToR::operator=

(

const PtlActionGoToR &

obj

)

コピーオペレータ alias copy

引数

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

setDest()

void PdfTk::PtlActionGoToR::setDest

(

const PtlDest &

dest

)

宛先を設定。

PtlOptionのsetOriginでORIGIN_TOP_LEFT(左上)を設定すると宛先を正しく設定できません。
PtlActionGoToRは他のPDFの特定ページに飛ぶというアクションになります。
しかしながらそのページのサイズはわかりません。
その為、左上原点の数値をPDFの左下原点への座標変換の計算が出来ません。

引数

dest

宛先

例外

PtlException

setFileName()

void PdfTk::PtlActionGoToR::setFileName

(

const PtlParamString &

filename

)

ファイル間移動用PDFファイルを設定。

引数

filename

外部ファイル名 filenameにはファイル名もしくは相対パス指定することを推奨します。

例外

PtlException

setNewWindowFlag()

void PdfTk::PtlActionGoToR::setNewWindowFlag

(

bool

flag

)

新ウィンドウフラグを設定。

宛先文書を新ウィンドウでオープンするかどうかのフラグを設定します。

引数

flag	true: 新ウィンドウでオープンする。false: しない。

例外

PtlException