OpenMW: MWGui::BookPage Class Reference

OpenMW

An interface to the BookPage widget. More...

#include <bookpage.hpp>

List of all members.

Public Types
typedef TypesetBook::InteractiveId	InteractiveId
typedef boost::function< void(InteractiveId)>	ClickCallback
Public Member Functions
virtual void	showPage (TypesetBook::Ptr Book, size_t Page)=0
	Make the widget display the specified page from the specified book.
virtual void	adviseLinkClicked (ClickCallback callback)=0
	Set the callback for a clicking a hyper-link in the document.
virtual void	unadviseLinkClicked ()=0
	Clear the hyper-link click callback.
Static Public Member Functions
static void	registerMyGUIComponents ()

Detailed Description

An interface to the BookPage widget.

Member Typedef Documentation

typedef boost::function<void (InteractiveId)> MWGui::BookPage::ClickCallback

typedef TypesetBook::InteractiveId MWGui::BookPage::InteractiveId

Member Function Documentation

virtual void MWGui::BookPage::adviseLinkClicked ( ClickCallback callback ) [pure virtual]

Set the callback for a clicking a hyper-link in the document.

void MWGui::BookPage::registerMyGUIComponents ( ) [static]

Register the widget and associated sub-widget with MyGUI. Should be called once near the beginning of the program.

virtual void MWGui::BookPage::showPage	(	TypesetBook::Ptr	Book,
		size_t	Page
	)		`[pure virtual]`

Make the widget display the specified page from the specified book.

Implemented in MWGui::BookPageImpl.

virtual void MWGui::BookPage::unadviseLinkClicked ( ) [pure virtual]

Clear the hyper-link click callback.

Implemented in MWGui::BookPageImpl.

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

apps/openmw/mwgui/bookpage.hpp
apps/openmw/mwgui/bookpage.cpp