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

#include <PtlParamDrawLayer.h>

公開型

enum  ZORDER { ZORDER_FRONT = 1 , ZORDER_BACK = 2 }
enum  SHOW { SHOW_ON = 1 , SHOW_OFF = 2 }

公開メンバ関数

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

詳解

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

PtlParamDrawLayer.h の 20 行目に定義があります。

列挙型メンバ詳解

◆ SHOW

enum PdfTk::PtlParamDrawLayer::SHOW

レイヤーの表示/非表示

列挙値
SHOW_ON 

表示(デフォルト値)

SHOW_OFF 

非表示

PtlParamDrawLayer.h の 34 行目に定義があります。

◆ ZORDER

enum PdfTk::PtlParamDrawLayer::ZORDER

レイヤーのZオーダー

列挙値
ZORDER_FRONT 

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

ZORDER_BACK 

ページの背面

PtlParamDrawLayer.h の 26 行目に定義があります。

構築子と解体子

◆ PtlParamDrawLayer() [1/2]

PdfTk::PtlParamDrawLayer::PtlParamDrawLayer ( )

コンストラクタ

例外
PtlException

◆ PtlParamDrawLayer() [2/2]

PdfTk::PtlParamDrawLayer::PtlParamDrawLayer ( const PtlParamDrawLayer & obj)

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

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

関数詳解

◆ operator=()

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

コピーオペレータ alias copy

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

◆ setAngle()

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

任意の傾きを設定。

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

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

◆ setName()

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

レイヤーの名前を設定。

名前の設定は必須です。

引数
nameレイヤーの名前。
例外
PtlException

◆ setOpacity()

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

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

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

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

◆ setPage()

void PdfTk::PtlParamDrawLayer::setPage ( const PtlPage & page)

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

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

引数
pageレイヤーに使用するPDF文書のページ。
例外
PtlException

◆ setRotate()

void PdfTk::PtlParamDrawLayer::setRotate ( int value)

回転角度を設定。

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

引数
value回転角度（0, 90, 180, 270）
例外
PtlException

◆ setShow()

void PdfTk::PtlParamDrawLayer::setShow ( SHOW show)

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

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

引数
showレイヤーの表示/非表示。SHOW_XXXのいずれか。
例外
PtlException

◆ setZorder()

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

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

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

引数
zorderレイヤーのZオーダー。ZORDER_XXXのいずれか。
例外
PtlException