MWBase::Journal Class Reference

Interface for the player's journal (implemented in MWDialogue) More...

#include <journal.hpp>

List of all members.

Public Types
typedef std::deque < MWDialogue::StampedJournalEntry >	TEntryContainer
typedef TEntryContainer::const_iterator	TEntryIter
typedef std::map< std::string, MWDialogue::Quest >	TQuestContainer
typedef TQuestContainer::const_iterator	TQuestIter
typedef std::map< std::string, MWDialogue::Topic >	TTopicContainer
typedef TTopicContainer::const_iterator	TTopicIter
Public Member Functions
	Journal ()
virtual void	clear ()=0
virtual	~Journal ()
virtual void	addEntry (const std::string &id, int index)=0
	Add a journal entry.
virtual void	setJournalIndex (const std::string &id, int index)=0
	Set the journal index without adding an entry.
virtual int	getJournalIndex (const std::string &id) const =0
	Get the journal index.
virtual void	addTopic (const std::string &topicId, const std::string &infoId)=0
virtual TEntryIter	begin () const =0
virtual TEntryIter	end () const =0
	Iterator pointing past the end of the main journal.
virtual TQuestIter	questBegin () const =0
	Iterator pointing to the first quest (sorted by topic ID)
virtual TQuestIter	questEnd () const =0
	Iterator pointing past the last quest.
virtual TTopicIter	topicBegin () const =0
virtual TTopicIter	topicEnd () const =0
	Iterator pointing past the last topic.
Private Member Functions
	Journal (const Journal &)
	not implemented
Journal &	operator= (const Journal &)
	not implemented

---

Detailed Description

Interface for the player's journal (implemented in MWDialogue)

---

Member Typedef Documentation

typedef std::deque<MWDialogue::StampedJournalEntry> MWBase::Journal::TEntryContainer

typedef TEntryContainer::const_iterator MWBase::Journal::TEntryIter

typedef std::map<std::string, MWDialogue::Quest> MWBase::Journal::TQuestContainer

typedef TQuestContainer::const_iterator MWBase::Journal::TQuestIter

typedef std::map<std::string, MWDialogue::Topic> MWBase::Journal::TTopicContainer

typedef TTopicContainer::const_iterator MWBase::Journal::TTopicIter

---

Constructor & Destructor Documentation

MWBase::Journal::Journal

(

const Journal &

)

[private]

not implemented

MWBase::Journal::Journal

(

)

[inline]

Reimplemented in MWDialogue::Journal.

virtual MWBase::Journal::~Journal

(

)

[inline, virtual]

---

Member Function Documentation

virtual void MWBase::Journal::addEntry	(	const std::string &	id,
		int	index
	)		[pure virtual]

Add a journal entry.

Implemented in MWDialogue::Journal.

virtual void MWBase::Journal::addTopic	(	const std::string &	topicId,
		const std::string &	infoId
	)		[pure virtual]

Implemented in MWDialogue::Journal.

virtual TEntryIter MWBase::Journal::begin

(

)

const [pure virtual]

Iterator pointing to the begin of the main journal.

Note:

Iterators to main journal entries will never become invalid.

Implemented in MWDialogue::Journal.

virtual void MWBase::Journal::clear

(

)

[pure virtual]

Implemented in MWDialogue::Journal.

virtual TEntryIter MWBase::Journal::end

(

)

const [pure virtual]

Iterator pointing past the end of the main journal.

Implemented in MWDialogue::Journal.

virtual int MWBase::Journal::getJournalIndex

(

const std::string &

id

)

const [pure virtual]

Get the journal index.

Implemented in MWDialogue::Journal.

Journal& MWBase::Journal::operator=

(

const Journal &

)

[private]

not implemented

virtual TQuestIter MWBase::Journal::questBegin

(

)

const [pure virtual]

Iterator pointing to the first quest (sorted by topic ID)

Implemented in MWDialogue::Journal.

virtual TQuestIter MWBase::Journal::questEnd

(

)

const [pure virtual]

Iterator pointing past the last quest.

Implemented in MWDialogue::Journal.

virtual void MWBase::Journal::setJournalIndex	(	const std::string &	id,
		int	index
	)		[pure virtual]

Set the journal index without adding an entry.

Implemented in MWDialogue::Journal.

virtual TTopicIter MWBase::Journal::topicBegin

(

)

const [pure virtual]

Iterator pointing to the first topic (sorted by topic ID)

Note:

The topic ID is identical with the user-visible topic string.

Implemented in MWDialogue::Journal.

virtual TTopicIter MWBase::Journal::topicEnd

(

)

const [pure virtual]

Iterator pointing past the last topic.

Implemented in MWDialogue::Journal.

---

The documentation for this class was generated from the following file:

• apps/openmw/mwbase/journal.hpp