MWGui::WindowBase Class Reference

#include <windowbase.hpp>

Inheritance diagram for MWGui::WindowBase:

Collaboration diagram for MWGui::WindowBase:

Public Types
typedef MyGUI::delegates::CMultiDelegate1 < WindowBase * >	EventHandle_WindowBase

Public Member Functions
	WindowBase (const std::string &parLayout)
virtual MyGUI::Widget *	getDefaultKeyFocus ()
virtual void	setPtr (const MWWorld::Ptr &ptr)
	Open this object in the GUI, for windows that support it. More...
virtual void	onFrame (float duration)
	Called every frame if the window is in an active GUI mode. More...
virtual void	onOpen ()
	Notify that window has been made visible. More...
virtual void	onClose ()
	Notify that window has been hidden. More...
virtual bool	exit ()
	Gracefully exits the window. More...
virtual void	setVisible (bool visible)
	Sets the visibility of the window. More...
bool	isVisible ()
	Returns the visibility state of the window. More...
void	center ()
virtual void	clear ()
	Clear any state specific to the running game. More...
virtual void	onResChange (int width, int height)
	Called when GUI viewport changes size. More...
Public Member Functions inherited from MWGui::Layout
	Layout (const std::string &_layout, MyGUI::Widget *_parent=nullptr)
virtual	~Layout ()
MyGUI::Widget *	getWidget (const std::string &_name)
template<typename T >
void	getWidget (T *&_widget, const std::string &_name)
void	setCoord (int x, int y, int w, int h)
void	setText (const std::string &name, const std::string &caption)
void	setTitle (const std::string &title)

Additional Inherited Members
Public Attributes inherited from MWGui::Layout
MyGUI::Widget *	mMainWidget
Protected Attributes inherited from MWGui::Layout
std::string	mPrefix
std::string	mLayoutName
MyGUI::VectorWidgetPtr	mListWindowRoot

Member Typedef Documentation

typedef MyGUI::delegates::CMultiDelegate1<WindowBase*> MWGui::WindowBase::EventHandle_WindowBase

Constructor & Destructor Documentation

WindowBase::WindowBase

(

const std::string &

parLayout

)

Member Function Documentation

void WindowBase::center

(

)

virtual void MWGui::WindowBase::clear ( )

inlinevirtual

Clear any state specific to the running game.

Reimplemented in MWGui::MapWindow, MWGui::SpellCreationDialog, MWGui::DialogueWindow, MWGui::Console, MWGui::HUD, MWGui::InventoryWindow, MWGui::QuickKeysMenu, MWGui::ScreenFader, MWGui::ContainerWindow, MWGui::WaitDialog, MWGui::TradeWindow, MWGui::SpellBuyingWindow, MWGui::CompanionWindow, MWGui::TrainingWindow, and MWGui::EnchantingDialog.

virtual bool MWGui::WindowBase::exit ( )

inlinevirtual

Gracefully exits the window.

Reimplemented in MWGui::CreateClassDialog, MWGui::SelectSkillDialog, MWGui::SelectAttributeDialog, MWGui::SelectSpecializationDialog, MWGui::DialogueWindow, MWGui::PickClassDialog, MWGui::MagicSelectionDialog, MWGui::InteractiveMessageBox, MWGui::GenerateClassResultDialog, MWGui::WindowModal, MWGui::RaceDialog, MWGui::MainMenu, MWGui::TradeWindow, MWGui::ReviewDialog, MWGui::WaitDialog, MWGui::EditEffectDialog, MWGui::InfoBoxDialog, MWGui::BirthDialog, MWGui::CompanionWindow, MWGui::TextInputDialog, MWGui::ItemSelectionDialog, MWGui::TrainingWindow, MWGui::JailScreen, and MWGui::ConfirmationDialog.

Here is the caller graph for this function:

virtual MyGUI::Widget* MWGui::WindowBase::getDefaultKeyFocus ( )

inlinevirtual

Reimplemented in MWGui::InteractiveMessageBox, and MWGui::PersuasionDialog.

Here is the caller graph for this function:

bool WindowBase::isVisible

(

)

Returns the visibility state of the window.

Here is the caller graph for this function:

virtual void MWGui::WindowBase::onClose ( )

inlinevirtual

Notify that window has been hidden.

Reimplemented in anonymous_namespace{journalwindow.cpp}::JournalWindowImpl, MWGui::WindowModal, MWGui::RaceDialog, and MWGui::ContainerWindow.

Here is the caller graph for this function:

virtual void MWGui::WindowBase::onFrame ( float  duration )

inlinevirtual

Called every frame if the window is in an active GUI mode.

Reimplemented in MWGui::MapWindow, MWGui::SpellCreationDialog, MWGui::DialogueWindow, MWGui::ReviewDialog, MWGui::HUD, MWGui::InventoryWindow, MWGui::ContainerWindow, MWGui::MainMenu, MWGui::WaitDialog, MWGui::TradeWindow, MWGui::SpellBuyingWindow, MWGui::CompanionWindow, MWGui::EnchantingDialog, MWGui::StatsWindow, MWGui::TrainingWindow, MWGui::SpellWindow, MWGui::JailScreen, and MWGui::DebugWindow.

Here is the caller graph for this function:

virtual void MWGui::WindowBase::onOpen ( )

inlinevirtual

Notify that window has been made visible.

Reimplemented in anonymous_namespace{journalwindow.cpp}::JournalWindowImpl, MWGui::MapWindow, MWGui::EditNoteDialog, MWGui::SpellCreationDialog, MWGui::PickClassDialog, MWGui::MagicSelectionDialog, MWGui::WindowModal, MWGui::RaceDialog, MWGui::ReviewDialog, MWGui::Console, MWGui::SpellWindow, MWGui::StatsWindow, MWGui::InventoryWindow, MWGui::QuickKeysMenu, MWGui::PersuasionDialog, MWGui::WaitDialog, MWGui::AlchemyWindow, MWGui::EditEffectDialog, MWGui::Recharge, MWGui::InfoBoxDialog, MWGui::BirthDialog, MWGui::TextInputDialog, MWGui::EnchantingDialog, MWGui::Repair, MWGui::SaveGameDialog, MWGui::SettingsWindow, MWGui::TrainingWindow, MWGui::WaitDialogProgressBar, MWGui::MerchantRepair, and MWGui::LevelupDialog.

Here is the caller graph for this function:

virtual void MWGui::WindowBase::onResChange ( int  width, int  height  )

inlinevirtual

Called when GUI viewport changes size.

Reimplemented in MWGui::Console, MWGui::MainMenu, MWGui::SpellBuyingWindow, MWGui::AlchemyWindow, MWGui::QuickKeysMenu, MWGui::ScrollWindow, MWGui::SettingsWindow, and MWGui::BookWindow.

virtual void MWGui::WindowBase::setPtr ( const MWWorld::Ptr &  ptr )

inlinevirtual

Open this object in the GUI, for windows that support it.

Reimplemented in MWGui::SpellCreationDialog, MWGui::DialogueWindow, MWGui::ContainerWindow, MWGui::EnchantingDialog, MWGui::TradeWindow, MWGui::WaitDialog, MWGui::CompanionWindow, MWGui::SpellBuyingWindow, MWGui::Recharge, MWGui::TravelWindow, MWGui::Repair, MWGui::TrainingWindow, MWGui::ScrollWindow, MWGui::BookWindow, and MWGui::MerchantRepair.

void WindowBase::setVisible ( bool  visible )

virtual

Sets the visibility of the window.

Reimplemented from MWGui::Layout.

Reimplemented in anonymous_namespace{journalwindow.cpp}::JournalWindowImpl, MWGui::MapWindow, MWGui::LoadingScreen, MWGui::MainMenu, and MWGui::JournalWindow.

Here is the call graph for this function:

---

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

• /home/travis/build/elsid/openmw/apps/openmw/mwgui/windowbase.hpp
• /home/travis/build/elsid/openmw/apps/openmw/mwgui/windowbase.cpp