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 "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. More...
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)

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 )

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 44 of file help_gui.cpp.

References SP_APPLICATION_BUNDLE_DIR, SP_BINARY_DIR, SP_INSTALLATION_DIR, SP_SHARED_DIR, and SP_WORKING_DIR.

Variable Documentation

_nested_helpwin_widgets

constexpr NWidgetPart _nested_helpwin_widgets[]

staticconstexpr

Initial value:

= {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
    NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetDataTip(STR_HELP_WINDOW_CAPTION, STR_NULL),
  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), SetDataTip(STR_HELP_WINDOW_WEBSITES, STR_NULL),
        NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_HW_WEBSITE), SetDataTip(STR_HELP_WINDOW_MAIN_WEBSITE, STR_NULL), SetMinimalSize(128, 12), SetFill(1, 0),
        NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_HW_WIKI), SetDataTip(STR_HELP_WINDOW_MANUAL_WIKI, STR_NULL), SetMinimalSize(128, 12), SetFill(1, 0),
        NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_HW_BUGTRACKER), SetDataTip(STR_HELP_WINDOW_BUGTRACKER, STR_NULL), SetMinimalSize(128, 12), SetFill(1, 0),
        NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_HW_COMMUNITY), SetDataTip(STR_HELP_WINDOW_COMMUNITY, STR_NULL), SetMinimalSize(128, 12), SetFill(1, 0),
      EndContainer(),
 
      NWidget(WWT_FRAME, COLOUR_DARK_GREEN), SetDataTip(STR_HELP_WINDOW_DOCUMENTS, STR_NULL),
        NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_HW_README), SetDataTip(STR_HELP_WINDOW_README, STR_NULL), SetMinimalSize(128, 12), SetFill(1, 0),
        NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_HW_CHANGELOG), SetDataTip(STR_HELP_WINDOW_CHANGELOG, STR_NULL), SetMinimalSize(128, 12), SetFill(1, 0),
        NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_HW_KNOWN_BUGS),SetDataTip(STR_HELP_WINDOW_KNOWN_BUGS, STR_NULL), SetMinimalSize(128, 12), SetFill(1, 0),
        NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_HW_LICENSE), SetDataTip(STR_HELP_WINDOW_LICENSE, STR_NULL), SetMinimalSize(128, 12), SetFill(1, 0),
      EndContainer(),
    EndContainer(),
  EndContainer(),
}

Definition at line 168 of file help_gui.cpp.