GUI Namespace Reference

Classes
class	AboutDialog
class	Actions
class	AccelerateInterpolator
class	AlphaAnimation
class	Animation
class	DeccelerateInterpolator
class	Drawable
class	Interpolator
class	ParallelAnimation
class	RepeatAnimationWrapper
class	ScaleAnimation
class	SequenceAnimationComposite
class	Condition
class	WaitForConditionAnimation
	Used for delaying the animation sequence until a certain condition has been met. More...
class	BrowserDialog
class	ChooserDialog
class	ConsoleDialog
struct	ArchiveMemberLess
class	Debugger
class	Dialog
class	DownloadDialog
class	DomainEditTextWidget
class	EditGameDialog
class	EditRecordDialog
class	FileBrowserDialog
class	FluidSynthSettingsDialog
class	GuiManager
	GUI manager singleton. More...
class	Key
class	KeysDialog
class	LauncherDialog
struct	GameTargetLess
struct	GameDescLess
class	MassAddDialog
class	MessageDialog
	Simple message dialog ("alert box"): presents a text message in a dialog with up to two buttons. More...
class	TimedMessageDialog
	Timed message dialog: displays a message to the user for brief time period. More...
class	CommandReceiver
class	CommandSender
class	GuiObject
class	OnScreenDialog
class	OptionsDialog
class	GlobalOptionsDialog
class	PredictiveDialog
class	RecorderDialog
class	RemoteBrowserDialog
class	SaveLoadChooserDialog
class	SaveLoadChooserSimple
class	SavenameDialog
class	SaveLoadChooserGrid
class	SaveLoadChooser
class	StorageWizardDialog
class	ThemeBrowser
struct	TextDrawData
struct	TextColorData
struct	WidgetDrawData
struct	DrawDataInfo
class	ThemeEngine
class	ThemeEval
class	ThemeLayout
class	ThemeLayoutMain
class	ThemeLayoutStacked
class	ThemeLayoutWidget
class	ThemeLayoutTabWidget
class	ThemeLayoutSpacing
struct	TextDataInfo
struct	TextColorDataInfo
class	ThemeParser
class	Tooltip
class	UnknownGameDialog
class	UpdatesDialog
	Wizard for updates opt-in. More...
class	Widget
class	StaticTextWidget
class	ButtonWidget
class	PicButtonWidget
class	CheckboxWidget
class	RadiobuttonGroup
class	RadiobuttonWidget
class	SliderWidget
class	GraphicsWidget
class	ContainerWidget
class	EditableWidget
	Base class for widgets which need to edit text, like ListWidget and EditTextWidget. More...
class	EditTextWidget
class	ListWidget
class	PopUpDialog
class	PopUpWidget
	Popup or dropdown widget which, when clicked, "pop up" a list of items and lets the user pick on of them. More...
class	ScrollBarWidget
class	ScrollContainerWidget
class	TabWidget
Typedefs
typedef int	ActionType
typedef Common::SharedPtr < Animation >	AnimationPtr
typedef Common::SharedPtr < Drawable >	DrawablePtr
typedef Common::SharedPtr < Interpolator >	InterpolatorPtr
typedef Common::SharedPtr < Condition >	ConditionPtr
typedef Common::FixedStack < Dialog * >	DialogStack
Enumerations
enum	{ kScrollStartDelay = 1500, kScrollMillisPerPixel = 60 }
enum	{ kChooseCmd = 'Chos', kGoUpCmd = 'GoUp', kHiddenCmd = 'Hidd', kPathEditedCmd = 'Path' }
enum	{ kChooseCmd = 'Chos' }
enum	{ kConsoleSlideDownDuration = 200 }
enum	{ kCloseCmd = 'clos', kOKCmd = 'ok ' }
enum	{ kDownloadDialogButtonCmd = 'Dldb' }
enum	DownloadProgress { kDownloadProgressCmd = 'DLPR', kDownloadEndedCmd = 'DLEN' }
enum	{   kStartCmd = 'STRT', kAboutCmd = 'ABOU', kOptionsCmd = 'OPTN', kAddGameCmd = 'ADDG',   kEditGameCmd = 'EDTG', kRemoveGameCmd = 'REMG', kLoadGameCmd = 'LOAD', kQuitCmd = 'QUIT',   kSearchCmd = 'SRCH', kListSearchCmd = 'LSSR', kSearchClearCmd = 'SRCL', kCmdGlobalGraphicsOverride = 'OGFX',   kCmdGlobalAudioOverride = 'OSFX', kCmdGlobalMIDIOverride = 'OMID', kCmdGlobalMT32Override = 'OM32', kCmdGlobalVolumeOverride = 'OVOL',   kCmdChooseSoundFontCmd = 'chsf', kCmdExtraBrowser = 'PEXT', kCmdExtraPathClear = 'PEXC', kCmdGameBrowser = 'PGME',   kCmdSaveBrowser = 'PSAV', kCmdSavePathClear = 'PSAC', kGraphicsTabContainerReflowCmd = 'gtcr' }
enum	{ kChooseCmd = 'Chos' }
enum	{ kFBModeLoad = 0, kFBModeSave }
enum	{   kActivateChorusCmd = 'acho', kChorusVoiceCountChangedCmd = 'cvcc', kChorusLevelChangedCmd = 'clec', kChorusSpeedChangedCmd = 'cspc',   kChorusDepthChangedCmd = 'cdec', kActivateReverbCmd = 'arev', kReverbRoomSizeChangedCmd = 'rrsc', kReverbDampingChangedCmd = 'rdac',   kReverbWidthChangedCmd = 'rwic', kReverbLevelChangedCmd = 'rlec', kResetSettingsCmd = 'rese' }
enum	{ kWaveFormTypeSine = 0, kWaveFormTypeTriangle = 1 }
enum	{ kInterpolationNone = 0, kInterpolationLinear = 1, kInterpolation4thOrder = 2, kInterpolation7thOrder = 3 }
enum	{ kDoubleClickDelay = 500, kCursorAnimateDelay = 250, kTooltipDelay = 1250 }
enum	{ kMapCmd = 'map ' }
enum	{   kStartCmd = 'STRT', kAboutCmd = 'ABOU', kOptionsCmd = 'OPTN', kAddGameCmd = 'ADDG',   kEditGameCmd = 'EDTG', kRemoveGameCmd = 'REMG', kLoadGameCmd = 'LOAD', kQuitCmd = 'QUIT',   kSearchCmd = 'SRCH', kListSearchCmd = 'LSSR', kSearchClearCmd = 'SRCL', kCmdGlobalGraphicsOverride = 'OGFX',   kCmdGlobalAudioOverride = 'OSFX', kCmdGlobalMIDIOverride = 'OMID', kCmdGlobalMT32Override = 'OM32', kCmdGlobalVolumeOverride = 'OVOL',   kCmdChooseSoundFontCmd = 'chsf', kCmdExtraBrowser = 'PEXT', kCmdExtraPathClear = 'PEXC', kCmdGameBrowser = 'PGME',   kCmdSaveBrowser = 'PSAV', kCmdSavePathClear = 'PSAC' }
enum	{ kMaxScanTime = 50 }
enum	{ kOkCmd = 'OK ', kCancelCmd = 'CNCL' }
enum	{ kOkCmd = 'OK ', kCancelCmd = 'CNCL' }
enum	{ kMessageOK = 1, kMessageCancel = 0 }
enum	{ kStopCmd = 'STOP', kEditCmd = 'EDIT', kSwitchModeCmd = 'MODE', kFastModeCmd = 'FAST' }
enum	{   kMidiGainChanged = 'mgch', kMusicVolumeChanged = 'muvc', kSfxVolumeChanged = 'sfvc', kMuteAllChanged = 'mute',   kSubtitleToggle = 'sttg', kSubtitleSpeedChanged = 'stsc', kSpeechVolumeChanged = 'vcvc', kChooseSoundFontCmd = 'chsf',   kClearSoundFontCmd = 'clsf', kChooseSaveDirCmd = 'chos', kSavePathClearCmd = 'clsp', kChooseThemeDirCmd = 'chth',   kThemePathClearCmd = 'clth', kChooseExtraDirCmd = 'chex', kExtraPathClearCmd = 'clex', kChoosePluginsDirCmd = 'chpl',   kChooseThemeCmd = 'chtf', kUpdatesCheckCmd = 'updc', kKbdMouseSpeedChanged = 'kmsc', kJoystickDeadzoneChanged = 'jodc',   kGraphicsTabContainerReflowCmd = 'gtcr', kFullscreenToggled = 'oful' }
enum	{ kSubtitlesSpeech, kSubtitlesSubs, kSubtitlesBoth }
enum	{ kApplyCmd = 'appl' }
enum	{   kCancelCmd = 'CNCL', kOkCmd = 'OK ', kBut1Cmd = 'BUT1', kBut2Cmd = 'BUT2',   kBut3Cmd = 'BUT3', kBut4Cmd = 'BUT4', kBut5Cmd = 'BUT5', kBut6Cmd = 'BUT6',   kBut7Cmd = 'BUT7', kBut8Cmd = 'BUT8', kBut9Cmd = 'BUT9', kBut0Cmd = 'BUT0',   kNextCmd = 'NEXT', kAddCmd = '_ADD', kModeCmd = 'MODE', kDelCmd = '_DEL',   kTestCmd = 'TEST' }
enum	{ kModePre = 0, kModeNum = 1, kModeAbc = 2 }
enum	{   kRecordCmd = 'RCRD', kPlaybackCmd = 'PBCK', kDeleteCmd = 'DEL ', kNextScreenshotCmd = 'NEXT',   kPrevScreenshotCmd = 'PREV', kEditRecordCmd = 'EDIT' }
enum	{ kChooseCmd = 'Chos', kGoUpCmd = 'GoUp' }
enum	{ kListSwitchCmd = 'LIST', kGridSwitchCmd = 'GRID' }
enum	{ kChooseCmd = 'Chos', kDelCmd = '_DEL' }
enum	{ kNextCmd = 'NEXT', kPrevCmd = 'PREV', kNewSaveCmd = 'SAVE' }
enum	SaveLoadChooserType { kSaveLoadDialogList = 0, kSaveLoadDialogGrid = 1 }
enum	{   kConnectCmd = 'Cnnt', kCodeBoxCmd = 'CdBx', kOpenUrlCmd = 'OpUr', kPasteCodeCmd = 'PsCd',   kStorageWizardContainerReflowCmd = 'SWCr' }
enum	{ kChooseCmd = 'Chos' }
enum	DrawData {   kDDMainDialogBackground, kDDSpecialColorBackground, kDDPlainColorBackground, kDDTooltipBackground,   kDDDefaultBackground, kDDTextSelectionBackground, kDDTextSelectionFocusBackground, kDDWidgetBackgroundDefault,   kDDWidgetBackgroundSmall, kDDWidgetBackgroundEditText, kDDWidgetBackgroundSlider, kDDButtonIdle,   kDDButtonHover, kDDButtonDisabled, kDDButtonPressed, kDDSliderFull,   kDDSliderHover, kDDSliderDisabled, kDDCheckboxDefault, kDDCheckboxDisabled,   kDDCheckboxSelected, kDDRadiobuttonDefault, kDDRadiobuttonDisabled, kDDRadiobuttonSelected,   kDDTabActive, kDDTabInactive, kDDTabBackground, kDDScrollbarBase,   kDDScrollbarButtonIdle, kDDScrollbarButtonHover, kDDScrollbarHandleIdle, kDDScrollbarHandleHover,   kDDPopUpIdle, kDDPopUpHover, kDDPopUpDisabled, kDDCaret,   kDDSeparator, kDrawDataMAX, kDDNone = -1 }
	DrawData sets enumeration. More...
enum	DrawLayer { kDrawLayerBackground, kDrawLayerForeground }
	Dialog layers. More...
enum	TextData {   kTextDataNone = -1, kTextDataDefault = 0, kTextDataButton, kTextDataNormalFont,   kTextDataTooltip, kTextDataMAX }
enum	TextColor {   kTextColorNormal = 0, kTextColorNormalInverted, kTextColorNormalHover, kTextColorNormalDisabled,   kTextColorAlternative, kTextColorAlternativeInverted, kTextColorAlternativeHover, kTextColorAlternativeDisabled,   kTextColorButton, kTextColorButtonHover, kTextColorButtonDisabled, kTextColorMAX }
enum	{ kCopyToClipboard = 'cpcl', kOpenBugtrackerURL = 'ourl', kClose = 'clse', kScrollContainerReflow = 'SCRf' }
enum	{ kProceedCmd = 'PROC' }
enum	{   WIDGET_ENABLED = 1 << 0, WIDGET_INVISIBLE = 1 << 1, WIDGET_HILITED = 1 << 2, WIDGET_BORDER = 1 << 3,   WIDGET_PRESSED = 1 << 4, WIDGET_CLEARBG = 1 << 5, WIDGET_WANT_TICKLE = 1 << 7, WIDGET_TRACK_MOUSE = 1 << 8,   WIDGET_RETAIN_FOCUS = 1 << 9, WIDGET_IGNORE_DRAG = 1 << 10 }
enum	{   kStaticTextWidget = 'TEXT', kEditTextWidget = 'EDIT', kButtonWidget = 'BTTN', kCheckboxWidget = 'CHKB',   kRadiobuttonWidget = 'RDBT', kSliderWidget = 'SLDE', kListWidget = 'LIST', kScrollBarWidget = 'SCRB',   kPopUpWidget = 'POPU', kTabWidget = 'TABW', kGraphicsWidget = 'GFXW', kContainerWidget = 'CTNR',   kScrollContainerWidget = 'SCTR' }
enum	{ kCaretBlinkTime = 300 }
enum	{ kPressedButtonTime = 200 }
enum	{   kPicButtonStateEnabled = 0, kPicButtonHighlight = 1, kPicButtonStateDisabled = 2, kPicButtonStatePressed = 3,   kPicButtonStateMax = 3 }
enum	NumberingMode { kListNumberingOff = -1, kListNumberingZero = 0, kListNumberingOne = 1 }
enum	{ kListItemDoubleClickedCmd = 'LIdb', kListItemActivatedCmd = 'LIac', kListItemRemovalRequestCmd = 'LIrm', kListSelectionChangedCmd = 'Lsch' }
	Some special commands. More...
enum	{ kPopUpItemSelectedCmd = 'POPs' }
enum	{ kSetPositionCmd = 'SETP' }
enum	{ kCmdLeft = 'LEFT', kCmdRight = 'RGHT' }
enum	{ kTabForwards = 1, kTabBackwards = -1 }
Functions
void	displayErrorDialog (const char *text)
	Displays an error dialog for a given message.
void	displayErrorDialog (const Common::Error &error, const char *extraText="")
	Displays an error dialog for some error code.
SaveLoadChooserType	getRequestedSaveLoadDialog (const MetaEngine &metaEngine)
static TextData	parseTextDataId (const Common::String &name)
static TextColor	parseTextColorId (const Common::String &name)
static Graphics::TextAlign	parseTextHAlign (const Common::String &val)
static GUI::ThemeEngine::TextAlignVertical	parseTextVAlign (const Common::String &val)
static Graphics::DrawingFunctionCallback	getDrawingFunctionCallback (const Common::String &name)
ButtonWidget *	addClearButton (GuiObject *boss, const Common::String &name, uint32 cmd, int x, int y, int w, int h)
static int	matchingCharsIgnoringCase (const char *x, const char *y, bool &stop)
Variables
static const char *	copyright_text []
static const char *	gpl_text []
static const char *	savePeriodLabels [] = { _s("Never"), _s("Every 5 mins"), _s("Every 10 mins"), _s("Every 15 mins"), _s("Every 30 mins"), 0 }
static const int	savePeriodValues [] = { 0, 5 * 60, 10 * 60, 15 * 60, 30 * 60, -1 }
static const char *	kbdMouseSpeedLabels [] = { "3", "5", "8", "10", "13", "15", "18", "20", 0 }
static const DrawDataInfo	kDrawDataDefaults []
	Default values for each DrawData item.
static const TextDataInfo	kTextDataDefaults []
static const TextColorDataInfo	kTextColorDefaults []
static const int	kTabTitleSpacing = 2 * 5

---

Typedef Documentation

typedef int GUI::ActionType

Definition at line 32 of file Actions.h.

typedef Common::SharedPtr< Animation > GUI::AnimationPtr

Definition at line 72 of file Animation.h.

typedef Common::SharedPtr<Condition> GUI::ConditionPtr

Definition at line 40 of file WaitForConditionAnimation.h.

typedef Common::FixedStack<Dialog *> GUI::DialogStack

Definition at line 60 of file gui-manager.h.

typedef Common::SharedPtr<Drawable> GUI::DrawablePtr

Definition at line 105 of file Drawable.h.

typedef Common::SharedPtr<Interpolator> GUI::InterpolatorPtr

Definition at line 40 of file Interpolator.h.

---

Enumeration Type Documentation

anonymous enum

Enumerator:

kChooseCmd

Definition at line 30 of file chooser.cpp.

anonymous enum

Enumerator:

kConsoleSlideDownDuration

Definition at line 39 of file gui/console.cpp.

anonymous enum

Enumerator:

kCloseCmd
kOKCmd

Definition at line 46 of file gui/dialog.h.

anonymous enum

Enumerator:

kDownloadDialogButtonCmd

Definition at line 41 of file downloaddialog.cpp.

anonymous enum

Enumerator:

kStartCmd
kAboutCmd
kOptionsCmd
kAddGameCmd
kEditGameCmd
kRemoveGameCmd
kLoadGameCmd
kQuitCmd
kSearchCmd
kListSearchCmd
kSearchClearCmd
kCmdGlobalGraphicsOverride
kCmdGlobalAudioOverride
kCmdGlobalMIDIOverride
kCmdGlobalMT32Override
kCmdGlobalVolumeOverride
kCmdChooseSoundFontCmd
kCmdExtraBrowser
kCmdExtraPathClear
kCmdGameBrowser
kCmdSaveBrowser
kCmdSavePathClear
kGraphicsTabContainerReflowCmd

Definition at line 51 of file editgamedialog.cpp.

anonymous enum

Enumerator:

kChooseCmd

Definition at line 38 of file filebrowser-dialog.cpp.

anonymous enum

Enumerator:

kFBModeLoad
kFBModeSave

Definition at line 35 of file filebrowser-dialog.h.

anonymous enum

Enumerator:

kActivateChorusCmd
kChorusVoiceCountChangedCmd
kChorusLevelChangedCmd
kChorusSpeedChangedCmd
kChorusDepthChangedCmd
kActivateReverbCmd
kReverbRoomSizeChangedCmd
kReverbDampingChangedCmd
kReverbWidthChangedCmd
kReverbLevelChangedCmd
kResetSettingsCmd

Definition at line 35 of file fluidsynth-dialog.cpp.

anonymous enum

Enumerator:

kWaveFormTypeSine
kWaveFormTypeTriangle

Definition at line 51 of file fluidsynth-dialog.cpp.

anonymous enum

Enumerator:

kInterpolationNone
kInterpolationLinear
kInterpolation4thOrder
kInterpolation7thOrder

Definition at line 56 of file fluidsynth-dialog.cpp.

anonymous enum

Enumerator:

kDoubleClickDelay
kCursorAnimateDelay
kTooltipDelay

Definition at line 50 of file gui-manager.cpp.

anonymous enum

Enumerator:

kMapCmd

Definition at line 34 of file KeysDialog.cpp.

anonymous enum

Enumerator:

kStartCmd
kAboutCmd
kOptionsCmd
kAddGameCmd
kEditGameCmd
kRemoveGameCmd
kLoadGameCmd
kQuitCmd
kSearchCmd
kListSearchCmd
kSearchClearCmd
kCmdGlobalGraphicsOverride
kCmdGlobalAudioOverride
kCmdGlobalMIDIOverride
kCmdGlobalMT32Override
kCmdGlobalVolumeOverride
kCmdChooseSoundFontCmd
kCmdExtraBrowser
kCmdExtraPathClear
kCmdGameBrowser
kCmdSaveBrowser
kCmdSavePathClear

Definition at line 64 of file launcher.cpp.

anonymous enum

Enumerator:

kMaxScanTime

Definition at line 44 of file massadd.cpp.

anonymous enum

Enumerator:

kOkCmd
kCancelCmd

Definition at line 51 of file massadd.cpp.

anonymous enum

Enumerator:

kOkCmd
kCancelCmd

Definition at line 32 of file message.cpp.

anonymous enum

Enumerator:

kMessageOK
kMessageCancel

Definition at line 33 of file message.h.

anonymous enum

Enumerator:

kStopCmd
kEditCmd
kSwitchModeCmd
kFastModeCmd

Definition at line 46 of file onscreendialog.cpp.

anonymous enum

Enumerator:

kMidiGainChanged
kMusicVolumeChanged
kSfxVolumeChanged
kMuteAllChanged
kSubtitleToggle
kSubtitleSpeedChanged
kSpeechVolumeChanged
kChooseSoundFontCmd
kClearSoundFontCmd
kChooseSaveDirCmd
kSavePathClearCmd
kChooseThemeDirCmd
kThemePathClearCmd
kChooseExtraDirCmd
kExtraPathClearCmd
kChoosePluginsDirCmd
kChooseThemeCmd
kUpdatesCheckCmd
kKbdMouseSpeedChanged
kJoystickDeadzoneChanged
kGraphicsTabContainerReflowCmd
kFullscreenToggled

Definition at line 50 of file options.cpp.

anonymous enum

Enumerator:

kSubtitlesSpeech
kSubtitlesSubs
kSubtitlesBoth

Definition at line 75 of file options.cpp.

anonymous enum

Enumerator:

kApplyCmd

Definition at line 106 of file options.cpp.

anonymous enum

Enumerator:

kCancelCmd
kOkCmd
kBut1Cmd
kBut2Cmd
kBut3Cmd
kBut4Cmd
kBut5Cmd
kBut6Cmd
kBut7Cmd
kBut8Cmd
kBut9Cmd
kBut0Cmd
kNextCmd
kAddCmd
kModeCmd
kDelCmd
kTestCmd

Definition at line 44 of file predictivedialog.cpp.

anonymous enum

Enumerator:

kModePre
kModeNum
kModeAbc

Definition at line 64 of file predictivedialog.cpp.

anonymous enum

Enumerator:

kRecordCmd
kPlaybackCmd
kDeleteCmd
kNextScreenshotCmd
kPrevScreenshotCmd
kEditRecordCmd

Definition at line 45 of file recorderdialog.cpp.

anonymous enum

Enumerator:

kChooseCmd
kGoUpCmd

Definition at line 38 of file remotebrowser.cpp.

anonymous enum

Enumerator:

kListSwitchCmd
kGridSwitchCmd

Definition at line 127 of file saveload-dialog.cpp.

anonymous enum

Enumerator:

kChooseCmd
kDelCmd

Definition at line 366 of file saveload-dialog.cpp.

anonymous enum

Enumerator:

kNextCmd
kPrevCmd
kNewSaveCmd

Definition at line 732 of file saveload-dialog.cpp.

anonymous enum

Enumerator:

kConnectCmd
kCodeBoxCmd
kOpenUrlCmd
kPasteCodeCmd
kStorageWizardContainerReflowCmd

Definition at line 37 of file storagewizarddialog.cpp.

anonymous enum

Enumerator:

kChooseCmd

Definition at line 32 of file themebrowser.cpp.

anonymous enum

Enumerator:

kCopyToClipboard
kOpenBugtrackerURL
kClose
kScrollContainerReflow

Definition at line 37 of file unknown-game-dialog.cpp.

anonymous enum

Enumerator:

kProceedCmd

Definition at line 35 of file updates-dialog.cpp.

anonymous enum

Enumerator:

WIDGET_ENABLED
WIDGET_INVISIBLE
WIDGET_HILITED
WIDGET_BORDER
WIDGET_PRESSED
WIDGET_CLEARBG
WIDGET_WANT_TICKLE
WIDGET_TRACK_MOUSE
WIDGET_RETAIN_FOCUS
WIDGET_IGNORE_DRAG

Definition at line 37 of file widget.h.

anonymous enum

Enumerator:

kStaticTextWidget
kEditTextWidget
kButtonWidget
kCheckboxWidget
kRadiobuttonWidget
kSliderWidget
kListWidget
kScrollBarWidget
kPopUpWidget
kTabWidget
kGraphicsWidget
kContainerWidget
kScrollContainerWidget

Definition at line 59 of file widget.h.

anonymous enum

Enumerator:

kCaretBlinkTime

Definition at line 75 of file widget.h.

anonymous enum

Enumerator:

kPressedButtonTime

Definition at line 79 of file widget.h.

anonymous enum

Enumerator:

kPicButtonStateEnabled
kPicButtonHighlight
kPicButtonStateDisabled
kPicButtonStatePressed
kPicButtonStateMax

Definition at line 83 of file widget.h.

anonymous enum

Some special commands.

Enumerator:

kListItemDoubleClickedCmd	double click on item - 'data' will be item index
kListItemActivatedCmd	item activated by return/enter - 'data' will be item index
kListItemRemovalRequestCmd	request to remove the item with the delete/backspace keys - 'data' will be item index
kListSelectionChangedCmd	selection changed - 'data' will be item index

Definition at line 42 of file gui/widgets/list.h.

anonymous enum

Enumerator:

kPopUpItemSelectedCmd

Definition at line 32 of file popup.h.

anonymous enum

Enumerator:

kSetPositionCmd

Definition at line 30 of file scrollbar.h.

anonymous enum

Enumerator:

kCmdLeft
kCmdRight

Definition at line 31 of file tab.cpp.

anonymous enum

Enumerator:

kTabForwards
kTabBackwards

Definition at line 32 of file tab.h.

anonymous enum

Enumerator:

kScrollStartDelay
kScrollMillisPerPixel

Definition at line 36 of file about.cpp.

anonymous enum

Enumerator:

kChooseCmd
kGoUpCmd
kHiddenCmd
kPathEditedCmd

Definition at line 39 of file browser.cpp.

enum GUI::DownloadProgress

Enumerator:

kDownloadProgressCmd
kDownloadEndedCmd

Definition at line 40 of file downloaddialog.h.

enum GUI::DrawData

DrawData sets enumeration.

Each DD set corresponds to the actual looks of a widget in a given state.

Enumerator:

kDDMainDialogBackground
kDDSpecialColorBackground
kDDPlainColorBackground
kDDTooltipBackground
kDDDefaultBackground
kDDTextSelectionBackground
kDDTextSelectionFocusBackground
kDDWidgetBackgroundDefault
kDDWidgetBackgroundSmall
kDDWidgetBackgroundEditText
kDDWidgetBackgroundSlider
kDDButtonIdle
kDDButtonHover
kDDButtonDisabled
kDDButtonPressed
kDDSliderFull
kDDSliderHover
kDDSliderDisabled
kDDCheckboxDefault
kDDCheckboxDisabled
kDDCheckboxSelected
kDDRadiobuttonDefault
kDDRadiobuttonDisabled
kDDRadiobuttonSelected
kDDTabActive
kDDTabInactive
kDDTabBackground
kDDScrollbarBase
kDDScrollbarButtonIdle
kDDScrollbarButtonHover
kDDScrollbarHandleIdle
kDDScrollbarHandleHover
kDDPopUpIdle
kDDPopUpHover
kDDPopUpDisabled
kDDCaret
kDDSeparator
kDrawDataMAX
kDDNone

Definition at line 64 of file ThemeEngine.h.

enum GUI::DrawLayer

Dialog layers.

The currently active dialog has two layers, background and foreground. The background layer is drawn to the backbuffer. The foreground layer is drawn to the screen. This allows draw calls to restore the background layer before redrawing a widget.

Enumerator:

kDrawLayerBackground
kDrawLayerForeground

Definition at line 122 of file ThemeEngine.h.

enum GUI::NumberingMode

Enumerator:

kListNumberingOff
kListNumberingZero
kListNumberingOne

Definition at line 35 of file gui/widgets/list.h.

enum GUI::SaveLoadChooserType

Enumerator:

kSaveLoadDialogList
kSaveLoadDialogGrid

Definition at line 63 of file saveload-dialog.h.

enum GUI::TextColor

Enumerator:

kTextColorNormal
kTextColorNormalInverted
kTextColorNormalHover
kTextColorNormalDisabled
kTextColorAlternative
kTextColorAlternativeInverted
kTextColorAlternativeHover
kTextColorAlternativeDisabled
kTextColorButton
kTextColorButtonHover
kTextColorButtonDisabled
kTextColorMAX

Definition at line 137 of file ThemeEngine.h.

enum GUI::TextData

Enumerator:

kTextDataNone
kTextDataDefault
kTextDataButton
kTextDataNormalFont
kTextDataTooltip
kTextDataMAX

Definition at line 128 of file ThemeEngine.h.

---

Function Documentation

ButtonWidget * GUI::addClearButton	(	GuiObject *	boss,
		const Common::String &	name,
		uint32	cmd,
		int	x,
		int	y,
		int	w,
		int	h
	)

void GUI::displayErrorDialog

(

const char *

text

)

Displays an error dialog for a given message.

Parameters:

text

message to be displayed

void GUI::displayErrorDialog	(	const Common::Error &	error,
		const char *	extraText = ""
	)

Displays an error dialog for some error code.

Parameters:

	error	error code
	extraText	extra text to be displayed in addition to default string description(optional)

static Graphics::DrawingFunctionCallback GUI::getDrawingFunctionCallback

(

const Common::String &

name

)

[static]

Definition at line 314 of file ThemeParser.cpp.

SaveLoadChooserType GUI::getRequestedSaveLoadDialog

(

const MetaEngine &

metaEngine

)

static int GUI::matchingCharsIgnoringCase	(	const char *	x,
		const char *	y,
		bool &	stop
	)			[static]

Definition at line 276 of file gui/widgets/list.cpp.

static TextColor GUI::parseTextColorId

(

const Common::String &

name

)

[static]

Definition at line 74 of file ThemeParser.cpp.

static TextData GUI::parseTextDataId

(

const Common::String &

name

)

[static]

Definition at line 47 of file ThemeParser.cpp.

static Graphics::TextAlign GUI::parseTextHAlign

(

const Common::String &

val

)

[static]

Definition at line 82 of file ThemeParser.cpp.

static GUI::ThemeEngine::TextAlignVertical GUI::parseTextVAlign

(

const Common::String &

val

)

[static]

Definition at line 93 of file ThemeParser.cpp.

---

Variable Documentation

const char* GUI::copyright_text[] [static]

Initial value:

 {
"",
"C0""Copyright (C) 2003-2019 The ResidualVM Team",
"C0""http://www.residualvm.org",
"",
"C0""ResidualVM is the legal property of its developers, whose names are too numerous to list here. Please refer to the AUTHORS file distributed with this binary.",
"",
}

Definition at line 58 of file about.cpp.

const char* GUI::gpl_text[] [static]

Initial value:

 {
"",
"C0""This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.",
"C0""",
"C0""This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.",
"",
"C0""You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.",
"",
}

Definition at line 67 of file about.cpp.

const char* GUI::kbdMouseSpeedLabels[] = { "3", "5", "8", "10", "13", "15", "18", "20", 0 } [static]

Definition at line 114 of file options.cpp.

const DrawDataInfo GUI::kDrawDataDefaults[] [static]

Default values for each DrawData item.

Definition at line 118 of file ThemeEngine.cpp.

const int GUI::kTabTitleSpacing = 2 * 5 [static]

Definition at line 36 of file tab.cpp.

const TextColorDataInfo GUI::kTextColorDefaults[] [static]

Initial value:

 {
    { kTextColorNormal,                 "color_normal" },
    { kTextColorNormalInverted,         "color_normal_inverted" },
    { kTextColorNormalHover,            "color_normal_hover" },
    { kTextColorNormalDisabled,         "color_normal_disabled" },
    { kTextColorAlternative,            "color_alternative" },
    { kTextColorAlternativeInverted,    "color_alternative_inverted" },
    { kTextColorAlternativeHover,       "color_alternative_hover" },
    { kTextColorAlternativeDisabled,    "color_alternative_disabled" },
    { kTextColorButton,                 "color_button" },
    { kTextColorButtonHover,            "color_button_hover" },
    { kTextColorButtonDisabled,         "color_button_disabled" }
}

Definition at line 60 of file ThemeParser.cpp.

const TextDataInfo GUI::kTextDataDefaults[] [static]

Initial value:

 {
    { kTextDataDefault,         "text_default" },
    { kTextDataButton,          "text_button" },
    { kTextDataNormalFont,      "text_normal" },
    { kTextDataTooltip,         "tooltip_normal" }
}

Definition at line 39 of file ThemeParser.cpp.

const char* GUI::savePeriodLabels[] = { _s("Never"), _s("Every 5 mins"), _s("Every 10 mins"), _s("Every 15 mins"), _s("Every 30 mins"), 0 } [static]

Definition at line 110 of file options.cpp.

const int GUI::savePeriodValues[] = { 0, 5 * 60, 10 * 60, 15 * 60, 30 * 60, -1 } [static]

Definition at line 111 of file options.cpp.