OpenMW
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
MWGui::ReferenceInterface Class Referenceabstract

this class is intended for GUI interfaces that access an MW-Reference for example dialogue window accesses an NPC, or Container window accesses a Container these classes have to be automatically closed if the reference becomes unavailable make sure that checkReferenceAvailable() is called every frame and that onReferenceUnavailable() has been overridden More...

#include <referenceinterface.hpp>

Inheritance diagram for MWGui::ReferenceInterface:
Collaboration diagram for MWGui::ReferenceInterface:

Public Member Functions

 ReferenceInterface ()
 
virtual ~ReferenceInterface ()
 
void checkReferenceAvailable ()
 closes the window, if the MW-reference has become unavailable More...
 
virtual void resetReference ()
 

Protected Member Functions

virtual void onReferenceUnavailable ()=0
 called when reference has become unavailable More...
 

Protected Attributes

MWWorld::Ptr mPtr
 

Detailed Description

this class is intended for GUI interfaces that access an MW-Reference for example dialogue window accesses an NPC, or Container window accesses a Container these classes have to be automatically closed if the reference becomes unavailable make sure that checkReferenceAvailable() is called every frame and that onReferenceUnavailable() has been overridden

Constructor & Destructor Documentation

MWGui::ReferenceInterface::ReferenceInterface ( )
MWGui::ReferenceInterface::~ReferenceInterface ( )
virtual

Member Function Documentation

void MWGui::ReferenceInterface::checkReferenceAvailable ( )

closes the window, if the MW-reference has become unavailable

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void MWGui::ReferenceInterface::onReferenceUnavailable ( )
protectedpure virtual

called when reference has become unavailable

Implemented in MWGui::SpellCreationDialog, MWGui::DialogueWindow, MWGui::TradeWindow, MWGui::Console, MWGui::ContainerWindow, MWGui::CompanionWindow, MWGui::SpellBuyingWindow, MWGui::TravelWindow, MWGui::EnchantingDialog, and MWGui::TrainingWindow.

Here is the caller graph for this function:

virtual void MWGui::ReferenceInterface::resetReference ( )
inlinevirtual

Reimplemented in MWGui::Console, MWGui::ContainerWindow, MWGui::TradeWindow, MWGui::EnchantingDialog, and MWGui::CompanionWindow.

Here is the caller graph for this function:

Member Data Documentation

MWWorld::Ptr MWGui::ReferenceInterface::mPtr
protected

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