The Battle for Wesnoth  1.13.4+dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Namespaces | Macros | Functions | Variables
help.cpp File Reference

Routines for showing the help-dialog. More...

#include "global.hpp"
#include "help.hpp"
#include "config.hpp"
#include "events.hpp"
#include "font.hpp"
#include "game_preferences.hpp"
#include "gettext.hpp"
#include "gui/dialogs/transient_message.hpp"
#include "help_browser.hpp"
#include "help_impl.hpp"
#include "key.hpp"
#include "log.hpp"
#include "sdl/utils.hpp"
#include "show_dialog.hpp"
#include "terrain/terrain.hpp"
#include "units/unit.hpp"
#include "units/types.hpp"
#include "video.hpp"
#include "widgets/button.hpp"
#include <assert.h>
#include <algorithm>
#include <ostream>
#include <vector>
#include <SDL.h>
Include dependency graph for help.cpp:

Go to the source code of this file.

Namespaces

 help
 

Macros

#define GETTEXT_DOMAIN   "wesnoth-help"
 
#define WRN_DP   LOG_STREAM(warn, log_display)
 
#define WRN_HP   LOG_STREAM(warn, log_help)
 
#define DBG_HP   LOG_STREAM(debug, log_help)
 

Functions

void help::show_unit_description (CVideo &video, const unit &u)
 
void help::show_terrain_description (CVideo &video, const terrain_type &t)
 
void help::show_unit_description (CVideo &video, const unit_type &t)
 
void help::show_help (CVideo &video, const std::string &show_topic, int xloc, int yloc)
 Open the help browser, show topic with id show_topic. More...
 
void help::show_unit_help (CVideo &video, const std::string &show_topic, bool has_variations, bool hidden, int xloc, int yloc)
 Open the help browser, show unit with id unit_id. More...
 
void help::show_terrain_help (CVideo &video, const std::string &show_topic, bool hidden, int xloc, int yloc)
 Open the help browser, show terrain with id terrain_id. More...
 
void help::show_variation_help (CVideo &video, const std::string &unit, const std::string &variation, bool hidden, int xloc, int yloc)
 Open the help browser, show the variation of the unit matching. More...
 
void help::show_help (CVideo &video, const section &toplevel_sec, const std::string &show_topic, int xloc, int yloc)
 Open a help dialog using a toplevel other than the default. More...
 

Variables

static lg::log_domain log_display ("display")
 
static lg::log_domain log_help ("help")
 
config help::dummy_cfg
 

Detailed Description

Routines for showing the help-dialog.

Definition in file help.cpp.

Macro Definition Documentation

#define DBG_HP   LOG_STREAM(debug, log_help)

Definition at line 55 of file help.cpp.

#define GETTEXT_DOMAIN   "wesnoth-help"

Definition at line 20 of file help.cpp.

#define WRN_DP   LOG_STREAM(warn, log_display)

Definition at line 51 of file help.cpp.

#define WRN_HP   LOG_STREAM(warn, log_help)

Definition at line 54 of file help.cpp.

Variable Documentation

lg::log_domain log_display("display")
static
lg::log_domain log_help("help")
static