PDFTool 7.0
PdfTk::PtlParamImagePage Class Reference

画像のページ作成に使うパラメータクラスです。 More...

#include <PtlParamImagePage.h>

Public Types

enum  PAPER_TYPE {
  PAPER_A4 = 1 , PAPER_A4_R , PAPER_A3 , PAPER_A3_R ,
  PAPER_B4 , PAPER_B4_R , PAPER_B5 , PAPER_B5_R ,
  PAPER_LETTER , PAPER_LETTER_R , PAPER_TABLOID , PAPER_TABLOID_R ,
  PAPER_LEGAL , PAPER_LEGAL_R , PAPER_EXECUTIVE , PAPER_EXECUTIVE_R ,
  PAPER_CUSTOM_SIZE , PAPER_IMAGE_SIZE
}
 用紙タイプ More...
enum  ALIGN {
  ALIGN_TOP_LEFT = 1 , ALIGN_TOP = 2 , ALIGN_TOP_RIGHT = 3 , ALIGN_LEFT = 4 ,
  ALIGN_CENTER = 5 , ALIGN_RIGHT = 6 , ALIGN_BOTTOM_LEFT = 7 , ALIGN_BOTTOM = 8 ,
  ALIGN_BOTTOM_RIGHT = 9
}
 画像の配置 More...

Public Member Functions

int getHandle () const
 PtlParamImagePage ()
 コンストラクタ
 PtlParamImagePage (const PtlParamImagePage &obj)
 コピーコンストラクタ alias copy
 ‾PtlParamImagePage ()
 デストラクタ
PtlParamImagePageoperator= (const PtlParamImagePage &obj)
 コピーオペレータ alias copy
void setImage (const PtlParamDrawImage &paramDrawImage)
 ページに挿入する画像パラメータを設定。
void setPaperType (PAPER_TYPE paperType)
 用紙タイプを設定。
void setCustomPageSize (const PtlSize &sizeMM)
 ユーザ定義ページサイズを設定
void setRect (const PtlRect &rectMM)
 画像を配置する矩形を設定。
void setMargin (float topMM, float leftMM, float bottomMM, float rightMM)
 画像を配置するときの余白を設定。
void setAlign (ALIGN align)
 画像の配置を設定。

Detailed Description

画像のページ作成に使うパラメータクラスです。

Member Enumeration Documentation

◆ ALIGN

画像の配置

Enumerator
ALIGN_TOP_LEFT 

左上

ALIGN_TOP 

中央上

ALIGN_TOP_RIGHT 

右上

ALIGN_LEFT 

中央左

ALIGN_CENTER 

中央(デフォルト値)

ALIGN_RIGHT 

中央右

ALIGN_BOTTOM_LEFT 

左下

ALIGN_BOTTOM 

中央下

ALIGN_BOTTOM_RIGHT 

右下

◆ PAPER_TYPE

用紙タイプ

Enumerator
PAPER_A4 

A4.

PAPER_A4_R 

A4 Rotated.

PAPER_A3 

A3.

PAPER_A3_R 

A3 Rotated.

PAPER_B4 

B4.

PAPER_B4_R 

B4 Rotated.

PAPER_B5 

B5.

PAPER_B5_R 

B5 Rotated.

PAPER_LETTER 

Letter.

PAPER_LETTER_R 

Letter Rotated.

PAPER_TABLOID 

Tabloid.

PAPER_TABLOID_R 

Tabloid Rotated.

PAPER_LEGAL 

Legal.

PAPER_LEGAL_R 

Legal Rotated.

PAPER_EXECUTIVE 

Executive.

PAPER_EXECUTIVE_R 

Executive Rotated.

PAPER_CUSTOM_SIZE 

カスタムサイズ

PAPER_IMAGE_SIZE 

画像サイズに合わせる(デフォルト値)

Constructor & Destructor Documentation

◆ PtlParamImagePage() [1/2]

PdfTk::PtlParamImagePage::PtlParamImagePage ( )

コンストラクタ

Exceptions
PtlException

◆ PtlParamImagePage() [2/2]

PdfTk::PtlParamImagePage::PtlParamImagePage ( const PtlParamImagePage & obj)

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

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

Member Function Documentation

◆ operator=()

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

コピーオペレータ alias copy

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

◆ setAlign()

void PdfTk::PtlParamImagePage::setAlign ( ALIGN align)

画像の配置を設定。

設定しない場合はALIGN_CENTERが設定されたとみなされます。

Parameters
align画像の配置指定。
Exceptions
PtlException

◆ setCustomPageSize()

void PdfTk::PtlParamImagePage::setCustomPageSize ( const PtlSize & sizeMM)

ユーザ定義ページサイズを設定

setPaperTypeでPAPER_CUSTOM_SIZEが設定された場合に有効となります。
この関数は新規ページに画像を設定する場合に有効となります。
setPaperTypeでPAPER_CUSTOM_SIZEを設定してページサイズを設定しないとsetPaperSizeでPAPER_IMAGE_SIZEが設定されたとみなされます。

Parameters
sizeMMPDFの用紙サイズを設定します(単位はmm)。

◆ setImage()

void PdfTk::PtlParamImagePage::setImage ( const PtlParamDrawImage & paramDrawImage)

ページに挿入する画像パラメータを設定。

Parameters
paramDrawImageページに挿入する画像パラメータ。
Exceptions
PtlException

◆ setMargin()

void PdfTk::PtlParamImagePage::setMargin ( float topMM,
float leftMM,
float bottomMM,
float rightMM )

画像を配置するときの余白を設定。

画像の配置位置の設定はsetRectとsetMarginがあります。
setRectも併せて設定するとその値により設定内容は調整されます。
座標の単位はmmで原点(0,0)は左下となりますので注意してください。

Parameters
topMM画像を配置するときの上側の余白(単位はmm)。
leftMM画像を配置するときの左側の余白(単位はmm)。
bottomMM画像を配置するときの下側の余白(単位はmm)。
rightMM画像を配置するときの右側の余白(単位はmm)。
Exceptions
PtlException

◆ setPaperType()

void PdfTk::PtlParamImagePage::setPaperType ( PAPER_TYPE paperType)

用紙タイプを設定。

※ 設定しない場合はデフォルト値としてPAPER_IMAGE_SIZEが設定されます。

Parameters
paperType用紙タイプの指定。
Exceptions
PtlException

◆ setRect()

void PdfTk::PtlParamImagePage::setRect ( const PtlRect & rectMM)

画像を配置する矩形を設定。

座標の単位はmmで原点(0,0)は左下となりますので注意してください。 画像の配置位置の設定はsetRectとsetMarginがあります。
setMarginも併せて設定するとその値により設定内容は調整されます。
座標の単位はmmで原点(0,0)は左下となりますので注意してください。

Parameters
rectMM画像を配置する矩形。
Exceptions
PtlException