透かしの設定で使うパラメータクラスです。
すべての透かしパラメータクラスのベースクラスです。 More...

#include <PtlParamWaterMark.h>

Inheritance diagram for PdfTk::PtlParamWaterMark:

[legend]

Public Types
enum	TYPE_WATERMARK { TYPE_COLOR = 1, TYPE_TEXT = 2, TYPE_PDF = 3, TYPE_IMAGE = 4 }
	透かしのタイプ 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...

enum	ZORDER { ZORDER_FRONT = 1, ZORDER_BACK = 2 }
	透かしのZオーダー More...

enum	PAGE_RANGE { PAGE_RANGE_ALL = 0, PAGE_RANGE_FIRST = 1, PAGE_RANGE_LAST = 2, PAGE_RANGE_ODD = 3, PAGE_RANGE_EVEN = 4, PAGE_RANGE_CUSTOM = 5 }
	透かしを入れるページの範囲 More...

Public Member Functions
int	getHandle () const

	PtlParamWaterMark (TYPE_WATERMARK type)
	コンストラクタ。 More...

	PtlParamWaterMark (const PtlParamWaterMark &obj)
	コピーコンストラクタ alias copy More...

virtual	‾PtlParamWaterMark ()
	デストラクタ

PtlParamWaterMark &	operator= (const PtlParamWaterMark &obj)
	コピーオペレータ alias copy More...

TYPE_WATERMARK	getType () const
	透かしタイプを取得。 More...

void	setName (const PtlParamString &name)
	透かしの名前を設定。 More...

void	setRect (const PtlRect &rectMM)
	透かしを配置する矩形の設定。 More...

void	setMargin (float topMM, float leftMM, float bottomMM, float rightMM)
	透かしを配置するときの余白を設定。 More...

void	setAlign (ALIGN align)
	透かしの配置を設定。 More...

void	setZorder (ZORDER zorder)
	透かしのZオーダーを設定。 More...

void	setPageRange (PAGE_RANGE pageRange)
	透かしを入れるページの範囲を設定。 More...

void	setNotInFirst (bool bNotInFirst)
	先頭ページに透かしを配置するかしないかの設定。 More...

void	setNotInLast (bool bNotInLast)
	最終ページに透かしを配置するかしないかの設定。 More...

void	setCustomPageRange (const PtlParamString &customPageRange)
	透かしを配置するページの範囲の指定を設定。 More...

void	setDisplayWaterMark (bool bDisplayWaterMark)
	PDF表示時に透かしを表示する指定を設定。 More...

void	setPrintWaterMark (bool bPrintWaterMark)
	PDF印刷時に透かしを印刷する指定を設定。 More...

void	setOpacity (float opacity)
	透かしの不透明度を設定。 More...

void	setTiling (bool bTiling)
	透かしをタイリングして配置するかどうかを設定。 More...

void	setAngle (float angle)
	透かしを配置する任意の角度を設定。 More...

void	setAcrobatCompatible (bool compatible)
	Acrobat互換にするかどうかの設定 More...

Detailed Description

透かしの設定で使うパラメータクラスです。
すべての透かしパラメータクラスのベースクラスです。

Member Enumeration Documentation

◆ ALIGN

enum PdfTk::PtlParamWaterMark::ALIGN

透かしの配置

Enumerator
ALIGN_TOP_LEFT	左上
ALIGN_TOP	中央上
ALIGN_TOP_RIGHT	右上
ALIGN_LEFT	中央左
ALIGN_CENTER	中央(デフォルト値)
ALIGN_RIGHT	中央右
ALIGN_BOTTOM_LEFT	左下
ALIGN_BOTTOM	中央下
ALIGN_BOTTOM_RIGHT	右下

◆ PAGE_RANGE

enum PdfTk::PtlParamWaterMark::PAGE_RANGE

透かしを入れるページの範囲

Enumerator
PAGE_RANGE_ALL	全ページ
PAGE_RANGE_FIRST	先頭ページのみ
PAGE_RANGE_LAST	最終ページのみ
PAGE_RANGE_ODD	奇数ページ
PAGE_RANGE_EVEN	偶数ページ
PAGE_RANGE_CUSTOM	指定ページ(setCustomPageRangeでページ範囲を設定)

◆ TYPE_WATERMARK

enum PdfTk::PtlParamWaterMark::TYPE_WATERMARK

透かしのタイプ

Enumerator
TYPE_COLOR	色
TYPE_TEXT	テキスト
TYPE_PDF	PDF
TYPE_IMAGE	画像

◆ ZORDER

enum PdfTk::PtlParamWaterMark::ZORDER

透かしのZオーダー

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

Constructor & Destructor Documentation

◆ PtlParamWaterMark() [1/2]

PdfTk::PtlParamWaterMark::PtlParamWaterMark ( TYPE_WATERMARK type )

コンストラクタ。

Parameters

type タイプ

Exceptions

PtlException

◆ PtlParamWaterMark() [2/2]

PdfTk::PtlParamWaterMark::PtlParamWaterMark ( const PtlParamWaterMark & obj )

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

Parameters

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

Exceptions

PtlException

Member Function Documentation

◆ getType()

TYPE_WATERMARK PdfTk::PtlParamWaterMark::getType ( ) const

透かしタイプを取得。

Returns: 透かしタイプ

Exceptions

PtlException

◆ operator=()

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

コピーオペレータ alias copy

Parameters

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

◆ setAcrobatCompatible()

void PdfTk::PtlParamWaterMark::setAcrobatCompatible ( bool compatible )

Acrobat互換にするかどうかの設定

Acrobat互換で透かしを作成するかどうかを設定します。設定しない場合はデフォルト値としてfalseが設定されます。

※ PDF Tool API独自のオプションを同時に設定すると、 ERROR_CODE::INVALID_PARAMETER_VALUEが例外として発生します。
具体的には以下のいずれかの設定がある場合は設定できません。
PtlParamWaterMark : setTilingでtrueを指定／ setCustomPageRangeで連続しないページを指定／ setMarginを設定／ setRectを設定
PtlParamWaterMarkText : setOutlineColorを設定／ setWriteDiagonalでtrueを指定

Parameters

compatible [in] Acrobat互換にするかどうかを指定します。trueならAcrobat互換にする。

◆ setAlign()

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

透かしの配置を設定。

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

Parameters

align 透かしの配置指定。

Exceptions

PtlException

◆ setAngle()

void PdfTk::PtlParamWaterMark::setAngle ( float angle )

透かしを配置する任意の角度を設定。

透かしの角度を度で設定します。反時計回りが正の値。
TYPE_COLORでは設定は無視されます。
TYPE_TEXTではPtlParamWaterMarkText::setTextAngle()と同等です。

Parameters

angle 任意の角度。反時計回りが正の値。

Exceptions

PtlException

◆ setCustomPageRange()

void PdfTk::PtlParamWaterMark::setCustomPageRange ( const PtlParamString & customPageRange )

透かしを配置するページの範囲の指定を設定。

Parameters

customPageRange 透かしを配置するページの範囲の指定。
setPageRangeでPAGE_RANGE_CUSTOMを設定した場合のみ有効。
例 "0,2-4" と指定すると、1ページと3から5ページに透かしが入ります。ページは0オリジンです。

Exceptions

PtlException

◆ setDisplayWaterMark()

void PdfTk::PtlParamWaterMark::setDisplayWaterMark ( bool bDisplayWaterMark )

PDF表示時に透かしを表示する指定を設定。

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

Parameters

bDisplayWaterMark PDF表示時に透かしを表示する指定。trueなら表示する。

Exceptions

PtlException

◆ setMargin()

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

透かしを配置するときの余白を設定。

透かしの配置位置の設定はsetRectとsetMarginがあります。
setRectも併せて設定するとsetRectで設定した矩形とsetMarginによって出来る矩形の交差する矩形が最終的に配置される矩形となります。
表示矩形（ViewBox）上の座標値をmm単位で指定してください。。
ViewBoxの詳細については PtlPage#getViewBoxを参照してください。

Parameters

topMM	透かしを配置するときの上側の余白(単位はmm)。
leftMM	透かしを配置するときの左側の余白(単位はmm)。
bottomMM	透かしを配置するときの下側の余白(単位はmm)。
rightMM	透かしを配置するときの右側の余白(単位はmm)。

Exceptions

PtlException

◆ setName()

void PdfTk::PtlParamWaterMark::setName ( const PtlParamString & name )

透かしの名前を設定。

Parameters

name	透かしの名前。英数字で設定してください。

Exceptions

PtlException

◆ setNotInFirst()

void PdfTk::PtlParamWaterMark::setNotInFirst ( bool bNotInFirst )

先頭ページに透かしを配置するかしないかの設定。

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

Parameters

bNotInFirst 先頭ページに透かしを配置しない設定。trueなら配置しない。

Exceptions

PtlException

◆ setNotInLast()

void PdfTk::PtlParamWaterMark::setNotInLast ( bool bNotInLast )

最終ページに透かしを配置するかしないかの設定。

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

Parameters

bNotInLast 最終ページに透かしを配置しない設定。trueなら配置しない。

Exceptions

PtlException

◆ setOpacity()

void PdfTk::PtlParamWaterMark::setOpacity ( float opacity )

透かしの不透明度を設定。

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

Parameters

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

Exceptions

PtlException

◆ setPageRange()

void PdfTk::PtlParamWaterMark::setPageRange ( PAGE_RANGE pageRange )

透かしを入れるページの範囲を設定。

PAGE_RANGE_CUSTOMを設定した場合は、setCustomPageRangeでページ範囲を設定します。

Parameters

pageRange 透かしを入れるページの範囲。

Exceptions

PtlException

◆ setPrintWaterMark()

void PdfTk::PtlParamWaterMark::setPrintWaterMark ( bool bPrintWaterMark )

PDF印刷時に透かしを印刷する指定を設定。

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

Parameters

bPrintWaterMark PDF印刷時に透かしを印刷する指定。trueなら印刷する。

Exceptions

PtlException

◆ setRect()

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

透かしを配置する矩形の設定。

透かしの配置位置の設定はsetRectとsetMarginがあります。
setMarginも併せて設定するとsetRectで設定した矩形とsetMarginによって出来る矩形の交差する矩形が配置される矩形となります。
表示矩形（ViewBox）上の座標値をmm単位で指定してください。
ViewBoxの詳細については PtlPage#getViewBoxを参照してください。

Parameters

rectMM 透かしを配置する矩形。

Exceptions

PtlException

◆ setTiling()

void PdfTk::PtlParamWaterMark::setTiling ( bool bTiling )

透かしをタイリングして配置するかどうかを設定。

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

Parameters

bTiling 透かしをタイリングして配置するかどうか。trueならタイリングして配置。

Exceptions

PtlException

◆ setZorder()

void PdfTk::PtlParamWaterMark::setZorder ( ZORDER zorder )

透かしのZオーダーを設定。

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

Parameters

zorder 透かしのZオーダー。

Exceptions

PtlException

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ ALIGN

◆ PAGE_RANGE

◆ TYPE_WATERMARK

◆ ZORDER

Constructor & Destructor Documentation

◆ PtlParamWaterMark() [1/2]

◆ PtlParamWaterMark() [2/2]

Member Function Documentation

◆ getType()

◆ operator=()

◆ setAcrobatCompatible()

◆ setAlign()

◆ setAngle()

◆ setCustomPageRange()

◆ setDisplayWaterMark()

◆ setMargin()

◆ setName()

◆ setNotInFirst()

◆ setNotInLast()

◆ setOpacity()

◆ setPageRange()

◆ setPrintWaterMark()

◆ setRect()

◆ setTiling()

◆ setZorder()