scummvm/common/gui_options.h
Bartosz Gentkowski 24e3b6096e DOXYGEN: Doxygen improvements part 3
Editing doxygen comments in files:

- debug.h
- dialogs.h
- encoding.h
- endian.h
- error.h
- events.h
- fft.h
- file.h
- frac.h
- fs.h
- gui_options.h
- hash-ptr.h
- hashmap.h
- huffman.h
- ini-file.h

Plus some small changes in the config file.
2020-11-04 19:42:34 +00:00

125 lines
3.9 KiB
C++

/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* 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.
*
* 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.
*
* 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.
*
*/
#ifndef COMMON_GUI_OPTIONS_H
#define COMMON_GUI_OPTIONS_H
#define GUIO_NONE "\x00"
#define GUIO_NOSUBTITLES "\x01"
#define GUIO_NOMUSIC "\x02"
// GUIO_NOSPEECH is a combination of GUIO_NOSPEECHVOLUME and GUIO_NOSUBTITLES
#define GUIO_NOSPEECH "\x03"
#define GUIO_NOSFX "\x04"
#define GUIO_NOMIDI "\x05"
#define GUIO_NOLAUNCHLOAD "\x06"
#define GUIO_MIDIPCSPK "\x07"
#define GUIO_MIDICMS "\x08"
#define GUIO_MIDIPCJR "\x09"
#define GUIO_MIDIADLIB "\x0a"
#define GUIO_MIDIC64 "\x0b"
#define GUIO_MIDIAMIGA "\x0c"
#define GUIO_MIDIAPPLEIIGS "\x0d"
#define GUIO_MIDITOWNS "\x0e"
#define GUIO_MIDIPC98 "\x0f"
#define GUIO_MIDISEGACD "\x10"
#define GUIO_MIDIMT32 "\x11"
#define GUIO_MIDIGM "\x12"
#define GUIO_NOASPECT "\x13"
#define GUIO_RENDERHERCGREEN "\x18"
#define GUIO_RENDERHERCAMBER "\x19"
#define GUIO_RENDERCGA "\x1a"
#define GUIO_RENDEREGA "\x1b"
#define GUIO_RENDERVGA "\x1c"
#define GUIO_RENDERAMIGA "\x1d"
#define GUIO_RENDERFMTOWNS "\x1e"
#define GUIO_RENDERPC9821 "\x1f"
#define GUIO_RENDERPC9801 "\x20"
#define GUIO_RENDERAPPLE2GS "\x21"
#define GUIO_RENDERATARIST "\x22"
#define GUIO_RENDERMACINTOSH "\x23"
#define GUIO_LINKSPEECHTOSFX "\x24"
#define GUIO_LINKMUSICTOSFX "\x25"
#define GUIO_NOSPEECHVOLUME "\x26"
// Special GUIO flags for the AdvancedDetector's caching of game specific
// options.
#define GUIO_GAMEOPTIONS1 "\x30"
#define GUIO_GAMEOPTIONS2 "\x31"
#define GUIO_GAMEOPTIONS3 "\x32"
#define GUIO_GAMEOPTIONS4 "\x33"
#define GUIO_GAMEOPTIONS5 "\x34"
#define GUIO_GAMEOPTIONS6 "\x35"
#define GUIO_GAMEOPTIONS7 "\x36"
#define GUIO_GAMEOPTIONS8 "\x37"
#define GUIO_GAMEOPTIONS9 "\x38"
#define GUIO_GAMEOPTIONS10 "\x39"
#define GUIO_GAMEOPTIONS11 "\x3a"
#define GUIO_GAMEOPTIONS12 "\x3b"
#define GUIO_GAMEOPTIONS13 "\x3c"
#define GUIO_GAMEOPTIONS14 "\x3d"
#define GUIO_GAMEOPTIONS15 "\x3e"
#define GUIO0() (GUIO_NONE)
#define GUIO1(a) (a)
#define GUIO2(a,b) (a b)
#define GUIO3(a,b,c) (a b c)
#define GUIO4(a,b,c,d) (a b c d)
#define GUIO5(a,b,c,d,e) (a b c d e)
#define GUIO6(a,b,c,d,e,f) (a b c d e f)
#define GUIO7(a,b,c,d,e,f,g) (a b c d e f g)
#define GUIO8(a,b,c,d,e,f,g,h) (a b c d e f g h)
#define GUIO9(a,b,c,d,e,f,g,h,i) (a b c d e f g h i)
namespace Common {
/**
* @defgroup common_gui_options GUI options
* @ingroup common
*
* @brief API for managing the options of the graphical user interface (GUI).
*
* @{
*/
class String;
bool checkGameGUIOption(const String &option, const String &str);
String parseGameGUIOptions(const String &str);
const String getGameGUIOptionsDescription(const String &options);
/**
* Update the GUI options of the current config manager
* domain when they differ to the ones passed as
* parameter.
*/
void updateGameGUIOptions(const String &options, const String &langOption);
/** @} */
} // End of namespace Common
#endif