クラス TextTokenSection

テキスト（文単位）クラスです。 [詳細]

#include <CMisc.h>

すべてのメンバ一覧

Public メソッド
	TextTokenSection ()
	デフォルトコンストラクタです。
	TextTokenSection (const TextTokenSection &Src)
	コピーコンストラクタです。
	~TextTokenSection ()
	デストラクタです。
void	clear ()
	テキスト（文単位）をクリアします。
bool	push_back (const TextTokenLine &Src, unsigned int MaxWidth, unsigned int MaxHeight)
	テキスト（行単位）を末尾に追加します。
void	pop_back ()
	末尾のテキスト（行単位）を削除します。
TextTokenLine &	at (unsigned int Num)
	テキスト（行単位）への参照を取得します。
const TextTokenLine &	at (unsigned int Num) const
	テキスト（行単位）への参照を取得します。
TextTokenLine &	back ()
	末尾のテキスト（行単位）への参照を取得します。
const TextTokenLine &	back () const
	末尾のテキスト（行単位）への参照を取得します。
unsigned int	GetWidth () const
	テキスト（文単位）の横幅を取得します。
unsigned int	GetHeight () const
	テキスト（文単位）の縦幅を取得します。
bool	empty () const
	テキスト（文単位）が空か？を取得します。
unsigned int	size () const
	テキスト（文単位）のサイズを取得します。
TextTokenSection &	operator= (const TextTokenSection &RHS)
	代入演算子です。
bool	operator== (const TextTokenSection &RHS) const
	等価演算子です。
bool	operator!= (const TextTokenSection &RHS) const
	非等価演算子です。

---

説明

テキスト（文単位）クラスです。

実行ファイルと動的ライブラリの間でデータをやり取りする為のクラスです。
テキスト（文単位）とは、テキスト（１文分）のことです。
メソッド等はSTLのvector<TextTokenLine >クラスに似せてあります。

実行時に使用されるクラスです。
本クラスを引数とする関数に独自に作成したデータを割り当てる場合は、細心の注意を払ってください！

---

コンストラクタとデストラクタ

TextTokenSection

(

)

デフォルトコンストラクタです。

TextTokenSection

(

const TextTokenSection &

Src

)

コピーコンストラクタです。

引数:

Src	[in]コピー対象のテキスト（文単位）を指定します。

~TextTokenSection

(

)

デストラクタです。

---

関数

void clear

(

)

テキスト（文単位）をクリアします。

bool push_back	(	const TextTokenLine &	Src,
		unsigned int	MaxWidth,
		unsigned int	MaxHeight
	)

テキスト（行単位）を末尾に追加します。

引数:

Src	[in]追加対象のテキスト（行単位）を指定します。
MaxWidth	[in]テキスト（文単位）の最大横幅を指定します。
MaxHeight	[in]テキスト（文単位）の最大縦幅を指定します。

戻り値:

追加に成功した場合はtrueを、失敗した場合はfalseを返します。
falseが返るのは、追加によって最大横幅または最大縦幅を超過してしまう場合です。

void pop_back

(

)

末尾のテキスト（行単位）を削除します。

末尾のテキスト（行単位）が存在しない場合はランタイムエラー が発生します。

TextTokenLine& at

(

unsigned int

Num

)

テキスト（行単位）への参照を取得します。

引数:

Num	[in]添字を指定します。 添字が配列外の場合はランタイムエラー が発生します。

戻り値:

添字に対応するテキスト（行単位）への参照を返します。

const TextTokenLine& at

(

unsigned int

Num

)

const

テキスト（行単位）への参照を取得します。

引数:

Num	[in]添字を指定します。 添字が配列外の場合はランタイムエラー が発生します。

戻り値:

添字に対応するテキスト（行単位）への参照を返します。

TextTokenLine& back

(

)

末尾のテキスト（行単位）への参照を取得します。

末尾のテキスト（行単位）が存在しない場合はランタイムエラー が発生します。

戻り値:

末尾のテキスト（行単位）への参照を返します。

const TextTokenLine& back

(

)

const

末尾のテキスト（行単位）への参照を取得します。

末尾のテキスト（行単位）が存在しない場合はランタイムエラー が発生します。

戻り値:

末尾のテキスト（行単位）への参照を返します。

unsigned int GetWidth

(

)

const

テキスト（文単位）の横幅を取得します。

戻り値:

テキスト（文単位）の横幅を返します。

unsigned int GetHeight

(

)

const

テキスト（文単位）の縦幅を取得します。

戻り値:

テキスト（文単位）の縦幅を返します。

bool empty

(

)

const

テキスト（文単位）が空か？を取得します。

戻り値:

テキスト（文単位）が空の場合はtrueを、空でない場合はfalseを返します。

unsigned int size

(

)

const

テキスト（文単位）のサイズを取得します。

戻り値:

テキスト（文単位）のサイズを返します。

TextTokenSection& operator=

(

const TextTokenSection &

RHS

)

代入演算子です。

引数:

RHS	[in]代入するテキスト（文単位）を指定します。

戻り値:

代入したテキスト（文単位）への参照を返します。

bool operator==

(

const TextTokenSection &

RHS

)

const

等価演算子です。

引数:

RHS	[in]比較するテキスト（文単位）を指定します。

戻り値:

等価の場合はtrue、非等価の場合はfalseを返します。

bool operator!=

(

const TextTokenSection &

RHS

)

const

非等価演算子です。

引数:

RHS	[in]比較するテキスト（文単位）を指定します。

戻り値:

非等価の場合はtrue、等価の場合はfalseを返します。

---

このクラスの説明は次のファイルから生成されました:

• AbyssLibSrc/AbyssLib/AbyssLib/CMisc.h