PdfTk::PtlEditElement クラス

#include <PtlEditElement.h>

PdfTk::PtlEditElement の継承関係図

公開型
enum	ELEMENT_TYPE {   TYPE_TEXT = 1 , TYPE_IMAGE = 2 , TYPE_PATH = 3 , TYPE_SHADING = 4 ,   TYPE_MCCONTAINER = 5 , TYPE_MCPLACE = 6 , TYPE_FORMXOBJECT = 7 , TYPE_UNKNOWN = 100 }

公開メンバ関数
int	getHandle () const
	PtlEditElement (ELEMENT_TYPE type)
	コンストラクタ
	PtlEditElement (const PtlEditElement &obj)
	コピーコンストラクタ alias copy
virtual	~PtlEditElement ()
	デストラクタ
PtlEditElement &	operator= (const PtlEditElement &obj)
	コピーオペレータ alias copy
ELEMENT_TYPE	getType () const
	エレメントタイプを取得。
PtlTransMatrix	getMatrix () const
	ページ/FormXObjectそれぞれの座標系でのMatrixを取得。
void	setMatrix (const PtlTransMatrix &matrix)
	ページ/FormXObjectそれぞれの座標系でのMatrixを設定。
PtlTransMatrix	getMatrixAtPage () const
	ページ座標系のMatrixを取得。
void	setMatrixAtPage (const PtlTransMatrix &matrix)
	ページ座標系のMatrixを設定。
PtlRect	getBBox ()
	ページ座標系のBBoxを取得。
PtlRect	getClippedBBox ()
	クリッピングされたBBoxを取得。
PtlQuadPoint	getQuadPoint ()
	ページ座標系のQuadPointを取得。
bool	hasClip () const
	クリッピングがあるかどうかを取得。
PtlEditClip	getClip ()
	クリッピングを取得。
void	setClip (const PtlEditClip &clip)
	クリッピングを設定。

詳解

コンテントに描画されるエレメントを表現したクラスです。
すべてのエレメントクラスのベースクラスです。

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

列挙型メンバ詳解

ELEMENT_TYPE

enum PdfTk::PtlEditElement::ELEMENT_TYPE

エレメントのタイプ

列挙値
TYPE_TEXT	テキスト
TYPE_IMAGE	画像
TYPE_PATH	パス
TYPE_SHADING	シェイディング
TYPE_MCCONTAINER	Marked Content(BMC,BDC,EMC)
TYPE_MCPLACE	Marked Content(MP,DP)
TYPE_FORMXOBJECT	FormXObject
TYPE_UNKNOWN	未対応エレメント

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

構築子と解体子

PtlEditElement() [1/2]

PdfTk::PtlEditElement::PtlEditElement

(

ELEMENT_TYPE

type

)

コンストラクタ

引数

type

タイプ

例外

PtlException

PtlEditElement() [2/2]

PdfTk::PtlEditElement::PtlEditElement

(

const PtlEditElement &

obj

)

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

引数

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

例外

PtlException

関数詳解

getBBox()

PtlRect PdfTk::PtlEditElement::getBBox

(

)

ページ座標系のBBoxを取得。

ページコンテント内のElementもFormXObjectコンテント内のElementもページ座標系でのBBoxがPtlOptionの設定に応じて取得されます。

戻り値

Rect ページでのBBox

例外

PtlException

getClip()

PtlEditClip PdfTk::PtlEditElement::getClip

(

)

クリッピングを取得。

hasClipでクリッピングがあるかどうかを確認したうえで使用してください。

戻り値

クリッピング

例外

PtlException

getClippedBBox()

PtlRect PdfTk::PtlEditElement::getClippedBBox

(

)

クリッピングされたBBoxを取得。

クリッピングされている場合、クリッピングされたBBoxを取得します。
ページコンテント内のElementもFormXObjectコンテント内のElementもページ座標系でのBBoxがPtlOptionの設定に応じて取得されます。

戻り値

Rect ページでのBBox

例外

PtlException

getMatrix()

PtlTransMatrix PdfTk::PtlEditElement::getMatrix

(

)

const

ページ/FormXObjectそれぞれの座標系でのMatrixを取得。

ページコンテント内のElementはページのユーザースペース空間座標系でのMatrixが取得されます。
FormXObjectコンテント内のElementはFormXObjectのユーザースペース空間座標系で実Matrixが取得されます。
PtlOptionは全て無視されユーザースペース空間での座標/ポイント単位で取得されます。

戻り値

Matrix ユーザースペース空間でのMatrix

例外

PtlException

getMatrixAtPage()

PtlTransMatrix PdfTk::PtlEditElement::getMatrixAtPage

(

)

const

ページ座標系のMatrixを取得。

ページコンテント内のElementもFormXObjectコンテント内のElementもページ座標系でのMatrixがPtlOptionの設定に応じて取得されます。
PtlOptionのsetCoodでCOOD_VIEWを設定しても、この関数ではその設定は無視されCOOD_USERが設定されているものとして値が取得されます。

戻り値

Matrix ページでのMatrix

例外

PtlException

getQuadPoint()

PtlQuadPoint PdfTk::PtlEditElement::getQuadPoint

(

)

ページ座標系のQuadPointを取得。

ページコンテント内のElementもFormXObjectコンテント内のElementもページ座標系でのQuadPointがPtlOptionの設定に応じて取得されます。

戻り値

QuadPoint ページでのQuadPoint

例外

PtlException

getType()

ELEMENT_TYPE PdfTk::PtlEditElement::getType

(

)

const

エレメントタイプを取得。

戻り値

エレメントタイプ

例外

PtlException

hasClip()

bool PdfTk::PtlEditElement::hasClip

(

)

const

クリッピングがあるかどうかを取得。

戻り値

true: クリッピングがある、false: クリッピングがない。

例外

PtlException

operator=()

PtlEditElement & PdfTk::PtlEditElement::operator=

(

const PtlEditElement &

obj

)

コピーオペレータ alias copy

引数

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

setClip()

void PdfTk::PtlEditElement::setClip

(

const PtlEditClip &

clip

)

クリッピングを設定。

引数

clip

クリッピング

例外

PtlException

setMatrix()

void PdfTk::PtlEditElement::setMatrix

(

const PtlTransMatrix &

matrix

)

ページ/FormXObjectそれぞれの座標系でのMatrixを設定。

ページコンテント内のElementはページのユーザースペース空間座標系でのMatrixを設定します。
FormXObjectコンテント内のElementはFormXObjectのユーザースペース空間座標系で実Matrixを設定します。
PtlOptionは全て無視されます。

引数

matrix

ユーザースペース空間でのMatrix

例外

PtlException

setMatrixAtPage()

void PdfTk::PtlEditElement::setMatrixAtPage

(

const PtlTransMatrix &

matrix

)

ページ座標系のMatrixを設定。

ページコンテント内のElementもFormXObjectコンテント内のElementもページ座標系でのMatrixがPtlOptionの設定に応じて設定されます。
PtlOptionのsetCoodでCOOD_VIEWを設定しても、この関数ではその設定は無視されCOOD_USERが設定されているものとして値が設定されます。

引数

matrix

ページベースでのMatrix

例外

PtlException