ScummVM API documentation
Ultima::Shared::Gfx::Popup Class Reference

#include <popup.h>

Inheritance diagram for Ultima::Shared::Gfx::Popup:
Ultima::Shared::Gfx::VisualItem Ultima::Shared::NamedItem Ultima::Shared::TreeItem Ultima::Shared::MessageTarget Ultima::Shared::BaseObject Ultima::Shared::Gfx::CharacterInput Ultima::Shared::Gfx::TextInput Ultima::Ultima1::U1Dialogs::Dialog Ultima::Ultima1::U1Dialogs::BuySellDialog Ultima::Ultima1::U1Dialogs::FullScreenDialog Ultima::Ultima1::U1Dialogs::King Ultima::Ultima1::U1Dialogs::Armoury Ultima::Ultima1::U1Dialogs::Grocery Ultima::Ultima1::U1Dialogs::Magic Ultima::Ultima1::U1Dialogs::Tavern Ultima::Ultima1::U1Dialogs::Transports Ultima::Ultima1::U1Dialogs::Weaponry Ultima::Ultima1::U1Dialogs::Combat Ultima::Ultima1::U1Dialogs::Drop Ultima::Ultima1::U1Dialogs::Ready Ultima::Ultima1::U1Dialogs::Stats

Public Member Functions

 Popup (GameBase *game)
 
 ~Popup () override
 
void show (TreeItem *respondTo=nullptr)
 
virtual void hide ()
 
- Public Member Functions inherited from Ultima::Shared::Gfx::VisualItem
 VisualItem (TreeItem *parent=nullptr)
 
 VisualItem (const Rect &r, TreeItem *parent=nullptr)
 
 VisualItem (const Common::String &name, TreeItem *parent=nullptr)
 
 VisualItem (const Common::String &name, const Rect &r, TreeItem *parent=nullptr)
 
virtual void draw ()
 
VisualSurface getSurface ()
 
const RectgetBounds ()
 
void setBounds (const Rect &r)
 
void setPosition (const Point &pt)
 
virtual void setDirty (bool dirty=true)
 
void clearDirty ()
 
virtual bool isDirty () const
 
void setView (const Common::String &viewName)
 
void setPopup (Gfx::Popup *popup)
 
void setView ()
 
- Public Member Functions inherited from Ultima::Shared::NamedItem
 NamedItem (const Common::String &name)
 
const Common::String getName () const override
 
- Public Member Functions inherited from Ultima::Shared::TreeItem
virtual bool isEquals (const Common::String &name, int maxLen=0) const
 
virtual int compareTo (const Common::String &name, int maxLen=0) const
 
virtual void viewChange ()
 
TreeItemgetParent () const
 
GamegetGame ()
 
const GamegetGame () const
 
Gfx::VisualItemgetView ()
 
TreeItemgetNextSibling () const
 
TreeItemgetPriorSibling () const
 
TreeItemgetLastSibling ()
 
TreeItemgetFirstChild () const
 
TreeItemgetLastChild () const
 
TreeItemscan (TreeItem *item) const
 
TreeItemfindChildInstanceOf (const ClassDef &classDef) const
 
TreeItemfindNextInstanceOf (const ClassDef &classDef, TreeItem *startItem) const
 
void addUnder (TreeItem *newParent)
 
void addChild (TreeItem *child)
 
void setParent (TreeItem *newParent)
 
void addSibling (TreeItem *item)
 
void moveUnder (TreeItem *newParent)
 
void destroyAll ()
 
int destroyChildren ()
 
void detach ()
 
void attach (TreeItem *item)
 
NamedItemfindByName (const Common::String &name)
 
- Public Member Functions inherited from Ultima::Shared::BaseObject
virtual ::Ultima::Shared::ClassDef getType () const
 
bool isInstanceOf (const ClassDef &classDef) const
 

Public Attributes

 CLASSDEF
 
- Public Attributes inherited from Ultima::Shared::Gfx::VisualItem
 CLASSDEF
 
- Public Attributes inherited from Ultima::Shared::NamedItem
Common::String _name
 
 CLASSDEF
 
- Public Attributes inherited from Ultima::Shared::TreeItem
 CLASSDEF
 
- Public Attributes inherited from Ultima::Shared::MessageTarget
 CLASSDEF
 

Protected Attributes

GameBase_game
 
VisualItem_parentView
 
TreeItem_respondTo
 
- Protected Attributes inherited from Ultima::Shared::Gfx::VisualItem
Rect _bounds
 
bool _isDirty
 

Additional Inherited Members

- Static Public Member Functions inherited from Ultima::Shared::BaseObject
::Ultima::Shared::ClassDef type ()
 
- Protected Member Functions inherited from Ultima::Shared::MessageTarget
virtual const Ultima::Shared::MSGMAPgetMessageMap () const
 
- Static Protected Member Functions inherited from Ultima::Shared::MessageTarget
static const Ultima::Shared::MSGMAPgetThisMessageMap ()
 

Detailed Description

Base class for graphic elements that "pop up" on top of existing views. This includes things like dialogs, text input, etc.

Constructor & Destructor Documentation

◆ Popup()

Ultima::Shared::Gfx::Popup::Popup ( GameBase game)

Constructor

◆ ~Popup()

Ultima::Shared::Gfx::Popup::~Popup ( )
override

Destructor

Member Function Documentation

◆ show()

void Ultima::Shared::Gfx::Popup::show ( TreeItem respondTo = nullptr)

Show the popup

Parameters
respondToElement to send any response to when the popup closes. If not provided, any response goes to the active view

◆ hide()

virtual void Ultima::Shared::Gfx::Popup::hide ( )
virtual

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