PdfTk::PtlAnnotLink Class Reference

PDFのリンク注釈を表現したクラスです。 More...

#include <PtlAnnotLink.h>

Inheritance diagram for PdfTk::PtlAnnotLink:

Collaboration diagram for PdfTk::PtlAnnotLink:

Public Types
enum	HIGHLIGHTING_MODE { HIGHLIGHTING_MODE_NONE = 1 , HIGHLIGHTING_MODE_INVERT = 2 , HIGHLIGHTING_MODE_OUTLINE = 3 , HIGHLIGHTING_MODE_PUSH = 4 }
	ハイライトモード ※ ハイライトモードは注釈のアクティブ領域内でマウスボタンが押されるか、押し続けられるときに用いる視覚効果です。 More...
Public Types inherited from PdfTk::PtlAnnot
enum	ANNOT_TYPE {   TYPE_TEXT = 1 , TYPE_LINK = 2 , TYPE_FREE_TEXT = 3 , TYPE_LINE = 4 ,   TYPE_SQUARE = 5 , TYPE_CIRCLE = 6 , TYPE_POLYGON = 7 , TYPE_POLYLINE = 8 ,   TYPE_HIGHLIGHT = 9 , TYPE_UNDERLINE = 10 , TYPE_SQUIGGLY = 11 , TYPE_STRIKEOUT = 12 ,   TYPE_STAMP = 13 , TYPE_CARET = 14 , TYPE_INK = 15 , TYPE_POPUP = 16 ,   TYPE_FILE_ATTACHMENT = 17 , TYPE_SOUND = 18 , TYPE_MOVIE = 19 , TYPE_WIDGET = 20 ,   TYPE_SCREEN = 21 , TYPE_PRINTER_MARK = 22 , TYPE_TRAP_NETWORK = 23 , TYPE_WATERMARK = 24 ,   TYPE_3D = 25 , TYPE_REDACT = 26 , TYPE_PROJECTION = 27 , TYPE_RICHMEDIA = 28 ,   TYPE_UNKNOWN = 100 }
	注釈のタイプ More...
enum	ANNOT_FLAGS {   FLAG_INVISIBLE = 0x00000001 , FLAG_HIDDEN = 0x00000002 , FLAG_PRINT = 0x00000004 , FLAG_NOZOOM = 0x00000008 ,   FLAG_NOROTATE = 0x00000010 , FLAG_NOVIEW = 0x00000020 , FLAG_READONLY = 0x00000040 , FLAG_LOCKED = 0x00000080 ,   FLAG_TOGGLE_NOVIEW = 0x00000100 , FLAG_LOCKED_CONTENTS = 0x00000200 }
	注釈フラグ。 More...
enum	BORDER_STYLE {   BORDER_SOLID = 1 , BORDER_DASHED = 2 , BORDER_BEVELED = 3 , BORDER_INSET = 4 ,   BORDER_UNDERLINE = 5 }
	境界線スタイル More...
enum	BORDER_LINE_WIDTH { BORDER_WIDTH_NONE = 0 , BORDER_WIDTH_THIN = 1 , BORDER_WIDTH_MIDDLE = 2 , BORDER_WIDTH_THICK = 3 }
	境界線幅 More...

Public Member Functions
	PtlAnnotLink ()
	コンストラクタ
	PtlAnnotLink (const PtlAnnotLink &obj)
	コピーコンストラクタ alias copy
	‾PtlAnnotLink ()
	デストラクタ
PtlAnnotLink &	operator= (const PtlAnnotLink &obj)
	コピーオペレータ alias copy
HIGHLIGHTING_MODE	getHighlightMode () const
	ハイライトモードを取得。
void	setHighlightMode (HIGHLIGHTING_MODE mode)
	ハイライトモードを設定。
PtlAction &	getAction () const
	アクションを取得。
void	setAction (const PtlAction &action)
	アクションを設定。
void	removeAction ()
	アクションを削除。
PtlDest &	getDest () const
	宛先を取得。
void	setDest (const PtlDest &dest)
	宛先を設定。
Public Member Functions inherited from PdfTk::PtlAnnot
int	getHandle () const
	PtlAnnot (ANNOT_TYPE type)
	コンストラクタ
	PtlAnnot (const PtlAnnot &obj)
	コピーコンストラクタ alias copy
virtual	‾PtlAnnot ()
	デストラクタ
PtlAnnot &	operator= (const PtlAnnot &obj)
	コピーオペレータ alias copy
ANNOT_TYPE	getType () const
	注釈タイプを取得。
bool	isMarkup () const
	マークアップ注釈か否かを取得。
PtlRect	getRect ()
	矩形座標を取得。
void	setRect (const PtlRect &rectMM)
	矩形座標を設定。
PtlParamString	getTextContents ()
	内容を取得。
void	setTextContents (const PtlParamString &contents)
	内容を設定。
PtlDate	getDate ()
	日時を取得。
void	setDate (const PtlDate &date)
	日時を設定。
int	getAnnotFlags ()
	注釈フラグを取得。
void	setAnnotFlags (int flag)
	注釈フラグを設定。
const PtlColor &	getColor ()
	色を取得。
void	setColor (const PtlColorDeviceRGB &color)
	色を設定。
const PtlColor &	getInteriorColor ()
	内部色を取得。
void	setInteriorColor (const PtlColorDeviceRGB &color)
	内部色を設定。
BORDER_STYLE	getBorderStyle ()
	境界線スタイルを取得。
void	setBorderStyle (BORDER_STYLE style)
	境界線スタイルを設定。
BORDER_LINE_WIDTH	getBorderWidth ()
	境界線幅をBORDER_LINE_WIDTHで取得。
void	setBorderWidth (BORDER_LINE_WIDTH width)
	境界線幅をBORDER_LINE_WIDTHで設定。
float	getBorderWidthNative ()
	注釈に設定してある境界線幅を直接取得。
void	setBorderWidthNative (float width)
	注釈の境界線幅を数値で直接設定。

Detailed Description

PDFのリンク注釈を表現したクラスです。

Member Enumeration Documentation

HIGHLIGHTING_MODE

enum PdfTk::PtlAnnotLink::HIGHLIGHTING_MODE

ハイライトモード
※ ハイライトモードは注釈のアクティブ領域内でマウスボタンが押されるか、押し続けられるときに用いる視覚効果です。

Enumerator
HIGHLIGHTING_MODE_NONE	(None)ハイライトなし
HIGHLIGHTING_MODE_INVERT	(Invert)注釈矩形を反転
HIGHLIGHTING_MODE_OUTLINE	Outline)注釈の境界線を反転
HIGHLIGHTING_MODE_PUSH	(Push)ページの下に押し込まれたかのように注釈を表示

Constructor & Destructor Documentation

PtlAnnotLink() [1/2]

PdfTk::PtlAnnotLink::PtlAnnotLink

(

)

コンストラクタ

Exceptions

PtlException

PtlAnnotLink() [2/2]

PdfTk::PtlAnnotLink::PtlAnnotLink

(

const PtlAnnotLink &

obj

)

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

Parameters

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

Exceptions

PtlException

Member Function Documentation

getAction()

PtlAction & PdfTk::PtlAnnotLink::getAction

(

)

const

アクションを取得。

PtlActionを取得後、タイプを確認の上使用して下さい。

Returns

アクション

Exceptions

PtlException

getDest()

PtlDest & PdfTk::PtlAnnotLink::getDest

(

)

const

宛先を取得。

PtlDestを取得後、タイプを確認の上使用して下さい。
GoToRの宛先は取得されません。GoToRの宛先はActionGoToRから取得して下さい。

Returns

宛先

Exceptions

PtlException

getHighlightMode()

HIGHLIGHTING_MODE PdfTk::PtlAnnotLink::getHighlightMode

(

)

const

ハイライトモードを取得。

Returns

ハイライトモード。

Exceptions

PtlException

operator=()

PtlAnnotLink & PdfTk::PtlAnnotLink::operator=

(

const PtlAnnotLink &

obj

)

コピーオペレータ alias copy

Parameters

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

Exceptions

PtlException

removeAction()

void PdfTk::PtlAnnotLink::removeAction

(

)

アクションを削除。

Exceptions

PtlException

setAction()

void PdfTk::PtlAnnotLink::setAction

(

const PtlAction &

action

)

アクションを設定。

同時にsetDestを使用すると後に設定したほうが反映されます。

Parameters

action

アクション

Exceptions

PtlException

setDest()

void PdfTk::PtlAnnotLink::setDest

(

const PtlDest &

dest

)

宛先を設定。

同時にsetActionを使用すると後に設定したほうが反映されます。

Parameters

dest

宛先

Exceptions

PtlException

setHighlightMode()

void PdfTk::PtlAnnotLink::setHighlightMode

(

HIGHLIGHTING_MODE

mode

)

ハイライトモードを設定。

Parameters

mode

ハイライトモード。

Exceptions

PtlException