ScummVM API documentation
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
GUI::Dialog Class Reference
Inheritance diagram for GUI::Dialog:
GUI::GuiObject GUI::CommandReceiver Bbvs::MainMenu Grim::InputDialog Grim::MD5CheckDialog GUI::AboutDialog GUI::BrowserDialog GUI::ChooserDialog GUI::CloudConnectionWizard GUI::ConsoleDialog GUI::DLCsDialog GUI::DownloadDialog GUI::DownloadDLCsDialog GUI::DownloadPacksDialog GUI::EditRecordDialog GUI::FileBrowserDialog GUI::FluidSynthSettingsDialog GUI::GridItemTray GUI::HelpDialog GUI::LauncherDialog GUI::MassAddDialog GUI::MessageDialog GUI::OnScreenDialog GUI::OptionsDialog GUI::PopUpDialog GUI::PredictiveDialog GUI::RecorderDialog GUI::RemoteBrowserDialog GUI::SaveLoadChooserDialog GUI::SavenameDialog GUI::ShaderBrowserDialog GUI::TextViewerDialog GUI::ThemeBrowser GUI::Tooltip GUI::UnknownGameDialog GUI::UpdatesDialog Hugo::EntryDialog Hugo::TopMenu MainMenuDialog Mohawk::InfoDialog N3DS::OptionsDialog Scumm::CreateSessionDialog Scumm::LoomTownsDifficultyDialog Scumm::ScummDialog Scumm::SessionSelectorDialog Scumm::ValueDisplayDialog Testbed::TestbedInteractionDialog Testbed::TestbedOptionsDialog Ultima::Nuvie::KeyHelpDialog WiiOptionsDialog

Public Member Functions

 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 ()
 
void reflowLayout () override
 
virtual void lostFocus ()
 
virtual void receivedFocus (int x=-1, int y=-1)
 
virtual void open ()
 
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 Member Functions

void markWidgetsAsDirty ()
 
virtual void drawDialog (DrawLayer layerToDraw)
 
void drawWidgets ()
 
virtual void handleTickle ()
 
virtual void handleMouseDown (int x, int y, int button, int clickCount)
 
virtual void handleMouseUp (int x, int y, int button, int clickCount)
 
virtual void handleMouseWheel (int x, int y, int direction) override
 
virtual void handleKeyDown (Common::KeyState state)
 
virtual void handleKeyUp (Common::KeyState state)
 
virtual void handleMouseMoved (int x, int y, int button)
 
virtual void handleMouseLeft (int button)
 
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 * _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
 

Member Function Documentation

◆ markWidgetsAsDirty()

void GUI::Dialog::markWidgetsAsDirty ( )
protected

Recursively mark all the widgets in this dialog as dirty so they are redrawn

◆ drawDialog()

virtual void GUI::Dialog::drawDialog ( DrawLayer  layerToDraw)
protectedvirtual

Draw the dialog in its entirety (background and widgets)

Reimplemented in GUI::ConsoleDialog, Scumm::ValueDisplayDialog, GUI::PopUpDialog, GUI::TextViewerDialog, GUI::AboutDialog, and GUI::Tooltip.

◆ drawWidgets()

void GUI::Dialog::drawWidgets ( )
protected

Draw only the dialog's widgets

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