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

#include <popup.h>

Inheritance diagram for GUI::PopUpWidget:
GUI::Widget GUI::CommandSender GUI::GuiObject GUI::CommandReceiver

Public Member Functions

 PopUpWidget (GuiObject *boss, const Common::String &name, const Common::U32String &tooltip=Common::U32String(), uint32 cmd=0)
 
 PopUpWidget (GuiObject *boss, int x, int y, int w, int h, const Common::U32String &tooltip=Common::U32String(), uint32 cmd=0)
 
void handleMouseDown (int x, int y, int button, int clickCount) override
 
void handleMouseWheel (int x, int y, int direction) override
 
void appendEntry (const Common::U32String &entry, uint32 tag=(uint32) -1)
 
void appendEntry (const Common::String &entry, uint32 tag=(uint32) -1)
 
void clearEntries ()
 
int numEntries ()
 
void setSelected (int item)
 
void setSelectedTag (uint32 tag)
 
int getSelected () const
 
uint32 getSelectedTag () const
 
void handleMouseEntered (int button) override
 
void handleMouseLeft (int button) override
 
void reflowLayout () override
 
- Public Member Functions inherited from GUI::Widget
 Widget (GuiObject *boss, int x, int y, int w, int h, bool scale, const Common::U32String &tooltip=Common::U32String())
 
 Widget (GuiObject *boss, int x, int y, int w, int h, const Common::U32String &tooltip=Common::U32String())
 
 Widget (GuiObject *boss, const Common::String &name, const Common::U32String &tooltip=Common::U32String())
 
void init ()
 
void setNext (Widget *w)
 
void setBoss (GuiObject *newBoss)
 
Widget * next ()
 
int16 getAbsX () const override
 
int16 getAbsY () const override
 
virtual void setPos (int x, int y)
 
virtual void setSize (int w, int h)
 
virtual void getMinSize (int &minWidth, int &minHeight)
 
virtual void handleMouseUp (int x, int y, int button, int clickCount)
 
virtual void handleMouseMoved (int x, int y, int button)
 
virtual bool handleKeyDown (Common::KeyState state)
 
virtual bool handleKeyUp (Common::KeyState state)
 
virtual void handleOtherEvent (const Common::Event &evt)
 
virtual void handleTickle ()
 
virtual void markAsDirty ()
 
virtual void draw ()
 
void receivedFocus ()
 
void lostFocus ()
 
virtual bool wantsFocus ()
 
uint32 getType () const
 
void setFlags (int flags)
 
void clearFlags (int flags)
 
int getFlags () const
 
void setEnabled (bool e)
 
bool isEnabled () const
 
void setVisible (bool e)
 
bool isVisible () const override
 
bool useRTL () const
 
uint8 parseHotkey (const Common::U32String &label)
 
Common::U32String cleanupHotkey (const Common::U32String &label)
 
bool hasTooltip () const
 
const Common::U32String & getTooltip () const
 
void setTooltip (const Common::U32String &tooltip)
 
void setTooltip (const Common::String &tooltip)
 
virtual bool containsWidget (Widget *) const
 
void read (const Common::U32String &str)
 
- 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 getChildX () const
 
virtual int16 getChildY () const
 
virtual uint16 getWidth () const
 
virtual uint16 getHeight () const
 
virtual void removeWidget (Widget *widget)
 
virtual bool isPointIn (int x, int y)
 
virtual Common::Rect getClipRect () const
 
virtual void handleTooltipUpdate (int x, int y)
 
- Public Member Functions inherited from GUI::CommandSender
 CommandSender (CommandReceiver *target)
 
void setTarget (CommandReceiver *target)
 
CommandReceiver * getTarget () const
 
virtual void sendCommand (uint32 cmd, uint32 data)
 

Protected Member Functions

void drawWidget () override
 
- Protected Member Functions inherited from GUI::Widget
void updateState (int oldFlags, int newFlags)
 
virtual void receivedFocusWidget ()
 
virtual void lostFocusWidget ()
 
virtual Widget * findWidget (int x, int y)
 
void releaseFocus () override
 
void handleCommand (CommandSender *sender, uint32 cmd, uint32 data) override
 

Protected Attributes

EntryList _entries
 
int _selectedItem
 
int _leftPadding
 
int _rightPadding
 
uint32 _cmd
 
- Protected Attributes inherited from GUI::Widget
uint32 _type
 
GuiObject * _boss
 
Widget * _next
 
bool _hasFocus
 
ThemeEngine::WidgetStateInfo _state
 
Common::U32String _tooltip
 
- 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
 
- Protected Attributes inherited from GUI::CommandSender
CommandReceiver * _target
 

Additional Inherited Members

- Static Public Member Functions inherited from GUI::Widget
static Widget * findWidgetInChain (Widget *start, int x, int y)
 
static Widget * findWidgetInChain (Widget *start, const char *name)
 
static bool containsWidgetInChain (Widget *start, Widget *search)
 

Detailed Description

Popup or dropdown widget which, when clicked, "pop up" a list of items and lets the user pick on of them.

Implementation wise, when the user selects an item, then the specified command is broadcast, with data being equal to the tag value of the selected entry.

Member Function Documentation

◆ setSelected()

void GUI::PopUpWidget::setSelected ( int  item)

Select the entry at the given index.

◆ setSelectedTag()

void GUI::PopUpWidget::setSelectedTag ( uint32  tag)

Select the first entry matching the given tag.

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