Inheritance diagram for GUI::OptionsContainerWidget:

Public Member Functions
	OptionsContainerWidget (GuiObject *boss, const Common::String &name, const Common::String &dialogLayout, bool scrollable, const Common::String &domain)

virtual void	load ()=0

virtual bool	save ()=0

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)

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	handleMouseDown (int x, int y, int button, int clickCount)

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

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

virtual bool	isPointIn (int x, int y)

virtual Common::Rect	getClipRect () const

virtual void	handleTooltipUpdate (int x, int y)

Protected Types
enum	{ kReflowCmd = 'REFL' }

Protected Member Functions
void	reflowLayout () override

void	drawWidget () override

bool	containsWidget (Widget *widget) const override

Widget *	findWidget (int x, int y) override

void	removeWidget (Widget *widget) override

GuiObject *	widgetsBoss ()

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

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)

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

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

Constructor & Destructor Documentation

◆ OptionsContainerWidget()

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

Member Function Documentation

◆ load()

virtual void GUI::OptionsContainerWidget::load ( )

pure virtual

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

Implemented in Scumm::MI1CdGameOptionsWidget, Scumm::LoomVgaGameOptionsWidget, Scumm::LoomMonkeyMacGameOptionsWidget, Scumm::LoomEgaGameOptionsWidget, Scumm::ScummGameOptionsWidget, Scumm::ScummOptionsContainerWidget, GUI::ExtraGuiOptionsWidget, Sci::OptionsWidget, Common::RemapWidget, Neverhood::NeverhoodOptionsWidget, Twp::TwpOptionsContainerWidget, and LibretroOptionsWidget.

◆ save()

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 Scumm::MI1CdGameOptionsWidget, Scumm::LoomVgaGameOptionsWidget, Scumm::LoomMonkeyMacGameOptionsWidget, Scumm::LoomEgaGameOptionsWidget, Scumm::ScummGameOptionsWidget, Scumm::ScummOptionsContainerWidget, GUI::ExtraGuiOptionsWidget, Sci::OptionsWidget, Common::RemapWidget, Neverhood::NeverhoodOptionsWidget, Twp::TwpOptionsContainerWidget, and LibretroOptionsWidget.

◆ hasKeys()

virtual bool GUI::OptionsContainerWidget::hasKeys ( )

inlinevirtual

Implementing classes should return if there are relevant keys set in the configuration domain

Returns: true if there are relevant keys set in the configuration domain

◆ setEnabled()

virtual void GUI::OptionsContainerWidget::setEnabled ( bool e )

inlinevirtual

Implementing classes should enable or disable all active widgets

◆ widgetsBoss()

GuiObject* GUI::OptionsContainerWidget::widgetsBoss ( )

protected

The pareent object to use when creating child widgets

◆ defineLayout()

virtual void GUI::OptionsContainerWidget::defineLayout	(	ThemeEval &	layouts,
		const Common::String &	layoutName,
		const Common::String &	overlayedLayout
	)		const

inlineprotectedvirtual

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.

Reimplemented in GUI::ExtraGuiOptionsWidget.

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

gui/widget.h

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members