help_gui.cpp File Reference

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 "table/strings.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, Subdirectory subdir)
	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	FONTS_FILENAME = "fonts.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 std::initializer_list< NWidgetPart >	_nested_helpwin_widgets
static WindowDesc	_helpwin_desc (WDP_CENTER, {}, 0, 0, WC_HELPWIN, WC_NONE, {}, _nested_helpwin_widgets)

Detailed Description

GUI to access manuals and related.

Definition in file help_gui.cpp.

Function Documentation

FindGameManualFilePath()

static std::optional< std::string > FindGameManualFilePath ( std::string_view  filename, Subdirectory  subdir  )

static

Find the path to the game manual file.

Parameters

filename

The filename to find.

Returns

std::string The path to the filename if found.

Definition at line 47 of file help_gui.cpp.

References FioCheckFileExists(), NO_DIRECTORY, SP_APPLICATION_BUNDLE_DIR, SP_BINARY_DIR, SP_INSTALLATION_DIR, SP_SHARED_DIR, and SP_WORKING_DIR.

ShowHelpWindow()

void ShowHelpWindow

(

)

Definition at line 211 of file help_gui.cpp.

Variable Documentation

_nested_helpwin_widgets

constexpr std::initializer_list<NWidgetPart> _nested_helpwin_widgets

staticconstexpr

Initial value:

= {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
    NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetStringTip(STR_HELP_WINDOW_CAPTION),
  EndContainer(),
 
  NWidget(WWT_PANEL, COLOUR_DARK_GREEN),
    NWidget(NWID_HORIZONTAL), SetPIP(0, WidgetDimensions::unscaled.hsep_wide, 0), SetPadding(WidgetDimensions::unscaled.sparse),
      NWidget(WWT_FRAME, COLOUR_DARK_GREEN), SetStringTip(STR_HELP_WINDOW_WEBSITES),
        NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_HW_WEBSITE), SetStringTip(STR_HELP_WINDOW_MAIN_WEBSITE), SetMinimalSize(128, 12), SetFill(1, 0),
        NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_HW_WIKI), SetStringTip(STR_HELP_WINDOW_MANUAL_WIKI), SetMinimalSize(128, 12), SetFill(1, 0),
        NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_HW_BUGTRACKER), SetStringTip(STR_HELP_WINDOW_BUGTRACKER), SetMinimalSize(128, 12), SetFill(1, 0),
        NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_HW_COMMUNITY), SetStringTip(STR_HELP_WINDOW_COMMUNITY), SetMinimalSize(128, 12), SetFill(1, 0),
      EndContainer(),
 
      NWidget(WWT_FRAME, COLOUR_DARK_GREEN), SetStringTip(STR_HELP_WINDOW_DOCUMENTS),
        NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_HW_README), SetStringTip(STR_HELP_WINDOW_README), SetMinimalSize(128, 12), SetFill(1, 0),
        NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_HW_CHANGELOG), SetStringTip(STR_HELP_WINDOW_CHANGELOG), SetMinimalSize(128, 12), SetFill(1, 0),
        NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_HW_KNOWN_BUGS),SetStringTip(STR_HELP_WINDOW_KNOWN_BUGS), SetMinimalSize(128, 12), SetFill(1, 0),
        NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_HW_LICENSE), SetStringTip(STR_HELP_WINDOW_LICENSE), SetMinimalSize(128, 12), SetFill(1, 0),
        NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_HW_FONTS), SetStringTip(STR_HELP_WINDOW_FONTS), SetMinimalSize(128, 12), SetFill(1, 0),
      EndContainer(),
    EndContainer(),
  EndContainer(),
}

Definition at line 178 of file help_gui.cpp.

BUGTRACKER_LINK

const std::string BUGTRACKER_LINK = "https://bugs.openttd.org/"

static

Definition at line 35 of file help_gui.cpp.

CHANGELOG_FILENAME

const std::string CHANGELOG_FILENAME = "changelog.md"

static

Definition at line 28 of file help_gui.cpp.

CHANGELOG_VERSIONS_LIMIT

constexpr size_t CHANGELOG_VERSIONS_LIMIT = 20

staticconstexpr

Only show the first 20 changelog versions in the textfile viewer.

Definition at line 39 of file help_gui.cpp.

Referenced by GameManualTextfileWindow::AfterLoadChangelog().

COMMUNITY_LINK

const std::string COMMUNITY_LINK = "https://community.openttd.org/"

static

Definition at line 36 of file help_gui.cpp.

FONTS_FILENAME

const std::string FONTS_FILENAME = "fonts.md"

static

Definition at line 31 of file help_gui.cpp.

KNOWN_BUGS_FILENAME

const std::string KNOWN_BUGS_FILENAME = "known-bugs.md"

static

Definition at line 29 of file help_gui.cpp.

LICENSE_FILENAME

const std::string LICENSE_FILENAME = "COPYING.md"

static

Definition at line 30 of file help_gui.cpp.

README_FILENAME

const std::string README_FILENAME = "README.md"

static

Definition at line 27 of file help_gui.cpp.

WEBSITE_LINK

const std::string WEBSITE_LINK = "https://www.openttd.org/"

static

Definition at line 33 of file help_gui.cpp.

WIKI_LINK

const std::string WIKI_LINK = "https://wiki.openttd.org/"

static

Definition at line 34 of file help_gui.cpp.