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

#include <journal.hpp>

Inheritance diagram for MWBase::Journal:

Collaboration diagram for MWBase::Journal:

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, const MWWorld::Ptr &actor)=0

virtual void	setJournalIndex (const std::string &id, int index)=0
	Set the journal index without adding an entry. More...

virtual int	getJournalIndex (const std::string &id) const =0
	Get the journal index. More...

virtual void	addTopic (const std::string &topicId, const std::string &infoId, const MWWorld::Ptr &actor)=0

virtual void	removeLastAddedTopicResponse (const std::string &topicId, const std::string &actorName)=0

virtual TEntryIter	begin () const =0

virtual TEntryIter	end () const =0
	Iterator pointing past the end of the main journal. More...

virtual TQuestIter	questBegin () const =0
	Iterator pointing to the first quest (sorted by topic ID) More...

virtual TQuestIter	questEnd () const =0
	Iterator pointing past the last quest. More...

virtual TTopicIter	topicBegin () const =0

virtual TTopicIter	topicEnd () const =0
	Iterator pointing past the last topic. More...

virtual int	countSavedGameRecords () const =0

virtual void	write (ESM::ESMWriter &writer, Loading::Listener &progress) const =0

virtual void	readRecord (ESM::ESMReader &reader, uint32_t type)=0

Private Member Functions
	Journal (const Journal &)
	not implemented More...

Journal &	operator= (const Journal &)
	not implemented More...

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

virtual MWBase::Journal::~Journal ( )

inlinevirtual

Member Function Documentation

virtual void MWBase::Journal::addEntry	(	const std::string &	id,
		int	index,
		const MWWorld::Ptr &	actor
	)

pure virtual

Add a journal entry.

Parameters

actor Used as context for replacing of escape sequences (name, etc).

Implemented in MWDialogue::Journal.

Here is the caller graph for this function:

virtual void MWBase::Journal::addTopic	(	const std::string &	topicId,
		const std::string &	infoId,
		const MWWorld::Ptr &	actor
	)

pure virtual

Implemented in MWDialogue::Journal.

Here is the caller graph for this function:

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.

Here is the caller graph for this function:

virtual void MWBase::Journal::clear ( )

pure virtual

Implemented in MWDialogue::Journal.

Here is the caller graph for this function:

virtual int MWBase::Journal::countSavedGameRecords ( ) const

pure virtual

Implemented in MWDialogue::Journal.

Here is the caller graph for this function:

virtual TEntryIter MWBase::Journal::end ( ) const

pure virtual

Iterator pointing past the end of the main journal.

Implemented in MWDialogue::Journal.

Here is the caller graph for this function:

virtual int MWBase::Journal::getJournalIndex ( const std::string & id ) const

pure virtual

Get the journal index.

Implemented in MWDialogue::Journal.

Here is the caller graph for this function:

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.

Here is the caller graph for this function:

virtual TQuestIter MWBase::Journal::questEnd ( ) const

pure virtual

Iterator pointing past the last quest.

Implemented in MWDialogue::Journal.

Here is the caller graph for this function:

virtual void MWBase::Journal::readRecord	(	ESM::ESMReader &	reader,
		uint32_t	type
	)

pure virtual

Implemented in MWDialogue::Journal.

Here is the caller graph for this function:

virtual void MWBase::Journal::removeLastAddedTopicResponse	(	const std::string &	topicId,
		const std::string &	actorName
	)

pure virtual

Note: topicId must be lowercase Removes the last topic response added for the given topicId and actor name.; topicId must be lowercase

Implemented in MWDialogue::Journal.

Here is the caller graph for this function:

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.

Here is the caller graph for this function:

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.

Here is the caller graph for this function:

virtual TTopicIter MWBase::Journal::topicEnd ( ) const

pure virtual

Iterator pointing past the last topic.

Implemented in MWDialogue::Journal.

Here is the caller graph for this function:

virtual void MWBase::Journal::write	(	ESM::ESMWriter &	writer,
		Loading::Listener &	progress
	)		const

pure virtual

Implemented in MWDialogue::Journal.

Here is the caller graph for this function:

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

/home/travis/build/OpenMW/openmw/apps/openmw/mwbase/journal.hpp

Public Types

Public Member Functions

Private Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation