ScummVM API documentation
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
GUI::PopUpDialog Class Reference

#include <popup.h>

Inheritance diagram for GUI::PopUpDialog:
GUI::Dialog GUI::GuiObject GUI::CommandReceiver

Public Member Functions

 PopUpDialog (Widget *boss, const Common::String &name, int clickX, int clickY)
 
void open () override
 
void reflowLayout () override
 
void drawDialog (DrawLayer layerToDraw) override
 
void handleMouseUp (int x, int y, int button, int clickCount) override
 
void handleMouseWheel (int x, int y, int direction) override
 
void handleMouseMoved (int x, int y, int button) override
 
void handleMouseLeft (int button) override
 
void handleKeyDown (Common::KeyState state) override
 
void setPosition (int x, int y)
 
void setPadding (int left, int right)
 
void setLineHeight (int lineHeight)
 
void setWidth (uint16 width)
 
void appendEntry (const Common::U32String &entry)
 
void clearEntries ()
 
void setSelection (int item)
 
- Public Member Functions inherited from GUI::Dialog
 Dialog (int x, int y, int w, int h, bool scale=false)
 
 Dialog (const Common::String &name)
 
virtual int runModal ()
 
bool isVisible () const override
 
bool isMouseUpdatedOnFocus () const
 
void releaseFocus () override
 
void setFocusWidget (Widget *widget)
 
Widget * getFocusWidget ()
 
bool isDragging () const
 
void setTickleWidget (Widget *widget)
 
void unSetTickleWidget ()
 
Widget * getTickleWidget ()
 
virtual void lostFocus ()
 
virtual void receivedFocus (int x=-1, int y=-1)
 
virtual void close ()
 
- Public Member Functions inherited from GUI::GuiObject
 GuiObject (int x, int y, int w, int h, bool scale=false)
 
 GuiObject (const Common::String &name)
 
virtual void setTextDrawableArea (const Common::Rect &r)
 
virtual void resize (int x, int y, int w, int h, bool scale=true)
 
virtual Widget * addChild (Widget *newChild)
 
virtual int16 getRelX () const
 
virtual int16 getRelY () const
 
virtual int16 getAbsX () const
 
virtual int16 getAbsY () const
 
virtual int16 getChildX () const
 
virtual int16 getChildY () const
 
virtual uint16 getWidth () const
 
virtual uint16 getHeight () const
 
virtual bool isPointIn (int x, int y)
 
virtual Common::Rect getClipRect () const
 
virtual void handleTooltipUpdate (int x, int y)
 

Protected Types

typedef Common::Array< Common::U32String > EntryList
 

Protected Member Functions

void drawMenuEntry (int entry, bool hilite)
 
int findItem (int x, int y) const
 
bool isMouseDown ()
 
void moveUp ()
 
void moveDown ()
 
void read (const Common::U32String &str)
 
- Protected Member Functions inherited from GUI::Dialog
void markWidgetsAsDirty ()
 
void drawWidgets ()
 
virtual void handleTickle ()
 
virtual void handleMouseDown (int x, int y, int button, int clickCount)
 
virtual void handleKeyUp (Common::KeyState state)
 
virtual void handleOtherEvent (const Common::Event &evt)
 
void handleCommand (CommandSender *sender, uint32 cmd, uint32 data) override
 
Widget * findWidget (int x, int y)
 
Widget * findWidget (const char *name)
 
void removeWidget (Widget *widget) override
 
void setMouseUpdatedOnFocus (bool mouseUpdatedOnFocus)
 
void setDefaultFocusedWidget ()
 
void setResult (int result)
 
int getResult () const
 

Protected Attributes

Widget * _boss
 
int _clickX
 
int _clickY
 
int _selection
 
int _initialSelection
 
uint32 _openTime
 
bool _twoColumns
 
int _entriesPerColumn
 
int _leftPadding
 
int _rightPadding
 
int _lineHeight
 
int _lastRead
 
EntryList _entries
 
- Protected Attributes inherited from GUI::Dialog
Widget * _mouseWidget
 
Widget * _focusedWidget
 
Widget * _dragWidget
 
Widget * _tickleWidget
 
bool _visible
 
bool _mouseUpdatedOnFocus
 
ThemeEngine::DialogBackground _backgroundType
 
- Protected Attributes inherited from GUI::GuiObject
Common::Rect _textDrawableArea
 
int16 _x
 
int16 _y
 
uint16 _w
 
uint16 _h
 
bool _useRTL
 
const Common::String _name
 
Widget * _firstWidget
 

Detailed Description

A small dialog showing a list of items and allowing the user to chose one of them

Used by PopUpWidget and DropdownButtonWidget.

Member Function Documentation

◆ drawDialog()

void GUI::PopUpDialog::drawDialog ( DrawLayer  layerToDraw)
overridevirtual

Draw the dialog in its entirety (background and widgets)

Reimplemented from GUI::Dialog.

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