既読履歴管理クラスです。 [詳細]

#include <TextManager.h>

TextManagerに対する継承グラフ

Public メソッド
	TextManager ()
	デフォルトコンストラクタです。
void	Initialize ()
	初期化を行います。
bool	GetSkip () const
	スキップするかを取得します。
void	SetSkip (bool IsSkip)
	スキップするかを設定します。
bool	GetForceSkip () const
	強制スキップするかを取得します。
void	SetForceSkip (bool IsForceSkip)
	強制スキップするかを設定します。
bool	GetAutoMode () const
	オートモードかを取得します。
void	SetAutoMode (bool IsAutoMode)
	オートモードかを設定します。
unsigned int	GetAutoModeTime () const
	オートモードの待機時間を取得します。
void	SetAutoModeTime (unsigned int Time)
	オートモードの待機時間を設定します。
unsigned int	GetKidokuMaxLog () const
	ログの最大保持数を取得します。
void	SetKidokuMaxLog (unsigned int NumMaxLog)
	ログの最大保持数を設定します。
void	AddRecord (unsigned int Iterator)
	既読履歴に記録を追加します。
bool	IsExistRecord (unsigned int Iterator) const
	既読履歴に記録が存在するかを取得します。
void	AddReadIterator (int Iterator)
	既読履歴ログのイテレータを加算します。
unsigned int	GetReadIterator () const
	既読履歴ログのイテレータを取得します。
void	SetReadIterator (unsigned int Iterator)
	既読履歴ログのイテレータを設定します。
void	ClearRecordData ()
	既読履歴ログを全消去します。
bool	IsEmptyRecordData () const
	既読履歴ログが空かを取得します。
const Record &	GetRecordData () const
	ログを取得します。
void	AddRecordData (const Record &Data)
	ログを追加します。
void	SaveE (IIOStream *IOStream)
	環境設定の保存を行います。
void	LoadE (IIOStream *IOStream)
	環境設定の読み込みを行います。
bool	SaveK (const string &FileName, IIOStream *IOStream)
	既読履歴の保存を行います。
bool	LoadK (const string &FileName, IIOStream *IOStream)
	既読履歴の読み込みを行います。
void	SaveL (IIOStream *IOStream)
	ローカル設定の保存を行います。
void	LoadL (IIOStream *IOStream)
	ローカル設定の読み込みを行います。

説明

既読履歴管理クラスです。

本クラスは全ての既読履歴管理を行います。

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

TextManager ( )

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

関数

void Initialize ( )

初期化を行います。

bool GetSkip ( ) const [virtual]

スキップするかを取得します。

戻り値:: スキップするかを返します。
スキップする場合はtrueを、しない場合はfalseを返します。

ITextManagerを実装しています。

void SetSkip ( bool IsSkip ) [virtual]

スキップするかを設定します。

引数:

IsSkip [in]スキップするかを指定します。
スキップする場合はtrueを、しない場合はfalseを指定します。

ITextManagerを実装しています。

bool GetForceSkip ( ) const [virtual]

強制スキップするかを取得します。

強制スキップとは、未読テキストをも読み飛ばすスキップのことです。

戻り値:: 強制スキップするかを返します。
強制スキップする場合はtrueを、しない場合はfalseを返します。

ITextManagerを実装しています。

void SetForceSkip ( bool IsForceSkip ) [virtual]

強制スキップするかを設定します。

強制スキップとは、未読テキストをも読み飛ばすスキップのことです。

引数:

IsForceSkip [in]強制スキップするかを指定します。
強制スキップする場合はtrueを、しない場合はfalseを指定します。

ITextManagerを実装しています。

bool GetAutoMode ( ) const [virtual]

オートモードかを取得します。

オートモードとは、マウスクリックなどをせずともテキストが自動で読み進められる状態のことです。

戻り値:: オートモードかを返します。
オートモードの場合はtrueを、そうでない場合はfalseを返します。

ITextManagerを実装しています。

void SetAutoMode ( bool IsAutoMode ) [virtual]

オートモードかを設定します。

オートモードとは、マウスクリックなどをせずともテキストが自動で読み進められる状態のことです。

引数:

IsAutoMode [in]オートモードかを指定します。
オートモードにする場合はtrueを、しない場合はfalseを指定します。

ITextManagerを実装しています。

unsigned int GetAutoModeTime ( ) const [virtual]

オートモードの待機時間を取得します。

戻り値:: オートモードの待機時間を返します（単位：ミリ秒）

ITextManagerを実装しています。

void SetAutoModeTime ( unsigned int Time ) [virtual]

オートモードの待機時間を設定します。

引数:

Time	[in]オートモードの待機時間を指定します（単位：ミリ秒）

ITextManagerを実装しています。

unsigned int GetKidokuMaxLog ( ) const [virtual]

ログの最大保持数を取得します。

ログの数が最大保持数を超過した場合、古いログから自動で削除されていきます。

戻り値:: ログの最大保持数を返します。

ITextManagerを実装しています。

void SetKidokuMaxLog ( unsigned int NumMaxLog ) [virtual]

ログの最大保持数を設定します。

ログの数が最大保持数を超過した場合、古いログから自動で削除されていきます。

引数:

NumMaxLog [in]ログの最大保持数を指定します。

ITextManagerを実装しています。

void AddRecord ( unsigned int Iterator ) [virtual]

既読履歴に記録を追加します。

引数:

Iterator [in]追加する記録のスクリプト命令のイテレータを指定します。基本的にはICommandHeapクラスの GetIteratorメソッドを指定してください。

ITextManagerを実装しています。

bool IsExistRecord ( unsigned int Iterator ) const [virtual]

既読履歴に記録が存在するかを取得します。

引数:

Iterator [in]存在するかを取得する記録のスクリプト命令のイテレータを指定します。基本的にはICommandHeapクラスの GetIteratorメソッドを指定してください。

戻り値:: 既読履歴に記録が存在するかを返します。

ITextManagerを実装しています。

void AddReadIterator ( int Iterator ) [virtual]

既読履歴ログのイテレータを加算します。

イテレータとは、既読履歴ログの参照位置のことです。
イテレータの範囲は1〜GetKidokuMaxLogメソッドで取得した値となります、範囲外の場合は強制的に範囲内に設定されます。

引数:

Iterator [in]加算値を指定します。

ITextManagerを実装しています。

unsigned int GetReadIterator ( ) const [virtual]

既読履歴ログのイテレータを取得します。

イテレータとは、既読履歴ログの参照位置のことです。

戻り値:: 既読履歴ログのイテレータを返します。

ITextManagerを実装しています。

void SetReadIterator ( unsigned int Iterator ) [virtual]

既読履歴ログのイテレータを設定します。

イテレータとは、既読履歴ログの参照位置のことです。
イテレータの範囲は1〜GetKidokuMaxLogメソッドで取得した値となります、範囲外の場合は強制的に範囲内に設定されます。

引数:

Iterator [in]設定値を指定します。

ITextManagerを実装しています。

void ClearRecordData ( ) [virtual]

既読履歴ログを全消去します。

ITextManagerを実装しています。

bool IsEmptyRecordData ( ) const [virtual]

既読履歴ログが空かを取得します。

戻り値:: 既読履歴ログが空かを返します。

ITextManagerを実装しています。

const Record& GetRecordData ( ) const [virtual]

ログを取得します。

どのログを取得するかは、予めAddReadIteratorメソッドあるいはSetReadIteratorメソッドで設定します。
既読履歴ログが空の場合、ランタイムエラーが発生します。

戻り値:: ログを返します。

ITextManagerを実装しています。

void AddRecordData ( const Record & Data ) [virtual]

ログを追加します。

引数:

Data	[in]追加するログを指定します。

ITextManagerを実装しています。

void SaveE ( IIOStream * IOStream )

環境設定の保存を行います。

引数:

IOStream [in]データ入出力クラスを指定します。

void LoadE ( IIOStream * IOStream )

環境設定の読み込みを行います。

引数:

IOStream [in]データ入出力クラスを指定します。

bool SaveK	(	const string &	FileName,
		IIOStream *	IOStream
	)

既読履歴の保存を行います。

引数:

FileName	[in]ファイル名を指定します。
IOStream	[in]データ入出力クラスを指定します。

bool LoadK	(	const string &	FileName,
		IIOStream *	IOStream
	)

既読履歴の読み込みを行います。

引数:

FileName	[in]ファイル名を指定します。
IOStream	[in]データ入出力クラスを指定します。

void SaveL ( IIOStream * IOStream )

ローカル設定の保存を行います。

引数:

IOStream [in]データ入出力クラスを指定します。

void LoadL ( IIOStream * IOStream )

ローカル設定の読み込みを行います。

引数:

IOStream [in]データ入出力クラスを指定します。

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

AbyssLibSrc/AbyssLib/AbyssLib/TextManager.h

クラス TextManager

Public メソッド

説明

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

関数