クラス ITextManager

既読履歴管理クラスのインターフェースです。 [詳細]

#include <TextManager.h>

ITextManagerに対する継承グラフ

すべてのメンバ一覧

Public メソッド
virtual bool	GetSkip () const =0
	スキップするかを取得します。
virtual void	SetSkip (bool IsSkip)=0
	スキップするかを設定します。
virtual bool	GetForceSkip () const =0
	強制スキップするかを取得します。
virtual void	SetForceSkip (bool IsForceSkip)=0
	強制スキップするかを設定します。
virtual bool	GetAutoMode () const =0
	オートモードかを取得します。
virtual void	SetAutoMode (bool IsAutoMode)=0
	オートモードかを設定します。
virtual unsigned int	GetAutoModeTime () const =0
	オートモードの待機時間を取得します。
virtual void	SetAutoModeTime (unsigned int Time)=0
	オートモードの待機時間を設定します。
virtual unsigned int	GetKidokuMaxLog () const =0
	ログの最大保持数を取得します。
virtual void	SetKidokuMaxLog (unsigned int NumMaxLog)=0
	ログの最大保持数を設定します。
virtual void	AddRecord (unsigned int Iterator)=0
	既読履歴に記録を追加します。
virtual bool	IsExistRecord (unsigned int Iterator) const =0
	既読履歴に記録が存在するかを取得します。
virtual void	AddReadIterator (int Iterator)=0
	既読履歴ログのイテレータを加算します。
virtual unsigned int	GetReadIterator () const =0
	既読履歴ログのイテレータを取得します。
virtual void	SetReadIterator (unsigned int Iterator)=0
	既読履歴ログのイテレータを設定します。
virtual void	ClearRecordData ()=0
	既読履歴ログを全消去します。
virtual bool	IsEmptyRecordData () const =0
	既読履歴ログが空かを取得します。
virtual const Record &	GetRecordData () const =0
	ログを取得します。
virtual void	AddRecordData (const Record &Data)=0
	ログを追加します。

---

説明

既読履歴管理クラスのインターフェースです。

本クラスは全ての既読履歴管理を行います。
全ての既読履歴管理を行うように実装してください。

---

関数

virtual bool GetSkip

(

)

const [pure virtual]

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

戻り値:

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

TextManagerで実装されています。

virtual void SetSkip

(

bool

IsSkip

)

[pure virtual]

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

引数:

IsSkip

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

TextManagerで実装されています。

virtual bool GetForceSkip

(

)

const [pure virtual]

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

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

戻り値:

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

TextManagerで実装されています。

virtual void SetForceSkip

(

bool

IsForceSkip

)

[pure virtual]

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

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

引数:

IsForceSkip

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

TextManagerで実装されています。

virtual bool GetAutoMode

(

)

const [pure virtual]

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

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

戻り値:

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

TextManagerで実装されています。

virtual void SetAutoMode

(

bool

IsAutoMode

)

[pure virtual]

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

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

引数:

IsAutoMode

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

TextManagerで実装されています。

virtual unsigned int GetAutoModeTime

(

)

const [pure virtual]

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

戻り値:

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

TextManagerで実装されています。

virtual void SetAutoModeTime

(

unsigned int

Time

)

[pure virtual]

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

引数:

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

TextManagerで実装されています。

virtual unsigned int GetKidokuMaxLog

(

)

const [pure virtual]

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

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

戻り値:

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

TextManagerで実装されています。

virtual void SetKidokuMaxLog

(

unsigned int

NumMaxLog

)

[pure virtual]

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

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

引数:

NumMaxLog

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

TextManagerで実装されています。

virtual void AddRecord

(

unsigned int

Iterator

)

[pure virtual]

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

引数:

Iterator

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

TextManagerで実装されています。

virtual bool IsExistRecord

(

unsigned int

Iterator

)

const [pure virtual]

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

引数:

Iterator

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

戻り値:

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

TextManagerで実装されています。

virtual void AddReadIterator

(

int

Iterator

)

[pure virtual]

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

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

引数:

Iterator

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

TextManagerで実装されています。

virtual unsigned int GetReadIterator

(

)

const [pure virtual]

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

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

戻り値:

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

TextManagerで実装されています。

virtual void SetReadIterator

(

unsigned int

Iterator

)

[pure virtual]

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

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

引数:

Iterator

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

TextManagerで実装されています。

virtual void ClearRecordData

(

)

[pure virtual]

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

TextManagerで実装されています。

virtual bool IsEmptyRecordData

(

)

const [pure virtual]

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

戻り値:

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

TextManagerで実装されています。

virtual const Record& GetRecordData

(

)

const [pure virtual]

ログを取得します。

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

戻り値:

ログを返します。

TextManagerで実装されています。

virtual void AddRecordData

(

const Record &

Data

)

[pure virtual]

ログを追加します。

引数:

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

TextManagerで実装されています。

---

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

• AbyssLibSrc/AbyssLib/AbyssLib/TextManager.h