OpenMW
Public Types | Public Member Functions | Private Member Functions
MWBase::WindowManager Class Reference

Interface for widnow manager (implemented in MWGui) More...

#include <windowmanager.hpp>

List of all members.

Public Types

typedef std::vector< int > SkillList

Public Member Functions

 WindowManager ()
virtual ~WindowManager ()
virtual void update ()=0
virtual void setNewGame (bool newgame)=0
virtual void pushGuiMode (MWGui::GuiMode mode)=0
virtual void popGuiMode ()=0
virtual void removeGuiMode (MWGui::GuiMode mode)=0
 can be anywhere in the stack
virtual void updatePlayer ()=0
virtual MWGui::GuiMode getMode () const =0
virtual bool containsMode (MWGui::GuiMode) const =0
virtual bool isGuiMode () const =0
virtual bool isConsoleMode () const =0
virtual void toggleVisible (MWGui::GuiWindow wnd)=0
virtual void forceHide (MWGui::GuiWindow wnd)=0
virtual void unsetForceHide (MWGui::GuiWindow wnd)=0
virtual void disallowAll ()=0
 Disallow all inventory mode windows.
virtual void allow (MWGui::GuiWindow wnd)=0
 Allow one or more windows.
virtual bool isAllowed (MWGui::GuiWindow wnd) const =0
virtual MWGui::DialogueWindowgetDialogueWindow ()=0
virtual MWGui::ContainerWindowgetContainerWindow ()=0
virtual MWGui::InventoryWindowgetInventoryWindow ()=0
virtual MWGui::BookWindowgetBookWindow ()=0
virtual MWGui::ScrollWindowgetScrollWindow ()=0
virtual MWGui::CountDialoggetCountDialog ()=0
virtual MWGui::ConfirmationDialoggetConfirmationDialog ()=0
virtual MWGui::TradeWindowgetTradeWindow ()=0
virtual MWGui::SpellBuyingWindowgetSpellBuyingWindow ()=0
virtual MWGui::TravelWindowgetTravelWindow ()=0
virtual MWGui::SpellWindowgetSpellWindow ()=0
virtual MWGui::ConsolegetConsole ()=0
virtual MyGUI::Gui * getGui () const =0
virtual void wmUpdateFps (float fps, unsigned int triangleCount, unsigned int batchCount)=0
virtual void setValue (const std::string &id, const MWMechanics::Stat< int > &value)=0
 Set value for the given ID.
virtual void setValue (int parSkill, const MWMechanics::Stat< float > &value)=0
virtual void setValue (const std::string &id, const MWMechanics::DynamicStat< float > &value)=0
virtual void setValue (const std::string &id, const std::string &value)=0
virtual void setValue (const std::string &id, int value)=0
virtual void setDrowningTimeLeft (float time)=0
virtual void setPlayerClass (const ESM::Class &class_)=0
 set current class of player
virtual void configureSkills (const SkillList &major, const SkillList &minor)=0
 configure skill groups, each set contains the skill ID for that group.
virtual void setReputation (int reputation)=0
 set the current reputation value
virtual void setBounty (int bounty)=0
 set the current bounty value
virtual void updateSkillArea ()=0
 update display of skills, factions, birth sign, reputation and bounty
virtual void changeCell (MWWorld::CellStore *cell)=0
 change the active cell
virtual void setPlayerPos (const float x, const float y)=0
 set player position in map space
virtual void setPlayerDir (const float x, const float y)=0
 set player view direction in map space
virtual void setFocusObject (const MWWorld::Ptr &focus)=0
virtual void setFocusObjectScreenCoords (float min_x, float min_y, float max_x, float max_y)=0
virtual void setCursorVisible (bool visible)=0
virtual void getMousePosition (int &x, int &y)=0
virtual void getMousePosition (float &x, float &y)=0
virtual void setDragDrop (bool dragDrop)=0
virtual bool getWorldMouseOver ()=0
virtual void toggleFogOfWar ()=0
virtual void toggleFullHelp ()=0
 show extra info in item tooltips (owner, script)
virtual bool getFullHelp () const =0
virtual void setInteriorMapTexture (const int x, const int y)=0
 set the index of the map texture that should be used (for interiors)
virtual void setDrowningBarVisibility (bool visible)=0
 sets the visibility of the drowning bar
virtual void setHMSVisibility (bool visible)=0
 sets the visibility of the hud health/magicka/stamina bars
virtual void setMinimapVisibility (bool visible)=0
 sets the visibility of the hud minimap
virtual void setWeaponVisibility (bool visible)=0
virtual void setSpellVisibility (bool visible)=0
virtual void setSneakVisibility (bool visible)=0
virtual void activateQuickKey (int index)=0
virtual std::string getSelectedSpell ()=0
virtual void setSelectedSpell (const std::string &spellId, int successChancePercent)=0
virtual void setSelectedEnchantItem (const MWWorld::Ptr &item)=0
virtual void setSelectedWeapon (const MWWorld::Ptr &item)=0
virtual void unsetSelectedSpell ()=0
virtual void unsetSelectedWeapon ()=0
virtual void showCrosshair (bool show)=0
virtual bool getSubtitlesEnabled ()=0
virtual void toggleHud ()=0
virtual void disallowMouse ()=0
virtual void allowMouse ()=0
virtual void notifyInputActionBound ()=0
virtual void addVisitedLocation (const std::string &name, int x, int y)=0
virtual void removeDialog (OEngine::GUI::Layout *dialog)=0
 Hides dialog and schedules dialog to be deleted.
virtual void messageBox (const std::string &message, const std::vector< std::string > &buttons=std::vector< std::string >(), bool showInDialogueModeOnly=false)=0
virtual void staticMessageBox (const std::string &message)=0
virtual void removeStaticMessageBox ()=0
virtual void enterPressed ()=0
virtual void activateKeyPressed ()=0
virtual int readPressedButton ()=0
 returns the index of the pressed button or -1 if no button was pressed (->MessageBoxmanager->InteractiveMessageBox)
virtual void onFrame (float frameDuration)=0
virtual std::map< int,
MWMechanics::Stat< float > > 
getPlayerSkillValues ()=0
virtual std::map< int,
MWMechanics::Stat< int > > 
getPlayerAttributeValues ()=0
virtual SkillList getPlayerMinorSkills ()=0
virtual SkillList getPlayerMajorSkills ()=0
virtual std::string getGameSettingString (const std::string &id, const std::string &default_)=0
virtual void processChangedSettings (const Settings::CategorySettingVector &changed)=0
virtual void windowResized (int x, int y)=0
virtual void executeInConsole (const std::string &path)=0
virtual void enableRest ()=0
virtual bool getRestEnabled ()=0
virtual bool getJournalAllowed ()=0
virtual bool getPlayerSleeping ()=0
virtual void wakeUpPlayer ()=0
virtual void showCompanionWindow (MWWorld::Ptr actor)=0
virtual void startSpellMaking (MWWorld::Ptr actor)=0
virtual void startEnchanting (MWWorld::Ptr actor)=0
virtual void startRecharge (MWWorld::Ptr soulgem)=0
virtual void startSelfEnchanting (MWWorld::Ptr soulgem)=0
virtual void startTraining (MWWorld::Ptr actor)=0
virtual void startRepair (MWWorld::Ptr actor)=0
virtual void startRepairItem (MWWorld::Ptr item)=0
virtual void showSoulgemDialog (MWWorld::Ptr item)=0
virtual void frameStarted (float dt)=0
virtual void changePointer (const std::string &name)=0
virtual void setEnemy (const MWWorld::Ptr &enemy)=0
virtual const
Translation::Storage
getTranslationDataStorage () const =0
virtual void setKeyFocusWidget (MyGUI::Widget *widget)=0
virtual Loading::ListenergetLoadingScreen ()=0
virtual bool getCursorVisible ()=0
 Should the cursor be visible?

Private Member Functions

 WindowManager (const WindowManager &)
 not implemented
WindowManageroperator= (const WindowManager &)
 not implemented

Detailed Description

Interface for widnow manager (implemented in MWGui)


Member Typedef Documentation

typedef std::vector<int> MWBase::WindowManager::SkillList

Constructor & Destructor Documentation

not implemented

virtual MWBase::WindowManager::~WindowManager ( ) [inline, virtual]

Reimplemented in MWGui::WindowManager.


Member Function Documentation

virtual void MWBase::WindowManager::activateKeyPressed ( ) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::activateQuickKey ( int  index) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::addVisitedLocation ( const std::string &  name,
int  x,
int  y 
) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::allow ( MWGui::GuiWindow  wnd) [pure virtual]

Allow one or more windows.

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::allowMouse ( ) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::changeCell ( MWWorld::CellStore cell) [pure virtual]

change the active cell

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::changePointer ( const std::string &  name) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::configureSkills ( const SkillList major,
const SkillList minor 
) [pure virtual]

configure skill groups, each set contains the skill ID for that group.

Implemented in MWGui::WindowManager.

virtual bool MWBase::WindowManager::containsMode ( MWGui::GuiMode  ) const [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::disallowAll ( ) [pure virtual]

Disallow all inventory mode windows.

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::disallowMouse ( ) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::enableRest ( ) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::enterPressed ( ) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::executeInConsole ( const std::string &  path) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::forceHide ( MWGui::GuiWindow  wnd) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::frameStarted ( float  dt) [pure virtual]

Implemented in MWGui::WindowManager.

Implemented in MWGui::WindowManager.

Implemented in MWGui::WindowManager.

Implemented in MWGui::WindowManager.

Implemented in MWGui::WindowManager.

Implemented in MWGui::WindowManager.

virtual bool MWBase::WindowManager::getCursorVisible ( ) [pure virtual]

Should the cursor be visible?

Implemented in MWGui::WindowManager.

Todo:
investigate, if we really need to expose every single lousy UI element to the outside world

Implemented in MWGui::WindowManager.

virtual bool MWBase::WindowManager::getFullHelp ( ) const [pure virtual]

Implemented in MWGui::WindowManager.

virtual std::string MWBase::WindowManager::getGameSettingString ( const std::string &  id,
const std::string &  default_ 
) [pure virtual]

Fetches a GMST string from the store, if there is no setting with the given ID or it is not a string the default string is returned.

Parameters:
idIdentifier for the GMST setting, e.g. "aName"
defaultDefault value if the GMST setting cannot be used.

Implemented in MWGui::WindowManager.

virtual MyGUI::Gui* MWBase::WindowManager::getGui ( ) const [pure virtual]

Implemented in MWGui::WindowManager.

Implemented in MWGui::WindowManager.

virtual bool MWBase::WindowManager::getJournalAllowed ( ) [pure virtual]

Implemented in MWGui::WindowManager.

Implemented in MWGui::WindowManager.

virtual MWGui::GuiMode MWBase::WindowManager::getMode ( ) const [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::getMousePosition ( int &  x,
int &  y 
) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::getMousePosition ( float &  x,
float &  y 
) [pure virtual]

Implemented in MWGui::WindowManager.

virtual std::map<int, MWMechanics::Stat<int> > MWBase::WindowManager::getPlayerAttributeValues ( ) [pure virtual]

Implemented in MWGui::WindowManager.

Implemented in MWGui::WindowManager.

Implemented in MWGui::WindowManager.

virtual std::map<int, MWMechanics::Stat<float> > MWBase::WindowManager::getPlayerSkillValues ( ) [pure virtual]
Todo:
get rid of this stuff. Move it to the respective UI element classes, if needed.

Implemented in MWGui::WindowManager.

virtual bool MWBase::WindowManager::getPlayerSleeping ( ) [pure virtual]

Implemented in MWGui::WindowManager.

virtual bool MWBase::WindowManager::getRestEnabled ( ) [pure virtual]

Implemented in MWGui::WindowManager.

Implemented in MWGui::WindowManager.

virtual std::string MWBase::WindowManager::getSelectedSpell ( ) [pure virtual]

Implemented in MWGui::WindowManager.

Implemented in MWGui::WindowManager.

Implemented in MWGui::WindowManager.

virtual bool MWBase::WindowManager::getSubtitlesEnabled ( ) [pure virtual]

Implemented in MWGui::WindowManager.

Implemented in MWGui::WindowManager.

Implemented in MWGui::WindowManager.

Implemented in MWGui::WindowManager.

virtual bool MWBase::WindowManager::getWorldMouseOver ( ) [pure virtual]

Implemented in MWGui::WindowManager.

virtual bool MWBase::WindowManager::isAllowed ( MWGui::GuiWindow  wnd) const [pure virtual]

Implemented in MWGui::WindowManager.

virtual bool MWBase::WindowManager::isConsoleMode ( ) const [pure virtual]

Implemented in MWGui::WindowManager.

virtual bool MWBase::WindowManager::isGuiMode ( ) const [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::messageBox ( const std::string &  message,
const std::vector< std::string > &  buttons = std::vector< std::string >(),
bool  showInDialogueModeOnly = false 
) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::notifyInputActionBound ( ) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::onFrame ( float  frameDuration) [pure virtual]

Implemented in MWGui::WindowManager.

WindowManager& MWBase::WindowManager::operator= ( const WindowManager ) [private]

not implemented

virtual void MWBase::WindowManager::popGuiMode ( ) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::processChangedSettings ( const Settings::CategorySettingVector changed) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::pushGuiMode ( MWGui::GuiMode  mode) [pure virtual]

Implemented in MWGui::WindowManager.

virtual int MWBase::WindowManager::readPressedButton ( ) [pure virtual]

returns the index of the pressed button or -1 if no button was pressed (->MessageBoxmanager->InteractiveMessageBox)

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::removeDialog ( OEngine::GUI::Layout dialog) [pure virtual]

Hides dialog and schedules dialog to be deleted.

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::removeGuiMode ( MWGui::GuiMode  mode) [pure virtual]

can be anywhere in the stack

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::removeStaticMessageBox ( ) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::setBounty ( int  bounty) [pure virtual]

set the current bounty value

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::setCursorVisible ( bool  visible) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::setDragDrop ( bool  dragDrop) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::setDrowningBarVisibility ( bool  visible) [pure virtual]

sets the visibility of the drowning bar

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::setDrowningTimeLeft ( float  time) [pure virtual]

Set time left for the player to start drowning (update the drowning bar)

Parameters:
timevalue from [0,20]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::setEnemy ( const MWWorld::Ptr enemy) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::setFocusObject ( const MWWorld::Ptr focus) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::setFocusObjectScreenCoords ( float  min_x,
float  min_y,
float  max_x,
float  max_y 
) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::setHMSVisibility ( bool  visible) [pure virtual]

sets the visibility of the hud health/magicka/stamina bars

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::setInteriorMapTexture ( const int  x,
const int  y 
) [pure virtual]

set the index of the map texture that should be used (for interiors)

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::setKeyFocusWidget ( MyGUI::Widget *  widget) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::setMinimapVisibility ( bool  visible) [pure virtual]

sets the visibility of the hud minimap

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::setNewGame ( bool  newgame) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::setPlayerClass ( const ESM::Class class_) [pure virtual]

set current class of player

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::setPlayerDir ( const float  x,
const float  y 
) [pure virtual]

set player view direction in map space

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::setPlayerPos ( const float  x,
const float  y 
) [pure virtual]

set player position in map space

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::setReputation ( int  reputation) [pure virtual]

set the current reputation value

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::setSelectedEnchantItem ( const MWWorld::Ptr item) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::setSelectedSpell ( const std::string &  spellId,
int  successChancePercent 
) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::setSelectedWeapon ( const MWWorld::Ptr item) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::setSneakVisibility ( bool  visible) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::setSpellVisibility ( bool  visible) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::setValue ( const std::string &  id,
const MWMechanics::Stat< int > &  value 
) [pure virtual]

Set value for the given ID.

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::setValue ( int  parSkill,
const MWMechanics::Stat< float > &  value 
) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::setValue ( const std::string &  id,
const MWMechanics::DynamicStat< float > &  value 
) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::setValue ( const std::string &  id,
const std::string &  value 
) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::setValue ( const std::string &  id,
int  value 
) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::setWeaponVisibility ( bool  visible) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::showCompanionWindow ( MWWorld::Ptr  actor) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::showCrosshair ( bool  show) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::showSoulgemDialog ( MWWorld::Ptr  item) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::startEnchanting ( MWWorld::Ptr  actor) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::startRecharge ( MWWorld::Ptr  soulgem) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::startRepair ( MWWorld::Ptr  actor) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::startRepairItem ( MWWorld::Ptr  item) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::startSelfEnchanting ( MWWorld::Ptr  soulgem) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::startSpellMaking ( MWWorld::Ptr  actor) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::startTraining ( MWWorld::Ptr  actor) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::staticMessageBox ( const std::string &  message) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::toggleFogOfWar ( ) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::toggleFullHelp ( ) [pure virtual]

show extra info in item tooltips (owner, script)

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::toggleHud ( ) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::toggleVisible ( MWGui::GuiWindow  wnd) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::unsetForceHide ( MWGui::GuiWindow  wnd) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::unsetSelectedSpell ( ) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::unsetSelectedWeapon ( ) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::update ( ) [pure virtual]

Should be called each frame to update windows/gui elements. This could mean updating sizes of gui elements or opening new dialogs.

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::updatePlayer ( ) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::updateSkillArea ( ) [pure virtual]

update display of skills, factions, birth sign, reputation and bounty

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::wakeUpPlayer ( ) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::windowResized ( int  x,
int  y 
) [pure virtual]

Implemented in MWGui::WindowManager.

virtual void MWBase::WindowManager::wmUpdateFps ( float  fps,
unsigned int  triangleCount,
unsigned int  batchCount 
) [pure virtual]

Implemented in MWGui::WindowManager.


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