#include <PtlAnnotLine.h>

PdfTk::PtlAnnotLine の継承関係図

[凡例]

PdfTk::PtlAnnotLine 連携図

[凡例]

公開型
enum	LINE_ENDING_STYLE { STYLE_NONE = 0 , STYLE_SQUARE = 1 , STYLE_CIRCLE = 2 , STYLE_DIAMOND = 3 , STYLE_OPEN_ARROW = 4 , STYLE_CLOSED_ARROW = 5 , STYLE_BUTT = 6 , STYLE_R_OPEN_ARROW = 7 , STYLE_R_CLOSED_ARROW = 8 , STYLE_SLASH = 9 }
enum	CAPTION_POSITION { POSITION_INLINE = 0 , POSITION_TOP = 1 }
基底クラス 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 }
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 }
enum	BORDER_STYLE { BORDER_SOLID = 1 , BORDER_DASHED = 2 , BORDER_BEVELED = 3 , BORDER_INSET = 4 , BORDER_UNDERLINE = 5 }
enum	BORDER_LINE_WIDTH { BORDER_WIDTH_NONE = 0 , BORDER_WIDTH_THIN = 1 , BORDER_WIDTH_MIDDLE = 2 , BORDER_WIDTH_THICK = 3 }

公開メンバ関数
	PtlAnnotLine ()
	コンストラクタ
	PtlAnnotLine (const PtlAnnotLine &obj)
	コピーコンストラクタ alias copy
	~PtlAnnotLine ()
	デストラクタ
PtlAnnotLine &	operator= (const PtlAnnotLine &obj)
	コピーオペレータ alias copy
void	setStartPoint (PtlPoint point)
	注釈の開始座標を設定。
PtlPoint	getStartPoint () const
	注釈の開始座標を取得。
void	setEndPoint (PtlPoint point)
	注釈の終了座標を設定。
PtlPoint	getEndPoint () const
	注釈の終了座標を取得。
void	setLineStartPointStyle (LINE_ENDING_STYLE style)
	開始座標の線端のスタイルを設定する。デフォルトはSTYLE_NONE。
LINE_ENDING_STYLE	getLineStartPointStyle () const
	開始座標の線端のスタイルを取得。
void	setLineEndPointStyle (LINE_ENDING_STYLE style)
	終了座標の線端のスタイルを設定する。デフォルトはSTYLE_NONE。
LINE_ENDING_STYLE	getLineEndPointStyle () const
	終了座標の線端のスタイルを取得。
void	setLeaderLinesLength (float length)
	線端から垂直に伸びる引き出し線の長さを設定する。負の値も設定可能。
float	getLeaderLinesLength () const
	線端から垂直に伸びる引き出し線の長さを取得。
void	setExtensionLeaderLines (float length)
	引き出し線と逆側に伸びる線の長さを設定する。正の値のみ設定可能。
float	getExtensionLeaderLines () const
	引き出し線と逆側に伸びる線の長さを取得。
void	setLeaderLinesOffset (float value)
	引き出し線オフセットを設定する。正の値のみ設定可能。
float	getLeaderLinesOffset () const
	引き出し線オフセットを取得。
void	setViewCaption (bool view)
	キャプションを表示するかどうかを設定する。
bool	getViewCaption () const
	キャプションを表示するかどうかを取得。
void	setHorizontalOffset (float value)
	キャプションの表示位置の水平方向のオフセットを設定します。正の値は右へのオフセットを示し、負の値は左へのオフセットを示します。デフォルトは0.0。
float	getHorizontalOffset () const
	キャプションの表示位置の水平方向のオフセットを取得。
void	setVerticalOffset (float value)
	キャプションの表示位置の垂直方向のオフセットを設定します。正の値は上へのオフセットを示し、負の値は下へのオフセットを示します。デフォルトは0.0。
float	getVerticalOffset () const
	キャプションの表示位置の垂直方向のオフセットを取得。
void	setCaptionPosition (CAPTION_POSITION position)
	キャプションの表示位置を設定します。デフォルトはPOSITION_INLINE。
CAPTION_POSITION	getCaptionPosition () const
	キャプションの表示位置を取得。
基底クラス PdfTk::PtlAnnotMarkup に属する継承公開メンバ関数
	PtlAnnotMarkup (ANNOT_TYPE type)
	コンストラクタ
	PtlAnnotMarkup (const PtlAnnotMarkup &obj)
	コピーコンストラクタ alias copy
virtual	~PtlAnnotMarkup ()
	デストラクタ
PtlAnnotMarkup &	operator= (const PtlAnnotMarkup &obj)
	コピーオペレータ alias copy
const PtlParamString &	getMarkUpTitle ()
	ポップアップウィンドウのタイトル文字列を取得。
void	setMarkUpTitle (const PtlParamString &title)
	ポップアップウィンドウのタイトル文字列を設定。
const PtlParamString &	getMarkUpSubj ()
	サブジェクトの短い説明を取得。
void	setMarkUpSubj (const PtlParamString &subj)
	サブジェクトの短い説明を設定。
PtlDate	getMarkUpDate () const
	注釈生成日時を取得。
void	setMarkUpDate (const PtlDate &date)
	注釈生成日時を設定。
float	getMarkUpCA () const
	不透明度を取得。
void	setMarkUpCA (float ca)
	不透明度を設定。
bool	hasAnnotPopup () const
	ポップアップ注釈を持つか否かを取得。
PtlAnnotPopup &	getAnnotPopup ()
	ポップアップ注釈を取得。
void	setAnnotPopUp (PtlAnnotPopup &popup)
	ポップアップ注釈を設定。
基底クラス 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)
	矩形座標を設定。
const 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 PtlColor &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)
	注釈の境界線幅を数値で直接設定。
const PtlParamString &	getAnnotationName ()
	注釈名を取得。

詳解

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

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

列挙型メンバ詳解

◆ CAPTION_POSITION

enum PdfTk::PtlAnnotLine::CAPTION_POSITION

キャプションの表示位置

列挙値
POSITION_INLINE	線の中
POSITION_TOP	線の上

PtlAnnotLine.h の 43 行目に定義があります。

◆ LINE_ENDING_STYLE

enum PdfTk::PtlAnnotLine::LINE_ENDING_STYLE

線端のスタイル

列挙値
STYLE_NONE	なし
STYLE_SQUARE	四角
STYLE_CIRCLE	丸
STYLE_DIAMOND	ダイヤモンド
STYLE_OPEN_ARROW	矢印
STYLE_CLOSED_ARROW	矢印(三角形)
STYLE_BUTT	線に垂直な短線
STYLE_R_OPEN_ARROW	矢印(逆向き)
STYLE_R_CLOSED_ARROW	矢印(逆三角形)
STYLE_SLASH	線に30度傾いた短線

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

構築子と解体子

◆ PtlAnnotLine() [1/2]

PdfTk::PtlAnnotLine::PtlAnnotLine ( )

コンストラクタ

例外

PtlException

◆ PtlAnnotLine() [2/2]

PdfTk::PtlAnnotLine::PtlAnnotLine ( const PtlAnnotLine & obj )

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

引数

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

例外

PtlException

関数詳解

◆ getCaptionPosition()

CAPTION_POSITION PdfTk::PtlAnnotLine::getCaptionPosition ( ) const

キャプションの表示位置を取得。

戻り値: 表示位置。

例外

PtlException

◆ getEndPoint()

PtlPoint PdfTk::PtlAnnotLine::getEndPoint ( ) const

注釈の終了座標を取得。

戻り値: 注釈の終了座標。

例外

PtlException

◆ getExtensionLeaderLines()

float PdfTk::PtlAnnotLine::getExtensionLeaderLines ( ) const

引き出し線と逆側に伸びる線の長さを取得。

戻り値: 引き出し線と逆側に伸びる線の長さ。

例外

PtlException

◆ getHorizontalOffset()

float PdfTk::PtlAnnotLine::getHorizontalOffset ( ) const

キャプションの表示位置の水平方向のオフセットを取得。

戻り値: 水平方向オフセット。

例外

PtlException

◆ getLeaderLinesLength()

float PdfTk::PtlAnnotLine::getLeaderLinesLength ( ) const

線端から垂直に伸びる引き出し線の長さを取得。

戻り値: 引き出し線の長さ。

例外

PtlException

◆ getLeaderLinesOffset()

float PdfTk::PtlAnnotLine::getLeaderLinesOffset ( ) const

引き出し線オフセットを取得。

戻り値: 引き出し線オフセット。

例外

PtlException

◆ getLineEndPointStyle()

LINE_ENDING_STYLE PdfTk::PtlAnnotLine::getLineEndPointStyle ( ) const

終了座標の線端のスタイルを取得。

戻り値: 終了座標の線端のスタイル。

例外

PtlException

◆ getLineStartPointStyle()

LINE_ENDING_STYLE PdfTk::PtlAnnotLine::getLineStartPointStyle ( ) const

開始座標の線端のスタイルを取得。

戻り値: 開始座標の線端のスタイル。

例外

PtlException

◆ getStartPoint()

PtlPoint PdfTk::PtlAnnotLine::getStartPoint ( ) const

注釈の開始座標を取得。

戻り値: 注釈の開始座標。

例外

PtlException

◆ getVerticalOffset()

float PdfTk::PtlAnnotLine::getVerticalOffset ( ) const

キャプションの表示位置の垂直方向のオフセットを取得。

戻り値: 垂直方向オフセット。

例外

PtlException

◆ getViewCaption()

bool PdfTk::PtlAnnotLine::getViewCaption ( ) const

キャプションを表示するかどうかを取得。

戻り値: キャプションを表示するかどうか。 true:表示 false:非表示

例外

PtlException

◆ operator=()

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

コピーオペレータ alias copy

引数

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

例外

PtlException

◆ setCaptionPosition()

void PdfTk::PtlAnnotLine::setCaptionPosition ( CAPTION_POSITION position )

キャプションの表示位置を設定します。デフォルトはPOSITION_INLINE。

引数

position 表示位置。

例外

PtlException

◆ setEndPoint()

void PdfTk::PtlAnnotLine::setEndPoint ( PtlPoint point )

注釈の終了座標を設定。

引数

point 終了座標。

例外

PtlException

◆ setExtensionLeaderLines()

void PdfTk::PtlAnnotLine::setExtensionLeaderLines ( float length )

引き出し線と逆側に伸びる線の長さを設定する。正の値のみ設定可能。

引数

length 引き出し線と逆側に伸びる線の長さ。

例外

PtlException

◆ setHorizontalOffset()

void PdfTk::PtlAnnotLine::setHorizontalOffset ( float value )

キャプションの表示位置の水平方向のオフセットを設定します。正の値は右へのオフセットを示し、負の値は左へのオフセットを示します。デフォルトは0.0。

引数

value 水平方向オフセット。

例外

PtlException

◆ setLeaderLinesLength()

void PdfTk::PtlAnnotLine::setLeaderLinesLength ( float length )

線端から垂直に伸びる引き出し線の長さを設定する。負の値も設定可能。

引数

length 引き出し線の長さ。

例外

PtlException

◆ setLeaderLinesOffset()

void PdfTk::PtlAnnotLine::setLeaderLinesOffset ( float value )

引き出し線オフセットを設定する。正の値のみ設定可能。

引数

value 引き出し線オフセット。

例外

PtlException

◆ setLineEndPointStyle()

void PdfTk::PtlAnnotLine::setLineEndPointStyle ( LINE_ENDING_STYLE style )

終了座標の線端のスタイルを設定する。デフォルトはSTYLE_NONE。

引数

style 線端スタイル。

例外

PtlException

◆ setLineStartPointStyle()

void PdfTk::PtlAnnotLine::setLineStartPointStyle ( LINE_ENDING_STYLE style )

開始座標の線端のスタイルを設定する。デフォルトはSTYLE_NONE。

引数

style 線端スタイル。

例外

PtlException

◆ setStartPoint()

void PdfTk::PtlAnnotLine::setStartPoint ( PtlPoint point )

注釈の開始座標を設定。

引数

point 開始座標。

例外

PtlException

◆ setVerticalOffset()

void PdfTk::PtlAnnotLine::setVerticalOffset ( float value )

キャプションの表示位置の垂直方向のオフセットを設定します。正の値は上へのオフセットを示し、負の値は下へのオフセットを示します。デフォルトは0.0。

引数

value 垂直方向オフセット。

例外

PtlException

◆ setViewCaption()

void PdfTk::PtlAnnotLine::setViewCaption ( bool view )

キャプションを表示するかどうかを設定する。

引数

view	キャプションを表示するかどうか。 true:表示 false:非表示デフォルトはfalse;

例外

PtlException

公開型

公開メンバ関数

詳解

列挙型メンバ詳解

◆ CAPTION_POSITION

◆ LINE_ENDING_STYLE

構築子と解体子

◆ PtlAnnotLine() [1/2]

◆ PtlAnnotLine() [2/2]

関数詳解

◆ getCaptionPosition()

◆ getEndPoint()

◆ getExtensionLeaderLines()

◆ getHorizontalOffset()

◆ getLeaderLinesLength()

◆ getLeaderLinesOffset()

◆ getLineEndPointStyle()

◆ getLineStartPointStyle()

◆ getStartPoint()

◆ getVerticalOffset()

◆ getViewCaption()

◆ operator=()

◆ setCaptionPosition()

◆ setEndPoint()

◆ setExtensionLeaderLines()

◆ setHorizontalOffset()

◆ setLeaderLinesLength()

◆ setLeaderLinesOffset()

◆ setLineEndPointStyle()

◆ setLineStartPointStyle()

◆ setStartPoint()

◆ setVerticalOffset()

◆ setViewCaption()