PdfTk::PtlParamRestriction Class Reference

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

#include <PtlParamRestriction.h>

Public Types
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...

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

Detailed Description

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

Member Enumeration Documentation

PAGE_RANGE

enum PdfTk::PtlParamRestriction::PAGE_RANGE

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

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

Constructor & Destructor Documentation

PtlParamRestriction() [1/2]

PdfTk::PtlParamRestriction::PtlParamRestriction

(

)

コンストラクタ

Exceptions

PtlException

PtlParamRestriction() [2/2]

PdfTk::PtlParamRestriction::PtlParamRestriction

(

const PtlParamRestriction &

obj

)

コピーコンストラクタ

Parameters

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

Exceptions

PtlException

Member Function Documentation

appendValidURL()

void PdfTk::PtlParamRestriction::appendValidURL

(

const PtlParamString &

url

)

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

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

Parameters

url	閲覧可能とするURL。

Exceptions

PtlException

operator=()

PtlParamRestriction& PdfTk::PtlParamRestriction::operator=

(

const PtlParamRestriction &

obj

)

コピーオペレータ

Parameters

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

setCustomPageRange()

void PdfTk::PtlParamRestriction::setCustomPageRange

(

const PtlParamString &

customPageRange

)

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

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

Parameters

customPageRange

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

Exceptions

PtlException

setEnableParamWatermark()

void PdfTk::PtlParamRestriction::setEnableParamWatermark

(

bool

enableParam

)

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

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

Parameters

enableParam

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

Exceptions

PtlException

setPageRange()

void PdfTk::PtlParamRestriction::setPageRange

(

PAGE_RANGE

pageRange

)

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

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

Parameters

pageRange

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

Exceptions

PtlException

setValidTermEnd()

void PdfTk::PtlParamRestriction::setValidTermEnd

(

const PtlDate &

end

)

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

Parameters

end

終了日。

Exceptions

PtlException

setValidTermStart()

void PdfTk::PtlParamRestriction::setValidTermStart

(

const PtlDate &

start

)

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

Parameters

start

開始日。

Exceptions

PtlException

setWatermark()

void PdfTk::PtlParamRestriction::setWatermark

(

const PtlParamWaterMark &

paramWM

)

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

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

Parameters

paramWM

ウォーターマーク。

Exceptions

PtlException