ScummVM API documentation
Common::RemapWidget Class Reference
Inheritance diagram for Common::RemapWidget:
GUI::OptionsContainerWidget GUI::Widget GUI::GuiObject GUI::CommandReceiver

Classes

struct  ActionRow
 
struct  KeymapTitleRow
 

Public Types

typedef Common::Array< Keymap * > KeymapArray
 

Public Member Functions

 RemapWidget (GuiObject *boss, const Common::String &name, const KeymapArray &keymaps)
 
void load () override
 
bool save () override
 
void handleInputChanged ()
 
void handleCommand (GUI::CommandSender *sender, uint32 cmd, uint32 data) override
 
void handleMouseDown (int x, int y, int button, int clickCount) override
 
void handleTickle () override
 
- Public Member Functions inherited from GUI::OptionsContainerWidget
 OptionsContainerWidget (GuiObject *boss, const Common::String &name, const Common::String &dialogLayout, bool scrollable, const Common::String &domain)
 
virtual bool hasKeys ()
 
virtual void setEnabled (bool e)
 
void setParentDialog (Dialog *parentDialog)
 
void setDomain (const Common::String &domain)
 
uint16 getWidth () const 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)
 
Widgetnext ()
 
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 handleMouseEntered (int button)
 
virtual void handleMouseLeft (int button)
 
virtual void handleMouseMoved (int x, int y, int button)
 
void handleMouseWheel (int x, int y, int direction) override
 
virtual bool handleKeyDown (Common::KeyState state)
 
virtual bool handleKeyUp (Common::KeyState state)
 
virtual void handleOtherEvent (const Common::Event &evt)
 
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::U32StringgetTooltip () const
 
void setTooltip (const Common::U32String &tooltip)
 
void setTooltip (const Common::String &tooltip)
 
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 WidgetaddChild (Widget *newChild)
 
virtual int16 getRelX () const
 
virtual int16 getRelY () const
 
virtual int16 getChildX () const
 
virtual int16 getChildY () 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 loadKeymap ()
 
void refreshKeymap ()
 
void reflowActionWidgets ()
 
void clearMapping (uint actionIndex)
 
void resetMapping (uint actionIndex)
 
void resetKeymap (uint actionIndex)
 
void startRemapping (uint actionIndex)
 
void stopRemapping ()
 
- Protected Member Functions inherited from GUI::OptionsContainerWidget
void reflowLayout () override
 
void drawWidget () override
 
bool containsWidget (Widget *widget) const override
 
WidgetfindWidget (int x, int y) override
 
void removeWidget (Widget *widget) override
 
GuiObjectwidgetsBoss ()
 
virtual void defineLayout (ThemeEval &layouts, const Common::String &layoutName, const Common::String &overlayedLayout) const
 
- Protected Member Functions inherited from GUI::Widget
void updateState (int oldFlags, int newFlags)
 
virtual void receivedFocusWidget ()
 
virtual void lostFocusWidget ()
 
void releaseFocus () override
 
void handleCommand (CommandSender *sender, uint32 cmd, uint32 data) override
 

Protected Attributes

KeymapArray _keymapTable
 
InputWatcher_remapInputWatcher
 
Keymap_remapKeymap
 
Action_remapAction
 
uint32 _remapTimeout
 
bool _changes
 
Array< ActionRow_actions
 
HashMap< Keymap *, KeymapTitleRow_keymapSeparators
 
- Protected Attributes inherited from GUI::OptionsContainerWidget
Common::String _domain
 
const Common::String _dialogLayout
 
Dialog_parentDialog
 
- 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
 

Static Protected Attributes

static const uint32 kRemapMinTimeoutDelay = 3000
 

Additional Inherited Members

- Static Public Member Functions inherited from GUI::Widget
static WidgetfindWidgetInChain (Widget *start, int x, int y)
 
static WidgetfindWidgetInChain (Widget *start, const char *name)
 
static bool containsWidgetInChain (Widget *start, Widget *search)
 
- Protected Types inherited from GUI::OptionsContainerWidget
enum  { kReflowCmd = 'REFL' }
 

Member Function Documentation

◆ load()

void Common::RemapWidget::load ( )
overridevirtual

Implementing classes should (re)initialize their widgets with state from the configuration domain

Implements GUI::OptionsContainerWidget.

◆ save()

bool Common::RemapWidget::save ( )
overridevirtual

Implementing classes should save their widget's state to the configuration domain

Returns
true if changes were made to the configuration since the last call to load()

Implements GUI::OptionsContainerWidget.


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