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

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

#include <PtlParamWaterMarkPDF.h>

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

Public Member Functions

 PtlParamWaterMarkPDF ()
 コンストラクタ More...
 
 PtlParamWaterMarkPDF (const PtlParamWaterMarkPDF &obj)
 コピーコンストラクタ alias copy More...
 
 ‾PtlParamWaterMarkPDF ()
 デストラクタ
 
PtlParamWaterMarkPDFoperator= (const PtlParamWaterMarkPDF &obj)
 コピーオペレータ alias copy More...
 
void setPage (const PtlPage &page)
 透かしに使用するPDF文書ページを設定。 More...
 
void setScale (float scale)
 透かしの倍率を設定。 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

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

Constructor & Destructor Documentation

◆ PtlParamWaterMarkPDF() [1/2]

PdfTk::PtlParamWaterMarkPDF::PtlParamWaterMarkPDF ( )

コンストラクタ

Exceptions
PtlException

◆ PtlParamWaterMarkPDF() [2/2]

PdfTk::PtlParamWaterMarkPDF::PtlParamWaterMarkPDF ( const PtlParamWaterMarkPDF obj)

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

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

Member Function Documentation

◆ operator=()

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

コピーオペレータ alias copy

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

◆ setPage()

void PdfTk::PtlParamWaterMarkPDF::setPage ( const PtlPage page)

透かしに使用するPDF文書ページを設定。

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

Parameters
page透かしに使用するPDF文書のページ。
Exceptions
PtlException

◆ setScale()

void PdfTk::PtlParamWaterMarkPDF::setScale ( float  scale)

透かしの倍率を設定。

透かしの倍率0は特別な意味を持ちます。
0を指定するとsetRect,setMarginで指定された描画矩形にフィットするよう拡大されます。
設定しない場合はデフォルト値として0.0fが使用されます。

Parameters
scale透かしの倍率(0.0f〜50.0f、0.0f=透かしの配置矩形に合わせる [100%=1.00f] )。
Exceptions
PtlException