PdfTk::PtlDest Class Reference

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

#include <PtlDest.h>

Inheritance diagram for PdfTk::PtlDest:

Public Types
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 }
	宛先のタイプ More...

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

Detailed Description

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

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

Member Enumeration Documentation

DEST_TYPE

enum PdfTk::PtlDest::DEST_TYPE

宛先のタイプ

Enumerator
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型

Constructor & Destructor Documentation

PtlDest() [1/2]

PdfTk::PtlDest::PtlDest

(

DEST_TYPE

type

)

コンストラクタ

Parameters

type

タイプ

Exceptions

PtlException

PtlDest() [2/2]

PdfTk::PtlDest::PtlDest

(

const PtlDest &

obj

)

コピーコンストラクタ

Parameters

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

Exceptions

PtlException

Member Function Documentation

getBottom()

float PdfTk::PtlDest::getBottom

(

)

const

bottomを取得。

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

Returns

bottom値

Exceptions

PtlException

getLeft()

float PdfTk::PtlDest::getLeft

(

)

const

leftを取得。

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

Returns

left値

Exceptions

PtlException

getPageNumber()

int PdfTk::PtlDest::getPageNumber

(

)

const

宛先ページを取得。

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

Returns

宛先ページ番号

Exceptions

PtlException

getRight()

float PdfTk::PtlDest::getRight

(

)

const

rightを取得。

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

Returns

right値

Exceptions

PtlException

getTop()

float PdfTk::PtlDest::getTop

(

)

const

topの取得。

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

Returns

top値

Exceptions

PtlException

getType()

DEST_TYPE PdfTk::PtlDest::getType

(

)

const

宛先タイプを取得。

Returns

宛先タイプ

Exceptions

PtlException

getZoom()

float PdfTk::PtlDest::getZoom

(

)

const

zoomを取得。

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

Returns

zoom値

Exceptions

PtlException

isBottomNull()

bool PdfTk::PtlDest::isBottomNull

(

)

const

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

Returns

true: null、false: 数値。

Exceptions

PtlException

isLeftNull()

bool PdfTk::PtlDest::isLeftNull

(

)

const

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

Returns

true: null、false: 数値。

Exceptions

PtlException

isRightNull()

bool PdfTk::PtlDest::isRightNull

(

)

const

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

Returns

true: null、false: 数値。

Exceptions

PtlException

isTopNull()

bool PdfTk::PtlDest::isTopNull

(

)

const

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

Returns

true: null、false: 数値。

Exceptions

PtlException

isZoomNull()

bool PdfTk::PtlDest::isZoomNull

(

)

const

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

Returns

true: null、false: 数値。

Exceptions

PtlException

operator=()

PtlDest& PdfTk::PtlDest::operator=

(

const PtlDest &

obj

)

コピーオペレータ

Parameters

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

Exceptions

PtlException

setBottom()

void PdfTk::PtlDest::setBottom

(

float

value

)

bottomに数値を設定。

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

Parameters

value

bottom値

Exceptions

PtlException

setBottomNull()

void PdfTk::PtlDest::setBottomNull

(

)

bottomにnullを設定。

Exceptions

PtlException

setLeft()

void PdfTk::PtlDest::setLeft

(

float

value

)

leftに数値を設定。

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

Parameters

value

left値

Exceptions

PtlException

setLeftNull()

void PdfTk::PtlDest::setLeftNull

(

)

leftにnullを設定。

Exceptions

PtlException

setPageNumber()

void PdfTk::PtlDest::setPageNumber

(

int

page

)

宛先ページを設定。

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

Parameters

page

宛先ページ番号

Exceptions

PtlException

setRight()

void PdfTk::PtlDest::setRight

(

float

value

)

rightに数値を設定。

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

Parameters

value

right値

Exceptions

PtlException

setRightNull()

void PdfTk::PtlDest::setRightNull

(

)

rightにnullを設定。

Exceptions

PtlException

setTop()

void PdfTk::PtlDest::setTop

(

float

value

)

topに数値を設定。

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

Parameters

value

top値

Exceptions

PtlException

setTopNull()

void PdfTk::PtlDest::setTopNull

(

)

topにnullの設定。

Exceptions

PtlException

setZoom()

void PdfTk::PtlDest::setZoom

(

float

value

)

zoomを設定。

Parameters

value

zoom値

Exceptions

PtlException

setZoomNull()

void PdfTk::PtlDest::setZoomNull

(

)

zoomにnullを設定。

Exceptions

PtlException