PdfTk::PtlParamWriteStringTextBox Class Reference

TextBoxに使うパラメータクラスです。
ベースクラスPtlParamWriteStringへの設定も忘れずに行ってください。 More...

#include <PtlParamWriteStringTextBox.h>

Inheritance diagram for PdfTk::PtlParamWriteStringTextBox:

Collaboration diagram for PdfTk::PtlParamWriteStringTextBox:

Public Types
enum	FORMAT_TYPE { FORM_NORMAL = 0 , FORM_SUP = 1 , FORM_SUB = 2 , FORM_CHEM = 3 }
	フォーマットタイプ More...

Public Member Functions
	PtlParamWriteStringTextBox ()
	コンストラクタ
	PtlParamWriteStringTextBox (const PtlParamWriteStringTextBox &obj)
	コピーコンストラクタ alias copy
	‾PtlParamWriteStringTextBox ()
	デストラクタ
PtlParamWriteStringTextBox &	operator= (const PtlParamWriteStringTextBox &obj)
	コピーオペレータ alias copy
void	setFormat (FORMAT_TYPE format)
	フォーマットの設定。
void	setBackColor (const PtlColor &bkColor)
	背景色を設定。
void	setUnderline (bool underline)
	下線を引くか引かないかの設定。
void	setStrikeOut (bool strikeOut)
	取り消し線を引くか引かないかの設定。
void	setLineSpacing (float spacing)
	行間の設定。
void	setCharSpacing (float spacing)
	文字間の設定。
Public Member Functions inherited from PdfTk::PtlParamWriteString
int	getHandle () const
	PtlParamWriteString ()
	コンストラクタ
	PtlParamWriteString (const PtlParamWriteString &obj)
	コピーコンストラクタ
	‾PtlParamWriteString ()
	デストラクタ
PtlParamWriteString &	operator= (const PtlParamWriteString &obj)
	コピーオペレータ
void	setFont (const PtlParamFont &font)
	フォントの設定。
void	setTextColor (const PtlColor &textColor)
	文字色を設定。
void	setOutlineColor (const PtlColor &outlineColor)
	文字の縁取り色を設定。
void	setOpacity (float opacity)
	不透明度を設定。

Additional Inherited Members
Protected Attributes inherited from PdfTk::PtlParamWriteString
int	m_dataParamWriteString

Detailed Description

TextBoxに使うパラメータクラスです。
ベースクラスPtlParamWriteStringへの設定も忘れずに行ってください。

Member Enumeration Documentation

FORMAT_TYPE

enum PdfTk::PtlParamWriteStringTextBox::FORMAT_TYPE

フォーマットタイプ

Enumerator
FORM_NORMAL	ノーマル(デフォルト)
FORM_SUP	上付き
FORM_SUB	下付き
FORM_CHEM	化学式

Constructor & Destructor Documentation

PtlParamWriteStringTextBox() [1/2]

PdfTk::PtlParamWriteStringTextBox::PtlParamWriteStringTextBox

(

)

コンストラクタ

Exceptions

PtlException

PtlParamWriteStringTextBox() [2/2]

PdfTk::PtlParamWriteStringTextBox::PtlParamWriteStringTextBox

(

const PtlParamWriteStringTextBox &

obj

)

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

Parameters

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

Exceptions

PtlException

Member Function Documentation

operator=()

PtlParamWriteStringTextBox & PdfTk::PtlParamWriteStringTextBox::operator=

(

const PtlParamWriteStringTextBox &

obj

)

コピーオペレータ alias copy

Parameters

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

setBackColor()

void PdfTk::PtlParamWriteStringTextBox::setBackColor

(

const PtlColor &

bkColor

)

背景色を設定。

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

Parameters

bkColor

背景色指定。

Exceptions

PtlException

setCharSpacing()

void PdfTk::PtlParamWriteStringTextBox::setCharSpacing

(

float

spacing

)

文字間の設定。

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

Parameters

spacing

-1〜2の値で設定します。

Exceptions

PtlException

setFormat()

void PdfTk::PtlParamWriteStringTextBox::setFormat

(

FORMAT_TYPE

format

)

フォーマットの設定。

FORM_SUP,FORM_SUB,FORM_CHEMは横書きの場合のみ有効です。
※ 設定しない場合はデフォルト値としてFORM_NORMALが使用されます。

Parameters

format

フォーマット。

Exceptions

PtlException

setLineSpacing()

void PdfTk::PtlParamWriteStringTextBox::setLineSpacing

(

float

spacing

)

行間の設定。

フォントサイズ1に対する値を行間として設定します。
※ 設定しない場合はデフォルト値として1.2が使用されます。

Parameters

spacing

1〜3の値で設定します。

Exceptions

PtlException

setStrikeOut()

void PdfTk::PtlParamWriteStringTextBox::setStrikeOut

(

bool

strikeOut

)

取り消し線を引くか引かないかの設定。

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

Parameters

strikeOut

trueなら取り消し線を引く。

Exceptions

PtlException

setUnderline()

void PdfTk::PtlParamWriteStringTextBox::setUnderline

(

bool

underline

)

下線を引くか引かないかの設定。

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

Parameters

underline

trueなら下線を引く。

Exceptions

PtlException