PDFTool.NET  6.0
Public Types | Public Member Functions | Protected Attributes | List of all members
PdfTkNet::PtlDest Class Reference

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

#include <NetDest.h>

Inheritance diagram for PdfTkNet::PtlDest:
Inheritance graph
[legend]
Collaboration diagram for PdfTkNet::PtlDest:
Collaboration graph
[legend]

Public Types

enum  DEST_TYPE {
  DEST_TYPE::TYPE_NONE = 0, DEST_TYPE::TYPE_XYZ = 1, DEST_TYPE::TYPE_FIT = 2, DEST_TYPE::TYPE_FIT_H = 3,
  DEST_TYPE::TYPE_FIT_V = 4, DEST_TYPE::TYPE_FIT_R = 5, DEST_TYPE::TYPE_FIT_B = 6, DEST_TYPE::TYPE_FIT_BH = 7,
  DEST_TYPE::TYPE_FIT_BV = 8
}
 宛先のタイプ More...
 

Public Member Functions

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

Protected Attributes

PdfTk::PtlDest * m_native
 

Detailed Description

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

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

Member Enumeration Documentation

◆ DEST_TYPE

enum PdfTkNet::PtlDest::DEST_TYPE
strong

宛先のタイプ

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]

PdfTkNet::PtlDest::PtlDest ( DEST_TYPE  type)

コンストラクタ

Parameters
typeタイプ
Exceptions
PtlException

◆ PtlDest() [2/2]

PdfTkNet::PtlDest::PtlDest ( PtlDest^  obj)

コピーコンストラクタ

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

Member Function Documentation

◆ getBottom()

float PdfTkNet::PtlDest::getBottom ( )

bottomを取得。

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

Returns
bottom値
Exceptions
PtlException

◆ getLeft()

float PdfTkNet::PtlDest::getLeft ( )

leftを取得。

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

Returns
left値
Exceptions
PtlException

◆ getPageNumber()

int PdfTkNet::PtlDest::getPageNumber ( )

宛先ページを取得。

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

Returns
宛先ページ番号
Exceptions
PtlException

◆ getRight()

float PdfTkNet::PtlDest::getRight ( )

rightを取得。

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

Returns
right値
Exceptions
PtlException

◆ getTop()

float PdfTkNet::PtlDest::getTop ( )

topを取得。

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

Returns
top値
Exceptions
PtlException

◆ getType()

DEST_TYPE PdfTkNet::PtlDest::getType ( )

宛先タイプを取得。

Returns
宛先タイプ
Exceptions
PtlException

◆ getZoom()

float PdfTkNet::PtlDest::getZoom ( )

zoomを取得。

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

Returns
zoom値
Exceptions
PtlException

◆ isBottomNull()

bool PdfTkNet::PtlDest::isBottomNull ( )

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

Returns
true: null、false: 数値。
Exceptions
PtlException

◆ isLeftNull()

bool PdfTkNet::PtlDest::isLeftNull ( )

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

Returns
true: null、false: 数値。
Exceptions
PtlException

◆ isRightNull()

bool PdfTkNet::PtlDest::isRightNull ( )

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

Returns
true: null、false: 数値。
Exceptions
PtlException

◆ isTopNull()

bool PdfTkNet::PtlDest::isTopNull ( )

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

Returns
true: null、false: 数値。
Exceptions
PtlException

◆ isZoomNull()

bool PdfTkNet::PtlDest::isZoomNull ( )

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

Returns
true: null、false: 数値。
Exceptions
PtlException

◆ operator=()

PtlDest PdfTkNet::PtlDest::operator= ( PtlDest^  obj)

コピーオペレータ

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

◆ setBottom()

void PdfTkNet::PtlDest::setBottom ( float  value)

bottomに数値を設定。

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

Parameters
valuebottom値
Exceptions
PtlException

◆ setBottomNull()

void PdfTkNet::PtlDest::setBottomNull ( )

bottomにnullを設定。

Exceptions
PtlException

◆ setLeft()

void PdfTkNet::PtlDest::setLeft ( float  value)

leftに数値を設定。

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

Parameters
valueleft値
Exceptions
PtlException

◆ setLeftNull()

void PdfTkNet::PtlDest::setLeftNull ( )

leftにnullを設定。

Exceptions
PtlException

◆ setPageNumber()

void PdfTkNet::PtlDest::setPageNumber ( int  page)

宛先ページを設定。

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

Parameters
page宛先ページ番号
Exceptions
PtlException

◆ setRight()

void PdfTkNet::PtlDest::setRight ( float  value)

rightに数値を設定。

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

Parameters
valueright値
Exceptions
PtlException

◆ setRightNull()

void PdfTkNet::PtlDest::setRightNull ( )

rightにnullを設定。

Exceptions
PtlException

◆ setTop()

void PdfTkNet::PtlDest::setTop ( float  value)

topに数値を設定。

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

Parameters
valuetop値
Exceptions
PtlException

◆ setTopNull()

void PdfTkNet::PtlDest::setTopNull ( )

topにnullを設定。

Exceptions
PtlException

◆ setZoom()

void PdfTkNet::PtlDest::setZoom ( float  value)

zoomを設定。

Parameters
valuezoom値
Exceptions
PtlException

◆ setZoomNull()

void PdfTkNet::PtlDest::setZoomNull ( )

zoomにnullを設定。

Exceptions
PtlException
Generated by   doxygen 1.8.18