Antenna House PDF Tool API (C++) 8.0
PdfTk::PtlParamWaterMark クラス

#include <PtlParamWaterMark.h>

PdfTk::PtlParamWaterMark の継承関係図

公開型

enum  TYPE_WATERMARK { TYPE_COLOR = 1 , TYPE_TEXT = 2 , TYPE_PDF = 3 , TYPE_IMAGE = 4 }
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
}
enum  ZORDER { ZORDER_FRONT = 1 , ZORDER_BACK = 2 }
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
}

公開メンバ関数

int getHandle () const
 PtlParamWaterMark (TYPE_WATERMARK type)
 コンストラクタ。
 PtlParamWaterMark (const PtlParamWaterMark &obj)
 コピーコンストラクタ alias copy
virtual ~PtlParamWaterMark ()
 デストラクタ
PtlParamWaterMarkoperator= (const PtlParamWaterMark &obj)
 コピーオペレータ alias copy
TYPE_WATERMARK getType () const
 透かしタイプを取得。
void setName (const PtlParamString &name)
 透かしの名前を設定。
void setRect (const PtlRect &rectMM)
 透かしを配置する矩形の設定。
void setMargin (float topMM, float leftMM, float bottomMM, float rightMM)
 透かしを配置するときの余白を設定。
void setAlign (ALIGN align)
 透かしの配置を設定。
void setZorder (ZORDER zorder)
 透かしのZオーダーを設定。
void setPageRange (PAGE_RANGE pageRange)
 透かしを入れるページの範囲を設定。
void setNotInFirst (bool bNotInFirst)
 先頭ページに透かしを配置するかしないかの設定。
void setNotInLast (bool bNotInLast)
 最終ページに透かしを配置するかしないかの設定。
void setCustomPageRange (const PtlParamString &customPageRange)
 透かしを配置するページの範囲の指定を設定。
void setDisplayWaterMark (bool bDisplayWaterMark)
 PDF表示時に透かしを表示する指定を設定。
void setPrintWaterMark (bool bPrintWaterMark)
 PDF印刷時に透かしを印刷する指定を設定。
void setOpacity (float opacity)
 透かしの不透明度を設定。
void setTiling (bool bTiling)
 透かしをタイリングして配置するかどうかを設定。
void setAngle (float angle)
 透かしを配置する任意の角度を設定。
void setAcrobatCompatible (bool compatible)
 Acrobat互換にするかどうかの設定

詳解

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

PtlParamWaterMark.h21 行目に定義があります。

列挙型メンバ詳解

◆ ALIGN

透かしの配置

列挙値
ALIGN_TOP_LEFT 

左上

ALIGN_TOP 

中央上

ALIGN_TOP_RIGHT 

右上

ALIGN_LEFT 

中央左

ALIGN_CENTER 

中央(デフォルト値)

ALIGN_RIGHT 

中央右

ALIGN_BOTTOM_LEFT 

左下

ALIGN_BOTTOM 

中央下

ALIGN_BOTTOM_RIGHT 

右下

PtlParamWaterMark.h37 行目に定義があります。

◆ PAGE_RANGE

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

列挙値
PAGE_RANGE_ALL 

全ページ

PAGE_RANGE_FIRST 

先頭ページのみ

PAGE_RANGE_LAST 

最終ページのみ

PAGE_RANGE_ODD 

奇数ページ

PAGE_RANGE_EVEN 

偶数ページ

PAGE_RANGE_CUSTOM 

指定ページ(setCustomPageRangeでページ範囲を設定)

PtlParamWaterMark.h60 行目に定義があります。

◆ TYPE_WATERMARK

透かしのタイプ

列挙値
TYPE_COLOR 

TYPE_TEXT 

テキスト

TYPE_PDF 

PDF

TYPE_IMAGE 

画像

PtlParamWaterMark.h27 行目に定義があります。

◆ ZORDER

透かしのZオーダー

列挙値
ZORDER_FRONT 

ページの前面(デフォルト値)

ZORDER_BACK 

ページの背面

PtlParamWaterMark.h52 行目に定義があります。

構築子と解体子

◆ PtlParamWaterMark() [1/2]

PdfTk::PtlParamWaterMark::PtlParamWaterMark ( TYPE_WATERMARK type)

コンストラクタ。

引数
typeタイプ
例外
PtlException

◆ PtlParamWaterMark() [2/2]

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

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

引数
objコピー元オブジェクト。
例外
PtlException

関数詳解

◆ getType()

TYPE_WATERMARK PdfTk::PtlParamWaterMark::getType ( ) const

透かしタイプを取得。

戻り値
透かしタイプ
例外
PtlException

◆ operator=()

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

コピーオペレータ alias copy

引数
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を指定

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

◆ setAlign()

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

透かしの配置を設定。

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

引数
align透かしの配置指定。
例外
PtlException

◆ setAngle()

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

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

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

引数
angle任意の角度。反時計回りが正の値。
例外
PtlException

◆ setCustomPageRange()

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

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

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

◆ setDisplayWaterMark()

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

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

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

引数
bDisplayWaterMarkPDF表示時に透かしを表示する指定。trueなら表示する。
例外
PtlException

◆ setMargin()

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

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

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

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

◆ setName()

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

透かしの名前を設定。

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

◆ setNotInFirst()

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

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

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

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

◆ setNotInLast()

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

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

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

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

◆ setOpacity()

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

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

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

引数
opacity0.0 〜 1.0。0.0が透明、1.0が不透明。
例外
PtlException

◆ setPageRange()

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

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

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

引数
pageRange透かしを入れるページの範囲。
例外
PtlException

◆ setPrintWaterMark()

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

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

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

引数
bPrintWaterMarkPDF印刷時に透かしを印刷する指定。trueなら印刷する。
例外
PtlException

◆ setRect()

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

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

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

引数
rectMM透かしを配置する矩形。
例外
PtlException

◆ setTiling()

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

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

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

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

◆ setZorder()

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

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

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

引数
zorder透かしのZオーダー。
例外
PtlException