ScummVM API documentation
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
GUI::LauncherDialog Class Referenceabstract
Inheritance diagram for GUI::LauncherDialog:
GUI::Dialog GUI::GuiObject GUI::CommandReceiver

Public Member Functions

 LauncherDialog (const Common::String &dialogName)
 
void rebuild ()
 
void handleCommand (CommandSender *sender, uint32 cmd, uint32 data) override
 
virtual LauncherDisplayType getType () const =0
 
int run ()
 
void handleKeyDown (Common::KeyState state) override
 
void handleKeyUp (Common::KeyState state) override
 
void handleOtherEvent (const Common::Event &evt) override
 
bool doGameDetection (const Common::Path &path)
 
Common::String getGameConfig (int item, Common::String key)
 
- 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)
 
- 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 addLayoutChooserButtons ()
 
ButtonWidget * createSwitchButton (const Common::String &name, const Common::U32String &desc, const Common::U32String &tooltip, const char *image, uint32 cmd=0)
 
void reflowLayout () override
 
virtual void updateListing (int selPos=-1)=0
 
virtual int getNextPos (int item)=0
 
virtual void updateButtons ()=0
 
virtual void build ()
 
void clean ()
 
void open () override
 
void close () override
 
virtual void addGame ()
 
void massAddGame ()
 
void removeGame (int item)
 
void editGame (int item)
 
void recordGame (int item)
 
void loadGame (int item)
 
Common::Array< LauncherEntry > generateEntries (const Common::ConfigManager::DomainMap &domains)
 
virtual void selectTarget (const Common::String &target)=0
 
virtual int getSelected ()=0
 
- Protected Member Functions inherited from GUI::Dialog
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 handleMouseMoved (int x, int y, int button)
 
virtual void handleMouseLeft (int button)
 
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

EditTextWidget * _searchWidget
 
GraphicsWidget * _logo
 
GraphicsWidget * _searchPic
 
GraphicsWidget * _groupPic
 
StaticTextWidget * _searchDesc
 
ButtonWidget * _searchClearButton
 
ButtonWidget * _addButton
 
Widget * _removeButton
 
Widget * _startButton
 
ButtonWidget * _loadButton
 
Widget * _editButton
 
Common::StringArray _domains
 
BrowserDialog * _browser
 
SaveLoadChooser * _loadDialog
 
PopUpWidget * _grpChooserPopup
 
StaticTextWidget * _grpChooserDesc
 
GroupingMethod _groupBy
 
Common::String _title
 
Common::String _search
 
MetadataParser _metadataParser
 
ButtonWidget * _listButton
 
ButtonWidget * _gridButton
 
- 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
 

Member Function Documentation

◆ addLayoutChooserButtons()

void GUI::LauncherDialog::addLayoutChooserButtons ( )
protected

Create two buttons to choose between grid display and list display in the launcher.

◆ updateListing()

virtual void GUI::LauncherDialog::updateListing ( int  selPos = -1)
protectedpure virtual

Fill the list widget with all currently configured targets, and trigger a redraw.

◆ addGame()

virtual void GUI::LauncherDialog::addGame ( )
protectedvirtual

Handle "Add game..." button.

◆ removeGame()

void GUI::LauncherDialog::removeGame ( int  item)
protected

Handle "Remove game..." button.

◆ editGame()

void GUI::LauncherDialog::editGame ( int  item)
protected

Handle "Edit game..." button.

◆ recordGame()

void GUI::LauncherDialog::recordGame ( int  item)
protected

Handle "Record..." button.

◆ loadGame()

void GUI::LauncherDialog::loadGame ( int  item)
protected

Handle "Load..." button.

◆ selectTarget()

virtual void GUI::LauncherDialog::selectTarget ( const Common::String &  target)
protectedpure virtual

Select the target with the given name in the launcher game list. Also scrolls the list so that the newly selected item is visible.

name of target to select

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