PDFTool  6.0
Public Member Functions | List of all members
PdfTk::PtlParamWaterMarkText Class Reference

文字列を透かしに使うパラメータクラスです。
ベースクラスPtlParamWaterMarkへの設定も忘れずに行ってください。 More...

#include <PtlParamWaterMarkText.h>

Inheritance diagram for PdfTk::PtlParamWaterMarkText:
Inheritance graph
[legend]
Collaboration diagram for PdfTk::PtlParamWaterMarkText:
Collaboration graph
[legend]

Public Member Functions

 PtlParamWaterMarkText ()
 コンストラクタ More...
 
 PtlParamWaterMarkText (const PtlParamWaterMarkText &obj)
 コピーコンストラクタ alias copy More...
 
 ‾PtlParamWaterMarkText ()
 デストラクタ
 
PtlParamWaterMarkTextoperator= (const PtlParamWaterMarkText &obj)
 コピーオペレータ alias copy More...
 
void setString (const PtlParamString &inParam)
 透かしに指定する文字列を設定。 More...
 
void setFont (const PtlParamFont &font)
 透かしに指定するフォントを設定。 More...
 
void setTextColor (const PtlColor &textlColor)
 透かしの文字に指定する色を設定。 More...
 
void setOutlineColor (const PtlColor &strokeColor)
 透かしの文字の縁取りに指定する色を設定。 More...
 
void setWriteDiagonal (bool writeDiagonal)
 透かしのテキストを対角線上に配置するか否かを設定。 More...
 
void setTextAngle (float angle)
 透かしのテキストを任意の角度で配置する角度を設定。 More...
 
- Public Member Functions inherited from PdfTk::PtlParamWaterMark
int getHandle () const
 
 PtlParamWaterMark (TYPE_WATERMARK type)
 コンストラクタ。 More...
 
 PtlParamWaterMark (const PtlParamWaterMark &obj)
 コピーコンストラクタ alias copy More...
 
virtual ‾PtlParamWaterMark ()
 デストラクタ
 
PtlParamWaterMarkoperator= (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...
 

Additional Inherited Members

- Public Types inherited from PdfTk::PtlParamWaterMark
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...
 

Detailed Description

文字列を透かしに使うパラメータクラスです。
ベースクラスPtlParamWaterMarkへの設定も忘れずに行ってください。

Constructor & Destructor Documentation

◆ PtlParamWaterMarkText() [1/2]

PdfTk::PtlParamWaterMarkText::PtlParamWaterMarkText ( )

コンストラクタ

Exceptions
PtlException

◆ PtlParamWaterMarkText() [2/2]

PdfTk::PtlParamWaterMarkText::PtlParamWaterMarkText ( const PtlParamWaterMarkText obj)

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

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

Member Function Documentation

◆ operator=()

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

コピーオペレータ alias copy

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

◆ setFont()

void PdfTk::PtlParamWaterMarkText::setFont ( const PtlParamFont font)

透かしに指定するフォントを設定。

Parameters
font透かしに指定するフォント。
Exceptions
PtlException

◆ setOutlineColor()

void PdfTk::PtlParamWaterMarkText::setOutlineColor ( const PtlColor strokeColor)

透かしの文字の縁取りに指定する色を設定。

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

Parameters
strokeColor透かし文字の縁取りに指定する色。
Exceptions
PtlException

◆ setString()

void PdfTk::PtlParamWaterMarkText::setString ( const PtlParamString inParam)

透かしに指定する文字列を設定。

Parameters
inParam透かしに指定する文字列。
Exceptions
PtlException

◆ setTextAngle()

void PdfTk::PtlParamWaterMarkText::setTextAngle ( float  angle)

透かしのテキストを任意の角度で配置する角度を設定。

テキスト配置の回転を度で設定します。反時計回りが正の値。
setTilingにtrueを設定した場合、角度が45度の倍数でないとタイリング配置されたテキストとテキストの間にすき間ができます。
setWriteDiagonalと同時に使用するとsetWriteDiagonalが優先されます。

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

◆ setTextColor()

void PdfTk::PtlParamWaterMarkText::setTextColor ( const PtlColor textlColor)

透かしの文字に指定する色を設定。

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

Parameters
textlColor透かし文字に指定する色。
Exceptions
PtlException

◆ setWriteDiagonal()

void PdfTk::PtlParamWaterMarkText::setWriteDiagonal ( bool  writeDiagonal)

透かしのテキストを対角線上に配置するか否かを設定。

setTextAngleと同時に使用するとsetWriteDiagonalが優先されます。
対角線上に配置するようにtrueを設定してもsetTilingにtrueを設定した場合はこの設定は無視されます。
設定しない場合はデフォルト値としてfalseが使用されます。

Parameters
writeDiagonal透かしのテキストを対角線上に配置する。
Exceptions
PtlException