ScummVM API documentation
ExtraGuiOption Struct Reference

#include <metaengine.h>

Public Attributes

const char * label
 
const char * tooltip
 
const char * configOption
 
bool defaultState
 
byte groupId
 
byte groupLeaderId
 

Detailed Description

Per-game extra GUI options structure. Currently, this can only be used for options with checkboxes.

Member Data Documentation

◆ label

const char* ExtraGuiOption::label

Option label, e.g. "Fullscreen mode".

◆ tooltip

const char* ExtraGuiOption::tooltip

Option tooltip shown when the mouse cursor hovers over it.

◆ configOption

const char* ExtraGuiOption::configOption

confMan key, e.g. "fullscreen".

◆ defaultState

bool ExtraGuiOption::defaultState

Default state of the checkbox (checked or not).

◆ groupId

byte ExtraGuiOption::groupId

Set to the leader Id (groupLeaderId) for the checkbox's group, or 0 for no group.

◆ groupLeaderId

byte ExtraGuiOption::groupLeaderId

Set to a non-zero value only for the leader of the checkbox group. When this leader checkbox is unchecked, disable all checkboxes in this group. One leader per group.


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