PdfTk::PtlParamRestriction クラス

#include <PtlParamRestriction.h>

公開型
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
	PtlParamRestriction ()
	コンストラクタ
	PtlParamRestriction (const PtlParamRestriction &obj)
	コピーコンストラクタ
	~PtlParamRestriction ()
	デストラクタ
PtlParamRestriction &	operator= (const PtlParamRestriction &obj)
	コピーオペレータ
void	appendValidURL (const PtlParamString &url)
	閲覧可能とするURLを追加。
void	setValidTermStart (const PtlDate &start)
	閲覧可能とする期間の開始日を設定。
void	setValidTermEnd (const PtlDate &end)
	閲覧可能とする期間の終了日を設定。
void	setWatermark (const PtlParamWaterMark &paramWM)
	閲覧不可時に表示するウォーターマークを設定。
void	setEnableParamWatermark (bool enableParam)
	閲覧不可時に表示するウォーターマークのパラメータを有効にするかの設定。
void	setPageRange (PAGE_RANGE pageRange)
	閲覧制限を行うページの範囲を設定。
void	setCustomPageRange (const PtlParamString &customPageRange)
	閲覧制限を行うページの範囲の指定を設定。

詳解

PDFの閲覧制限を表現したクラスです。

PtlParamRestriction.h の 21 行目に定義があります。

列挙型メンバ詳解

PAGE_RANGE

enum PdfTk::PtlParamRestriction::PAGE_RANGE

閲覧制限を行うページの範囲

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

PtlParamRestriction.h の 27 行目に定義があります。

構築子と解体子

PtlParamRestriction() [1/2]

PdfTk::PtlParamRestriction::PtlParamRestriction

(

)

コンストラクタ

例外

PtlException

PtlParamRestriction() [2/2]

PdfTk::PtlParamRestriction::PtlParamRestriction

(

const PtlParamRestriction &

obj

)

コピーコンストラクタ

引数

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

例外

PtlException

関数詳解

appendValidURL()

void PdfTk::PtlParamRestriction::appendValidURL

(

const PtlParamString &

url

)

閲覧可能とするURLを追加。

複数URLを閲覧可能としたい場合はこの関数を複数呼ぶことで実現できます。

引数

url	閲覧可能とするURL。

例外

PtlException

operator=()

PtlParamRestriction & PdfTk::PtlParamRestriction::operator=

(

const PtlParamRestriction &

obj

)

コピーオペレータ

引数

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

setCustomPageRange()

void PdfTk::PtlParamRestriction::setCustomPageRange

(

const PtlParamString &

customPageRange

)

閲覧制限を行うページの範囲の指定を設定。

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

引数

customPageRange

閲覧制限を行うページの範囲の指定。

例外

PtlException

setEnableParamWatermark()

void PdfTk::PtlParamRestriction::setEnableParamWatermark

(

bool

enableParam

)

閲覧不可時に表示するウォーターマークのパラメータを有効にするかの設定。

有効にすると、PtlParamWaterMarkに設定したページ範囲、setDisplayWaterMark/setPrintWaterMarkが使用されます。
但し、閲覧制限を設定するページにのみウォーターマークは設定されます。

引数

enableParam

ウォーターマークに設定したパラメータを有効にするか。

例外

PtlException

setPageRange()

void PdfTk::PtlParamRestriction::setPageRange

(

PAGE_RANGE

pageRange

)

閲覧制限を行うページの範囲を設定。

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

引数

pageRange

透かしを入れるページの範囲。PAGE_RANGE_XXXのいずれか。

例外

PtlException

setValidTermEnd()

void PdfTk::PtlParamRestriction::setValidTermEnd

(

const PtlDate &

end

)

閲覧可能とする期間の終了日を設定。

引数

end

終了日。

例外

PtlException

setValidTermStart()

void PdfTk::PtlParamRestriction::setValidTermStart

(

const PtlDate &

start

)

閲覧可能とする期間の開始日を設定。

引数

start

開始日。

例外

PtlException

setWatermark()

void PdfTk::PtlParamRestriction::setWatermark

(

const PtlParamWaterMark &

paramWM

)

閲覧不可時に表示するウォーターマークを設定。

設定しない場合は閲覧不可時に何も表示されません。
設定しても、PtlParamWaterMarkに設定したページ範囲は無視され、閲覧不可のページ全てに透かしは設定されます。
閲覧不可のページの中で透かしを設定するページを有効にしたい場合は、setEnableParamWatermarkでtrueを設定して下さい。

引数

paramWM

ウォーターマーク。

例外

PtlException