PdfTk::PtlTextBox クラス

#include <PtlTextBox.h>

公開型
enum	MODE { MODE_HORIZONTAL = 0 , MODE_VERTICAL = 1 }
enum	OUTLINE_STYLE { OUTLINE_STYLE_SOLID = 1 , OUTLINE_STYLE_DASHED = 2 }

公開メンバ関数
int	getHandle () const
	PtlTextBox ()
	コンストラクタ
	PtlTextBox (const PtlTextBox &obj)
	コピーコンストラクタ
	~PtlTextBox ()
	デストラクタ
PtlTextBox &	operator= (const PtlTextBox &obj)
	コピーオペレータ
void	setWritingMode (MODE mode)
	横書き/縦書きを設定。
void	writeString (const PtlParamString &str, const PtlParamWriteStringTextBox &paramWriteString)
	文字列を出力。
void	writeStringNL (const PtlParamString &str, const PtlParamWriteStringTextBox &paramWriteString)
	文字列を出力して改行。
void	writeNL ()
	改行。
void	writeNL (float size)
	改行。
void	terminate ()
	テキストボックスを終了。
void	setOutlineStyle (OUTLINE_STYLE lineStyle)
	テキストボックスの縁取のスタイルをOUTLINE_STYLEで設定。
void	setOutlineColor (const PtlColor &outlineColor)
	テキストボックスの縁取り色を設定。
void	setBackColor (const PtlColor &bkColor)
	背景色を設定。
void	setOpacity (float opacity)
	不透明度を設定。
void	fitToBBox (bool fit)
	TextBoxのサイズをテキストのBBoxに合わせるかどうかの設定。

詳解

ページに描画されるテキストボックスを表現するクラスです。
テキストボックスをにテキストを書き、テキストボックスをコンテントに配置します。

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

列挙型メンバ詳解

MODE

enum PdfTk::PtlTextBox::MODE

横書き/縦書き

列挙値
MODE_HORIZONTAL	横書き
MODE_VERTICAL	縦書き

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

OUTLINE_STYLE

enum PdfTk::PtlTextBox::OUTLINE_STYLE

線スタイル

列挙値
OUTLINE_STYLE_SOLID	実線
OUTLINE_STYLE_DASHED	破線

PtlTextBox.h の 126 行目に定義があります。

構築子と解体子

PtlTextBox() [1/2]

PdfTk::PtlTextBox::PtlTextBox

(

)

コンストラクタ

例外

PtlException

PtlTextBox() [2/2]

PdfTk::PtlTextBox::PtlTextBox

(

const PtlTextBox &

obj

)

コピーコンストラクタ

引数

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

例外

PtlException

関数詳解

fitToBBox()

void PdfTk::PtlTextBox::fitToBBox

(

bool

fit

)

TextBoxのサイズをテキストのBBoxに合わせるかどうかの設定。

※ 設定しない場合はデフォルト値としてfalseが使用されます。

引数

fit	trueなら合わせる。

例外

PtlException

operator=()

PtlTextBox & PdfTk::PtlTextBox::operator=

(

const PtlTextBox &

obj

)

コピーオペレータ

引数

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

setBackColor()

void PdfTk::PtlTextBox::setBackColor

(

const PtlColor &

bkColor

)

背景色を設定。

※ 設定しない場合は背景色をはありません。

引数

bkColor

背景色指定。

例外

PtlException

setOpacity()

void PdfTk::PtlTextBox::setOpacity

(

float

opacity

)

不透明度を設定。

※ 設定しない場合はデフォルト値として1.0が設定されます。

引数

opacity

0.0 〜 1.0。0.0が透明、1.0が不透明。

例外

PtlException

setOutlineColor()

void PdfTk::PtlTextBox::setOutlineColor

(

const PtlColor &

outlineColor

)

テキストボックスの縁取り色を設定。

※ 設定しない場合は無色です。

引数

outlineColor

縁取り色指定。

例外

PtlException

setOutlineStyle()

void PdfTk::PtlTextBox::setOutlineStyle

(

OUTLINE_STYLE

lineStyle

)

テキストボックスの縁取のスタイルをOUTLINE_STYLEで設定。

※ 設定しない場合はデフォルト値としてOUTLINE_STYLE_SOLIDが設定されます。

引数

lineStyle

線スタイルの指定。

例外

PtlException

setWritingMode()

void PdfTk::PtlTextBox::setWritingMode

(

MODE

mode

)

横書き/縦書きを設定。

横書き/縦書きを設定します。
途中で変更は出来ません。
※ 設定しない場合はデフォルト値としてMODE_HORIZONTALが使用されます。

引数

mode	横書きか縦書き。MODEのいずれか。

例外

PtlException

terminate()

void PdfTk::PtlTextBox::terminate

(

)

テキストボックスを終了。

テキストボックスを終了しページコンテントに書き出します。
この関数を呼ばないとコンテントに書かれないので必ず呼んでください。

例外

PtlException

writeNL() [1/2]

void PdfTk::PtlTextBox::writeNL

(

)

改行。

改行します。

例外

PtlException

writeNL() [2/2]

void PdfTk::PtlTextBox::writeNL

(

float

size

)

改行。

指定サイズで改行します。通常、フォントサイズを指定します。

引数

size	改行サイズ(ポイント)

例外

PtlException

writeString()

void PdfTk::PtlTextBox::writeString	(	const PtlParamString &	str,
		const PtlParamWriteStringTextBox &	paramWriteString )

文字列を出力。

文字列を出力します。

引数

str	文字列。
paramWriteString	文字列出力パラメータ。

例外

PtlException

writeStringNL()

void PdfTk::PtlTextBox::writeStringNL	(	const PtlParamString &	str,
		const PtlParamWriteStringTextBox &	paramWriteString )

文字列を出力して改行。

文字列を出力して改行します。

引数

str	文字列。
paramWriteString	文字列出力パラメータ。

例外

PtlException