PdfTk::PtlTextBox Class Reference

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

#include <PtlTextBox.h>

Public Types
enum	MODE { MODE_HORIZONTAL = 0 , MODE_VERTICAL = 1 }
	横書き/縦書き More...

Public Member Functions
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	setOutlineColor (const PtlColor &outlineColor)
	テキストボックスの縁取り色を設定。
void	setBackColor (const PtlColor &bkColor)
	背景色を設定。
void	setOpacity (float opacity)
	不透明度を設定。
void	fitToBBox (bool fit)
	TextBoxのサイズをテキストのBBoxに合わせるかどうかの設定。

Detailed Description

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

Member Enumeration Documentation

MODE

enum PdfTk::PtlTextBox::MODE

横書き/縦書き

Enumerator
MODE_HORIZONTAL	横書き
MODE_VERTICAL	縦書き

Constructor & Destructor Documentation

PtlTextBox() [1/2]

PdfTk::PtlTextBox::PtlTextBox

(

)

コンストラクタ

Exceptions

PtlException

PtlTextBox() [2/2]

PdfTk::PtlTextBox::PtlTextBox

(

const PtlTextBox &

obj

)

コピーコンストラクタ

Parameters

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

Exceptions

PtlException

Member Function Documentation

fitToBBox()

void PdfTk::PtlTextBox::fitToBBox

(

bool

fit

)

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

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

Parameters

fit	trueなら合わせる。

Exceptions

PtlException

operator=()

PtlTextBox & PdfTk::PtlTextBox::operator=

(

const PtlTextBox &

obj

)

コピーオペレータ

Parameters

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

setBackColor()

void PdfTk::PtlTextBox::setBackColor

(

const PtlColor &

bkColor

)

背景色を設定。

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

Parameters

bkColor

背景色指定。

Exceptions

PtlException

setOpacity()

void PdfTk::PtlTextBox::setOpacity

(

float

opacity

)

不透明度を設定。

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

Parameters

opacity

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

Exceptions

PtlException

setOutlineColor()

void PdfTk::PtlTextBox::setOutlineColor

(

const PtlColor &

outlineColor

)

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

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

Parameters

outlineColor

縁取り色指定。

Exceptions

PtlException

setWritingMode()

void PdfTk::PtlTextBox::setWritingMode

(

MODE

mode

)

横書き/縦書きを設定。

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

Parameters

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

Exceptions

PtlException

terminate()

void PdfTk::PtlTextBox::terminate

(

)

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

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

Exceptions

PtlException

writeNL() [1/2]

void PdfTk::PtlTextBox::writeNL

(

)

改行。

改行します。

Exceptions

PtlException

writeNL() [2/2]

void PdfTk::PtlTextBox::writeNL

(

float

size

)

改行。

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

Parameters

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

Exceptions

PtlException

writeString()

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

文字列を出力。

文字列を出力します。

Parameters

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

Exceptions

PtlException

writeStringNL()

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

文字列を出力して改行。

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

Parameters

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

Exceptions

PtlException