OpenTTD Source 20241224-master-gf74b0cf984
|
GUI to access manuals and related. More...
#include "stdafx.h"
#include "gui.h"
#include "window_gui.h"
#include "textfile_gui.h"
#include "fileio_func.h"
#include "table/control_codes.h"
#include "string_func.h"
#include "openttd.h"
#include "help_gui.h"
#include "widgets/help_widget.h"
#include "widgets/misc_widget.h"
#include "safeguards.h"
Go to the source code of this file.
Data Structures | |
struct | GameManualTextfileWindow |
Window class displaying the game manual textfile viewer. More... | |
struct | HelpWindow |
Window class displaying the help window. More... | |
Functions | |
static std::optional< std::string > | FindGameManualFilePath (std::string_view filename) |
Find the path to the game manual file. | |
void | ShowHelpWindow () |
Variables | |
static const std::string | README_FILENAME = "README.md" |
static const std::string | CHANGELOG_FILENAME = "changelog.md" |
static const std::string | KNOWN_BUGS_FILENAME = "known-bugs.md" |
static const std::string | LICENSE_FILENAME = "COPYING.md" |
static const std::string | WEBSITE_LINK = "https://www.openttd.org/" |
static const std::string | WIKI_LINK = "https://wiki.openttd.org/" |
static const std::string | BUGTRACKER_LINK = "https://bugs.openttd.org/" |
static const std::string | COMMUNITY_LINK = "https://community.openttd.org/" |
static constexpr size_t | CHANGELOG_VERSIONS_LIMIT = 20 |
Only show the first 20 changelog versions in the textfile viewer. | |
static constexpr NWidgetPart | _nested_helpwin_widgets [] |
static WindowDesc | _helpwin_desc (WDP_CENTER, nullptr, 0, 0, WC_HELPWIN, WC_NONE, 0, _nested_helpwin_widgets) |
GUI to access manuals and related.
Definition in file help_gui.cpp.
|
static |
Find the path to the game manual file.
filename | The filename to find. |
Definition at line 44 of file help_gui.cpp.
References BASE_DIR, FioCheckFileExists(), NO_DIRECTORY, SP_APPLICATION_BUNDLE_DIR, SP_BINARY_DIR, SP_INSTALLATION_DIR, SP_SHARED_DIR, and SP_WORKING_DIR.
void ShowHelpWindow | ( | ) |
Definition at line 200 of file help_gui.cpp.
|
staticconstexpr |
Definition at line 168 of file help_gui.cpp.
|
static |
Definition at line 32 of file help_gui.cpp.
|
static |
Definition at line 26 of file help_gui.cpp.
|
staticconstexpr |
Only show the first 20 changelog versions in the textfile viewer.
Definition at line 36 of file help_gui.cpp.
Referenced by GameManualTextfileWindow::AfterLoadChangelog().
|
static |
Definition at line 33 of file help_gui.cpp.
|
static |
Definition at line 27 of file help_gui.cpp.
|
static |
Definition at line 28 of file help_gui.cpp.
|
static |
Definition at line 25 of file help_gui.cpp.
|
static |
Definition at line 30 of file help_gui.cpp.
|
static |
Definition at line 31 of file help_gui.cpp.