MWGui::JournalViewModel Struct Reference

#include <journalviewmodel.hpp>

List of all members.

Classes
struct	Entry
	The base interface for both journal entries and topics. More...
struct	JournalEntry
	An interface to journal data. More...
struct	TopicEntry
	An interface to topic data. More...
Public Types
typedef boost::shared_ptr < JournalViewModel >	Ptr
typedef intptr_t	QuestId
typedef intptr_t	TopicId
typedef uint8_t const *	Utf8Point
typedef std::pair< Utf8Point, Utf8Point >	Utf8Span
Public Member Functions
virtual void	load ()=0
	called prior to journal opening
virtual void	unload ()=0
	called prior to journal closing
virtual bool	isEmpty () const =0
	returns true if their are no journal entries to display
virtual void	visitQuestName (TopicId topicId, boost::function< void(Utf8Span)> visitor) const =0
	provides access to the name of the quest with the specified identifier
virtual void	visitQuestNames (bool active_only, boost::function< void(QuestId, Utf8Span)> visitor) const =0
	walks the active and optionally completed, quests providing the quest id and name
virtual void	visitJournalEntries (QuestId questId, boost::function< void(JournalEntry const &)> visitor) const =0
	walks over the journal entries related to the specified quest identified by its id
virtual void	visitTopicName (TopicId topicId, boost::function< void(Utf8Span)> visitor) const =0
	provides the name of the topic specified by its id
virtual void	visitTopicNamesStartingWith (char character, boost::function< void(TopicId, Utf8Span) > visitor) const =0
	walks over the topics whose names start with the specified character providing the topics id and name
virtual void	visitTopicEntries (TopicId topicId, boost::function< void(TopicEntry const &)> visitor) const =0
	walks over the topic entries for the topic specified by its identifier
Static Public Member Functions
static Ptr	create ()

---

Detailed Description

View-Model for the journal GUI

This interface defines an abstract data model suited specifically to the needs of the journal GUI. It isolates the journal GUI from the implementation details of the game data store.

---

Member Typedef Documentation

typedef boost::shared_ptr<JournalViewModel> MWGui::JournalViewModel::Ptr

typedef intptr_t MWGui::JournalViewModel::QuestId

typedef intptr_t MWGui::JournalViewModel::TopicId

typedef uint8_t const* MWGui::JournalViewModel::Utf8Point

typedef std::pair<Utf8Point, Utf8Point> MWGui::JournalViewModel::Utf8Span

---

Member Function Documentation

JournalViewModel::Ptr MWGui::JournalViewModel::create

(

)

[static]

virtual bool MWGui::JournalViewModel::isEmpty

(

)

const [pure virtual]

returns true if their are no journal entries to display

Implemented in MWGui::JournalViewModelImpl.

virtual void MWGui::JournalViewModel::load

(

)

[pure virtual]

called prior to journal opening

Implemented in MWGui::JournalViewModelImpl.

virtual void MWGui::JournalViewModel::unload

(

)

[pure virtual]

called prior to journal closing

Implemented in MWGui::JournalViewModelImpl.

virtual void MWGui::JournalViewModel::visitJournalEntries	(	QuestId	questId,
		boost::function< void(JournalEntry const &)>	visitor
	)		const [pure virtual]

walks over the journal entries related to the specified quest identified by its id

Implemented in MWGui::JournalViewModelImpl.

virtual void MWGui::JournalViewModel::visitQuestName	(	TopicId	topicId,
		boost::function< void(Utf8Span)>	visitor
	)		const [pure virtual]

provides access to the name of the quest with the specified identifier

Implemented in MWGui::JournalViewModelImpl.

virtual void MWGui::JournalViewModel::visitQuestNames	(	bool	active_only,
		boost::function< void(QuestId, Utf8Span)>	visitor
	)		const [pure virtual]

walks the active and optionally completed, quests providing the quest id and name

Implemented in MWGui::JournalViewModelImpl.

virtual void MWGui::JournalViewModel::visitTopicEntries	(	TopicId	topicId,
		boost::function< void(TopicEntry const &)>	visitor
	)		const [pure virtual]

walks over the topic entries for the topic specified by its identifier

Implemented in MWGui::JournalViewModelImpl.

virtual void MWGui::JournalViewModel::visitTopicName	(	TopicId	topicId,
		boost::function< void(Utf8Span)>	visitor
	)		const [pure virtual]

provides the name of the topic specified by its id

Implemented in MWGui::JournalViewModelImpl.

virtual void MWGui::JournalViewModel::visitTopicNamesStartingWith	(	char	character,
		boost::function< void(TopicId, Utf8Span) >	visitor
	)		const [pure virtual]

walks over the topics whose names start with the specified character providing the topics id and name

Implemented in MWGui::JournalViewModelImpl.

---

The documentation for this struct was generated from the following files:

• apps/openmw/mwgui/journalviewmodel.hpp
• apps/openmw/mwgui/journalviewmodel.cpp