PdfTk::PtlParamDrawLayer Class Reference

レイヤーの描画に使うパラメータクラスです。 More...

#include <PtlParamDrawLayer.h>

Public Types
enum	ZORDER { ZORDER_FRONT = 1, ZORDER_BACK = 2 }
	レイヤーのZオーダー More...
enum	SHOW { SHOW_ON = 1, SHOW_OFF = 2 }
	レイヤーの表示/非表示 More...

Public Member Functions
int	getHandle () const
	PtlParamDrawLayer ()
	コンストラクタ More...
	PtlParamDrawLayer (const PtlParamDrawLayer &obj)
	コピーコンストラクタ alias copy More...
	‾PtlParamDrawLayer ()
	デストラクタ
PtlParamDrawLayer &	operator= (const PtlParamDrawLayer &obj)
	コピーオペレータ alias copy More...
void	setPage (const PtlPage &page)
	レイヤーに使用するPDF文書ページを設定。 More...
void	setName (const PtlParamString &name)
	レイヤーの名前を設定。 More...
void	setOpacity (float opacity)
	レイヤーの不透明度を設定。 More...
void	setRotate (int value)
	回転角度を設定。 More...
void	setAngle (float angle)
	任意の傾きを設定。 More...
void	setZorder (ZORDER zorder)
	レイヤーのZオーダーを設定。 More...
void	setShow (SHOW show)
	レイヤーの表示/非表示を設定。 More...

Detailed Description

レイヤーの描画に使うパラメータクラスです。

Member Enumeration Documentation

SHOW

enum PdfTk::PtlParamDrawLayer::SHOW

レイヤーの表示/非表示

Enumerator
SHOW_ON	表示(デフォルト値)
SHOW_OFF	非表示

ZORDER

enum PdfTk::PtlParamDrawLayer::ZORDER

レイヤーのZオーダー

Enumerator
ZORDER_FRONT	ページの前面(デフォルト値)
ZORDER_BACK	ページの背面

Constructor & Destructor Documentation

PtlParamDrawLayer() [1/2]

PdfTk::PtlParamDrawLayer::PtlParamDrawLayer

(

)

コンストラクタ

Exceptions

PtlException

PtlParamDrawLayer() [2/2]

PdfTk::PtlParamDrawLayer::PtlParamDrawLayer

(

const PtlParamDrawLayer &

obj

)

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

Parameters

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

Exceptions

PtlException

Member Function Documentation

operator=()

PtlParamDrawLayer& PdfTk::PtlParamDrawLayer::operator=

(

const PtlParamDrawLayer &

obj

)

コピーオペレータ alias copy

Parameters

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

setAngle()

void PdfTk::PtlParamDrawLayer::setAngle

(

float

angle

)

任意の傾きを設定。

傾きの角度は時計回りに90度単位になります。
傾きを設定する場合は他の関数より先に設定してください。

Parameters

angle

任意の角度で配置する。反時計回りが正の値。

Exceptions

PtlException

setName()

void PdfTk::PtlParamDrawLayer::setName

(

const PtlParamString &

name

)

レイヤーの名前を設定。

名前の設定は必須です。

Parameters

name

レイヤーの名前。

Exceptions

PtlException

setOpacity()

void PdfTk::PtlParamDrawLayer::setOpacity

(

float

opacity

)

レイヤーの不透明度を設定。

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

Parameters

opacity

0.0 〜 1.0。0.0が透明、1.0が不透明。

Exceptions

PtlException

setPage()

void PdfTk::PtlParamDrawLayer::setPage

(

const PtlPage &

page

)

レイヤーに使用するPDF文書ページを設定。

ページ描画以外は欠落します(注釈など)。
レイヤーに使用するPDF文書のオブジェクト(PtlPDFDocument)はPDF文書を保存するまで存在していなければなりません。

Parameters

page	レイヤーに使用するPDF文書のページ。

Exceptions

PtlException

setRotate()

void PdfTk::PtlParamDrawLayer::setRotate

(

int

value

)

回転角度を設定。

回転角度は時計回りに90度単位になります。
回転角度を設定する場合は他の関数より先に設定してください。

Parameters

value

回転角度（0, 90, 180, 270）

Exceptions

PtlException

setShow()

void PdfTk::PtlParamDrawLayer::setShow

(

SHOW

show

)

レイヤーの表示/非表示を設定。

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

Parameters

show	レイヤーの表示/非表示。SHOW_XXXのいずれか。

Exceptions

PtlException

setZorder()

void PdfTk::PtlParamDrawLayer::setZorder

(

ZORDER

zorder

)

レイヤーのZオーダーを設定。

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

Parameters

zorder

レイヤーのZオーダー。ZORDER_XXXのいずれか。

Exceptions

PtlException