ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

#include <widget.h>

Inheritance diagram for GUI::OptionsContainerWidget:
Collaboration diagram for GUI::OptionsContainerWidget:

List of all members.

Public Member Functions

 OptionsContainerWidget (GuiObject *boss, const Common::String &name, const Common::String &dialogLayout, bool scrollable, const Common::String &domain)
 ~OptionsContainerWidget () override
virtual void load ()=0
 Implementing classes should (re)initialize their widgets with state from the configuration domain.
virtual bool save ()=0
 Implementing classes should save their widget's state to the configuration domain.
void setParentDialog (Dialog *parentDialog)
void setDomain (const Common::String &domain)

Protected Types

enum  { kReflowCmd = 'REFL' }

Protected Member Functions

void reflowLayout () override
void drawWidget () override
bool containsWidget (Widget *widget) const override
WidgetfindWidget (int x, int y) override
void removeWidget (Widget *widget) override
GuiObjectwidgetsBoss ()
 The pareent object to use when creating child widgets.
virtual void defineLayout (ThemeEval &layouts, const Common::String &layoutName, const Common::String &overlayedLayout) const
 Child classes can override this method to define the layout used by the contained widgets in the layout system.

Protected Attributes

Common::String _domain
const Common::String _dialogLayout
Dialog_parentDialog

Private Attributes

ScrollContainerWidget_scrollContainer

Detailed Description

Definition at line 452 of file widget.h.


Member Enumeration Documentation

anonymous enum [protected]
Enumerator:
kReflowCmd 

The command that gets sent when the scroll container needs to reflow its contents.

Definition at line 479 of file widget.h.


Constructor & Destructor Documentation

GUI::OptionsContainerWidget::OptionsContainerWidget ( GuiObject boss,
const Common::String name,
const Common::String dialogLayout,
bool  scrollable,
const Common::String domain 
)
Parameters:
widgetsBoss parent widget for the container widget
name name of the container widget in the layout system
dialogLayout name of the layout used by the contained widgets, empty string for manually layed out widgets
scrollable whether the container is made scrollable through a ScrollContainerWidget
domain the configuration manager domain this widget is meant to edit

Definition at line 921 of file widget.cpp.

GUI::OptionsContainerWidget::~OptionsContainerWidget (  )  [override]

Definition at line 936 of file widget.cpp.


Member Function Documentation

bool GUI::OptionsContainerWidget::containsWidget ( Widget widget  )  const [override, protected, virtual]

Reimplemented from GUI::Widget.

Definition at line 961 of file widget.cpp.

virtual void GUI::OptionsContainerWidget::defineLayout ( ThemeEval layouts,
const Common::String layoutName,
const Common::String overlayedLayout 
) const [inline, protected, virtual]

Child classes can override this method to define the layout used by the contained widgets in the layout system.

This is called only when the layout was not found in the theme definition files.

Definition at line 499 of file widget.h.

void GUI::OptionsContainerWidget::drawWidget (  )  [inline, override, protected, virtual]

Implements GUI::Widget.

Definition at line 486 of file widget.h.

Widget * GUI::OptionsContainerWidget::findWidget ( int  x,
int  y 
) [override, protected, virtual]

Reimplemented from GUI::Widget.

Definition at line 965 of file widget.cpp.

virtual void GUI::OptionsContainerWidget::load (  )  [pure virtual]

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

Implemented in Common::RemapWidget, and GUI::ExtraGuiOptionsWidget.

void GUI::OptionsContainerWidget::reflowLayout (  )  [override, protected, virtual]

Reimplemented from GUI::GuiObject.

Definition at line 939 of file widget.cpp.

void GUI::OptionsContainerWidget::removeWidget ( Widget widget  )  [override, protected, virtual]

Reimplemented from GUI::GuiObject.

Definition at line 970 of file widget.cpp.

virtual bool GUI::OptionsContainerWidget::save (  )  [pure virtual]

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()

Implemented in Common::RemapWidget, and GUI::ExtraGuiOptionsWidget.

void GUI::OptionsContainerWidget::setDomain ( const Common::String domain  )  [inline]

Definition at line 476 of file widget.h.

void GUI::OptionsContainerWidget::setParentDialog ( Dialog parentDialog  )  [inline]

Definition at line 475 of file widget.h.

GuiObject * GUI::OptionsContainerWidget::widgetsBoss (  )  [protected]

The pareent object to use when creating child widgets.

Definition at line 975 of file widget.cpp.


Member Data Documentation

Definition at line 502 of file widget.h.

Definition at line 501 of file widget.h.

Definition at line 504 of file widget.h.


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


Generated on Sat Aug 8 2020 05:03:34 for ResidualVM by doxygen 1.7.1
curved edge   curved edge