PdfTk::PtlDest クラス

#include <PtlDest.h>

PdfTk::PtlDest の継承関係図

公開型
enum	DEST_TYPE {   TYPE_NONE = 0 , TYPE_XYZ = 1 , TYPE_FIT = 2 , TYPE_FIT_H = 3 ,   TYPE_FIT_V = 4 , TYPE_FIT_R = 5 , TYPE_FIT_B = 6 , TYPE_FIT_BH = 7 ,   TYPE_FIT_BV = 8 }

公開メンバ関数
int	getHandle () const
	PtlDest (DEST_TYPE type)
	コンストラクタ
	PtlDest (const PtlDest &obj)
	コピーコンストラクタ
virtual	~PtlDest ()
	デストラクタ
PtlDest &	operator= (const PtlDest &obj)
	コピーオペレータ
DEST_TYPE	getType () const
	宛先タイプを取得。
int	getPageNumber () const
	宛先ページを取得。
void	setPageNumber (int page)
	宛先ページを設定。
bool	isLeftNull () const
	leftがnullかどうかをチェック。
float	getLeft () const
	leftを取得。
void	setLeft (float value)
	leftに数値を設定。
void	setLeftNull ()
	leftにnullを設定。
bool	isBottomNull () const
	bottomがnullかどうかをチェック。
float	getBottom () const
	bottomを取得。
void	setBottom (float value)
	bottomに数値を設定。
void	setBottomNull ()
	bottomにnullを設定。
bool	isRightNull () const
	rightがnullかどうかをチェック。
float	getRight () const
	rightを取得。
void	setRight (float value)
	rightに数値を設定。
void	setRightNull ()
	rightにnullを設定。
bool	isTopNull () const
	topがnullかどうかをチェック。
float	getTop () const
	topの取得。
void	setTop (float value)
	topに数値を設定。
void	setTopNull ()
	topにnullの設定。
bool	isZoomNull () const
	zoomがnullかどうかをチェック。
float	getZoom () const
	zoomを取得。
void	setZoom (float value)
	zoomを設定。
void	setZoomNull ()
	zoomにnullを設定。

詳解

PDFの宛先を表現したクラスです。
すべての宛先クラスのベースクラスです。

※ 注意
PDFToolは座標の原点(0,0)は左下ですが、この宛先のクラスに関しては異なります。
ページは回転が設定されている場合があります。
宛先の座標は回転する前(回転が0)の座標になります。原点もページが回転する前の座標で(0,0)となります。

PtlDest.h の 22 行目に定義があります。

列挙型メンバ詳解

DEST_TYPE

enum PdfTk::PtlDest::DEST_TYPE

宛先のタイプ

列挙値
TYPE_NONE	宛先なし(取得時専用)
TYPE_XYZ	XYZ型
TYPE_FIT	Fit型(全体表示)
TYPE_FIT_H	FitH型(幅に合わせる)
TYPE_FIT_V	FitV型(高さに合わせる)
TYPE_FIT_R	FitR型
TYPE_FIT_B	FitB型
TYPE_FIT_BH	FitBH型(描画領域の幅に合わせる)
TYPE_FIT_BV	FitBV型

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

構築子と解体子

PtlDest() [1/2]

PdfTk::PtlDest::PtlDest

(

DEST_TYPE

type

)

コンストラクタ

引数

type

タイプ

例外

PtlException

PtlDest() [2/2]

PdfTk::PtlDest::PtlDest

(

const PtlDest &

obj

)

コピーコンストラクタ

引数

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

例外

PtlException

関数詳解

getBottom()

float PdfTk::PtlDest::getBottom

(

)

const

bottomを取得。

nullの場合、例外がスローされます。事前にisBottomNullでチェックしてください。
座標の単位はmmで原点(0,0)はページが回転する前の座標での左下となりますので注意してください。

戻り値

bottom値

例外

PtlException

getLeft()

float PdfTk::PtlDest::getLeft

(

)

const

leftを取得。

nullの場合、例外がスローされます。事前にisLeftNullでチェックしてください。
座標の単位はmmで原点(0,0)はページが回転する前の座標での左下となりますので注意してください。

戻り値

left値

例外

PtlException

getPageNumber()

int PdfTk::PtlDest::getPageNumber

(

)

const

宛先ページを取得。

ページ番号は0オリジンです。

戻り値

宛先ページ番号

例外

PtlException

getRight()

float PdfTk::PtlDest::getRight

(

)

const

rightを取得。

nullの場合、例外がスローされます。事前にisRightNullでチェックしてください。
座標の単位はmmで原点(0,0)はページが回転する前の座標での左下となりますので注意してください。

戻り値

right値

例外

PtlException

getTop()

float PdfTk::PtlDest::getTop

(

)

const

topの取得。

nullの場合、例外がスローされます。事前にisTopNullでチェックしてください。
座標の単位はmmで原点(0,0)はページが回転する前の座標での左下となりますので注意してください。

戻り値

top値

例外

PtlException

getType()

DEST_TYPE PdfTk::PtlDest::getType

(

)

const

宛先タイプを取得。

戻り値

宛先タイプ

例外

PtlException

getZoom()

float PdfTk::PtlDest::getZoom

(

)

const

zoomを取得。

nullの場合、例外がスローされます。事前にisZoomNullでチェックしてください。

戻り値

zoom値

例外

PtlException

isBottomNull()

bool PdfTk::PtlDest::isBottomNull

(

)

const

bottomがnullかどうかをチェック。

戻り値

true: null、false: 数値。

例外

PtlException

isLeftNull()

bool PdfTk::PtlDest::isLeftNull

(

)

const

leftがnullかどうかをチェック。

戻り値

true: null、false: 数値。

例外

PtlException

isRightNull()

bool PdfTk::PtlDest::isRightNull

(

)

const

rightがnullかどうかをチェック。

戻り値

true: null、false: 数値。

例外

PtlException

isTopNull()

bool PdfTk::PtlDest::isTopNull

(

)

const

topがnullかどうかをチェック。

戻り値

true: null、false: 数値。

例外

PtlException

isZoomNull()

bool PdfTk::PtlDest::isZoomNull

(

)

const

zoomがnullかどうかをチェック。

戻り値

true: null、false: 数値。

例外

PtlException

operator=()

PtlDest & PdfTk::PtlDest::operator=

(

const PtlDest &

obj

)

コピーオペレータ

引数

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

例外

PtlException

setBottom()

void PdfTk::PtlDest::setBottom

(

float

value

)

bottomに数値を設定。

座標の単位はmmで原点(0,0)はページが回転する前の座標での左下となりますので注意してください。

引数

value

bottom値

例外

PtlException

setBottomNull()

void PdfTk::PtlDest::setBottomNull

(

)

bottomにnullを設定。

例外

PtlException

setLeft()

void PdfTk::PtlDest::setLeft

(

float

value

)

leftに数値を設定。

座標の単位はmmで原点(0,0)はページが回転する前の座標での左下となりますので注意してください。

引数

value

left値

例外

PtlException

setLeftNull()

void PdfTk::PtlDest::setLeftNull

(

)

leftにnullを設定。

例外

PtlException

setPageNumber()

void PdfTk::PtlDest::setPageNumber

(

int

page

)

宛先ページを設定。

ページ番号は0オリジンです。

引数

page

宛先ページ番号

例外

PtlException

setRight()

void PdfTk::PtlDest::setRight

(

float

value

)

rightに数値を設定。

座標の単位はmmで原点(0,0)はページが回転する前の座標での左下となりますので注意してください

引数

value

right値

例外

PtlException

setRightNull()

void PdfTk::PtlDest::setRightNull

(

)

rightにnullを設定。

例外

PtlException

setTop()

void PdfTk::PtlDest::setTop

(

float

value

)

topに数値を設定。

座標の単位はmmで原点(0,0)はページが回転する前の座標での左下となりますので注意してください。

引数

value

top値

例外

PtlException

setTopNull()

void PdfTk::PtlDest::setTopNull

(

)

topにnullの設定。

例外

PtlException

setZoom()

void PdfTk::PtlDest::setZoom

(

float

value

)

zoomを設定。

引数

value

zoom値

例外

PtlException

setZoomNull()

void PdfTk::PtlDest::setZoomNull

(

)

zoomにnullを設定。

例外

PtlException