#include <PtlAnnotTextMarkup.h>

PdfTk::PtlAnnotTextMarkup の継承関係図

[凡例]

PdfTk::PtlAnnotTextMarkup 連携図

[凡例]

公開メンバ関数
	PtlAnnotTextMarkup (int type)
	コンストラクタ
	PtlAnnotTextMarkup (ANNOT_TYPE type)
	コンストラクタ
	PtlAnnotTextMarkup (const PtlAnnotTextMarkup &obj)
	コピーコンストラクタ alias copy
virtual	~PtlAnnotTextMarkup ()
	デストラクタ
PtlAnnotTextMarkup &	operator= (const PtlAnnotTextMarkup &obj)
	コピーオペレータ alias copy
PtlQuadPoints &	getQuadPoints ()
	テキストを囲むQuadPointのコンテナを取得。
void	setVerticalDirection (bool vert)
	テキストを縦書き方向に囲むかどうかを設定。
基底クラス 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 ()
	注釈名を取得。

その他の継承メンバ
基底クラス 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 }

詳解

PDFのテキストマークアップ注釈を表現したクラスです。
すべてのテキストマークアップ注釈クラスのベースクラスです。

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

構築子と解体子

◆ PtlAnnotTextMarkup() [1/3]

PdfTk::PtlAnnotTextMarkup::PtlAnnotTextMarkup ( int type )

コンストラクタ

引数

type	タイプ(ANNOT_TYPE)

例外

PtlException

◆ PtlAnnotTextMarkup() [2/3]

PdfTk::PtlAnnotTextMarkup::PtlAnnotTextMarkup ( ANNOT_TYPE type )

コンストラクタ

引数

type タイプ

例外

PtlException

◆ PtlAnnotTextMarkup() [3/3]

PdfTk::PtlAnnotTextMarkup::PtlAnnotTextMarkup ( const PtlAnnotTextMarkup & obj )

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

引数

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

例外

PtlException

関数詳解

◆ getQuadPoints()

PtlQuadPoints & PdfTk::PtlAnnotTextMarkup::getQuadPoints ( )

テキストを囲むQuadPointのコンテナを取得。

※ 注意事項
PtlAnnotTextMarkupはPtlQuadPointsにQuadPointを追加したら自動的に矩形座標は設定されますので
基底クラスPtlAnnotのsetRect関数で矩形座標を設定しないでください。

戻り値: テキストを囲むQuadPointのコンテナ。

例外

PtlException

◆ operator=()

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

コピーオペレータ alias copy

引数

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

例外

PtlException

◆ setVerticalDirection()

void PdfTk::PtlAnnotTextMarkup::setVerticalDirection ( bool vert )

テキストを縦書き方向に囲むかどうかを設定。

設定しない場合はデフォルト値としてfalse(横方向に囲む)が使用されます。
この設定はハイライト注釈の場合、外観の膨らみの位置に影響します。

引数

vert	テキストを縦方向に囲むかどうか。trueなら縦方向に配置。

例外

PtlException

公開メンバ関数

その他の継承メンバ

詳解

構築子と解体子

◆ PtlAnnotTextMarkup() [1/3]

◆ PtlAnnotTextMarkup() [2/3]

◆ PtlAnnotTextMarkup() [3/3]

関数詳解

◆ getQuadPoints()

◆ operator=()

◆ setVerticalDirection()