Data Structures | Defines | Enumerations | Functions | Variables

misc_gui.cpp File Reference

GUIs for a number of misc windows. More...

#include "stdafx.h"
#include "debug.h"
#include "landscape.h"
#include "error.h"
#include "gui.h"
#include "command_func.h"
#include "company_func.h"
#include "town.h"
#include "string_func.h"
#include "company_base.h"
#include "texteff.hpp"
#include "strings_func.h"
#include "window_func.h"
#include "querystring_gui.h"
#include "core/geometry_func.hpp"
#include "newgrf_debug.h"
#include "widgets/misc_widget.h"
#include "table/strings.h"

Go to the source code of this file.

Data Structures

class  LandInfoWindow
struct  AboutWindow
struct  TooltipsWindow
 Window for displaying a tooltip. More...
struct  QueryStringWindow
 Class for the string query window. More...
struct  QueryWindow
 Window used for asking the user a YES/NO question. More...

Defines

#define LANDINFOD_LEVEL   1

Enumerations

enum  OskActivation { OSKA_DISABLED, OSKA_DOUBLE_CLICK, OSKA_SINGLE_CLICK, OSKA_IMMEDIATELY }
 

Method to open the OSK.

More...

Functions

void ShowLandInfo (TileIndex tile)
 Show land information window.
void ShowAboutWindow ()
void ShowEstimatedCostOrIncome (Money cost, int x, int y)
 Display estimated costs.
void ShowCostOrIncomeAnimation (int x, int y, int z, Money cost)
 Display animated income or costs on the map.
void ShowFeederIncomeAnimation (int x, int y, int z, Money cost)
 Display animated feeder income.
TextEffectID ShowFillingPercent (int x, int y, int z, uint8 percent, StringID string)
 Display vehicle loading indicators.
void UpdateFillingPercent (TextEffectID te_id, uint8 percent, StringID string)
 Update vehicle loading indicators.
void HideFillingPercent (TextEffectID *te_id)
 Hide vehicle loading indicators.
void GuiShowTooltips (Window *parent, StringID str, uint paramcount, const uint64 params[], TooltipCloseCondition close_tooltip)
 Shows a tooltip.
void ShowQueryString (StringID str, StringID caption, uint maxsize, Window *parent, CharSetFilter afilter, QueryStringFlags flags)
 Show a query popup window with a textbox in it.
void ShowQuery (StringID caption, StringID message, Window *parent, QueryCallbackProc *callback)
 Show a modal confirmation window with standard 'yes' and 'no' buttons The window is aligned to the centre of its parent.

Variables

static const NWidgetPart _nested_land_info_widgets []
static const WindowDesc _land_info_desc (WDP_AUTO, 0, 0, WC_LAND_INFO, WC_NONE, 0, _nested_land_info_widgets, lengthof(_nested_land_info_widgets))
static const NWidgetPart _nested_about_widgets []
static const WindowDesc _about_desc (WDP_CENTER, 0, 0, WC_GAME_OPTIONS, WC_NONE, 0, _nested_about_widgets, lengthof(_nested_about_widgets))
static const char *const _credits []
static const NWidgetPart _nested_tooltips_widgets []
static const WindowDesc _tool_tips_desc (WDP_MANUAL, 0, 0, WC_TOOLTIPS, WC_NONE, 0, _nested_tooltips_widgets, lengthof(_nested_tooltips_widgets))
static const NWidgetPart _nested_query_string_widgets []
static const WindowDesc _query_string_desc (WDP_CENTER, 0, 0, WC_QUERY_STRING, WC_NONE, 0, _nested_query_string_widgets, lengthof(_nested_query_string_widgets))
static const NWidgetPart _nested_query_widgets []
static const WindowDesc _query_desc (WDP_CENTER, 0, 0, WC_CONFIRM_POPUP_QUERY, WC_NONE, WDF_MODAL, _nested_query_widgets, lengthof(_nested_query_widgets))

Detailed Description

GUIs for a number of misc windows.

Definition in file misc_gui.cpp.


Enumeration Type Documentation

Method to open the OSK.

Enumerator:
OSKA_DISABLED 

The OSK shall not be activated at all.

OSKA_DOUBLE_CLICK 

Double click on the edit box opens OSK.

OSKA_SINGLE_CLICK 

Single click after focus click opens OSK.

OSKA_IMMEDIATELY 

Focusing click already opens OSK.

Definition at line 34 of file misc_gui.cpp.


Function Documentation

void GuiShowTooltips ( Window parent,
StringID  str,
uint  paramcount,
const uint64  params[],
TooltipCloseCondition  close_tooltip 
)

Shows a tooltip.

Parameters:
parent The window this tooltip is related to.
str String to be displayed
paramcount number of params to deal with
params (optional) up to 5 pieces of additional information that may be added to a tooltip
use_left_mouse_button close the tooltip when the left (true) or right (false) mouse button is released

Definition at line 709 of file misc_gui.cpp.

References DeleteWindowById(), and WC_TOOLTIPS.

Referenced by DispatchHoverEvent(), DispatchRightClickEvent(), IndustryCargoesWindow::OnHover(), DepotWindow::OnRightClick(), and ShowMeasurementTooltips().

void HideFillingPercent ( TextEffectID *  te_id  ) 

Hide vehicle loading indicators.

Parameters:
*te_id TextEffectID which is supposed to be hidden.

Definition at line 596 of file misc_gui.cpp.

Referenced by CmdReverseTrainDirection(), Train::Crash(), Vehicle::LeaveStation(), and Vehicle::PreDestructor().

void ShowCostOrIncomeAnimation ( int  x,
int  y,
int  z,
Money  cost 
)

Display animated income or costs on the map.

Parameters:
x World X position of the animation location.
y World Y position of the animation location.
z World Z position of the animation location.
cost Estimated cost (or income if negative).

Definition at line 532 of file misc_gui.cpp.

References DAY_TICKS, RemapCoords(), SetDParam(), and TE_RISING.

Referenced by DoCommandP(), and VehicleEnterDepot().

void ShowEstimatedCostOrIncome ( Money  cost,
int  x,
int  y 
)

Display estimated costs.

Parameters:
cost Estimated cost (or income if negative).
x X position of the notification window.
y Y position of the notification window.

Definition at line 513 of file misc_gui.cpp.

References INVALID_STRING_ID, SetDParam(), ShowErrorMessage(), and WL_INFO.

Referenced by DoCommandP().

void ShowFeederIncomeAnimation ( int  x,
int  y,
int  z,
Money  cost 
)

Display animated feeder income.

Parameters:
x World X position of the animation location.
y World Y position of the animation location.
z World Z position of the animation location.
cost Estimated feeder income.

Definition at line 552 of file misc_gui.cpp.

References DAY_TICKS, RemapCoords(), SetDParam(), and TE_RISING.

TextEffectID ShowFillingPercent ( int  x,
int  y,
int  z,
uint8  percent,
StringID  string 
)

Display vehicle loading indicators.

Parameters:
x World X position of the animation location.
y World Y position of the animation location.
z World Z position of the animation location.
percent Estimated feeder income.
string String which is drawn on the map.
Returns:
TextEffectID to be used for future updates of the loading indicators.

Definition at line 569 of file misc_gui.cpp.

References RemapCoords(), SetDParam(), and TE_STATIC.

Referenced by LoadUnloadVehicle().

void ShowLandInfo ( TileIndex  tile  ) 

Show land information window.

Parameters:
tile The tile to show information about.

Definition at line 346 of file misc_gui.cpp.

References DeleteWindowById(), and WC_LAND_INFO.

Referenced by ScenarioEditorToolbarWindow::OnPlaceObject(), and MainToolbarWindow::OnPlaceObject().

void ShowQuery ( StringID  caption,
StringID  message,
Window parent,
QueryCallbackProc callback 
)

Show a modal confirmation window with standard 'yes' and 'no' buttons The window is aligned to the centre of its parent.

Parameters:
caption string shown as window caption
message string that will be shown for the window
parent pointer to parent window, if this pointer is NULL the parent becomes the main window WC_MAIN_WINDOW
callback callback function pointer to set in the window descriptor

Definition at line 1170 of file misc_gui.cpp.

References FindWindowById(), Window::parent, QueryWindow::proc, WC_CONFIRM_POPUP_QUERY, WC_MAIN_WINDOW, and Window::window_class.

Referenced by CmdPause(), MenuClickLargeWorldScreenshot(), ScenarioEditorLandscapeGenerationWindow::OnClick(), GenerateProgressWindow::OnClick(), GenerateLandscapeWindow::OnClick(), and DepotWindow::OnClick().

void ShowQueryString ( StringID  str,
StringID  caption,
uint  maxsize,
Window parent,
CharSetFilter  afilter,
QueryStringFlags  flags 
)

Show a query popup window with a textbox in it.

Parameters:
str StringID for the text shown in the textbox
caption StringID of text shown in caption of querywindow
maxsize maximum size in bytes or characters (including terminating '') depending on flags
parent pointer to a Window that will handle the events (ok/cancel) of this window. If NULL, results are handled by global function HandleOnEditText
afilter filters out unwanted character input
flags various flags,
See also:
QueryStringFlags

Definition at line 1030 of file misc_gui.cpp.

References DeleteWindowByClass(), MAX_CHAR_LENGTH, QSF_LEN_IN_CHARS, and WC_QUERY_STRING.

Referenced by WaypointWindow::OnClick(), VehicleDetailsWindow::OnClick(), TownViewWindow::OnClick(), TimetableWindow::OnClick(), StationViewWindow::OnClick(), CustomCurrencyWindow::OnClick(), GameSettingsWindow::OnClick(), OrdersWindow::OnClick(), NewGRFParametersWindow::OnClick(), SpriteAlignerWindow::OnClick(), NetworkStartServerWindow::OnClick(), NetworkGameWindow::OnClick(), IndustryViewWindow::OnClick(), CreateScenarioWindow::OnClick(), GenerateLandscapeWindow::OnClick(), DepotWindow::OnClick(), CompanyWindow::OnClick(), SelectCompanyManagerFaceWindow::OnClick(), CheatWindow::OnClick(), BuildVehicleWindow::OnClick(), AISettingsWindow::OnClick(), GenerateLandscapeWindow::OnDropdownSelect(), and ToolbarScenDatePanel().

void UpdateFillingPercent ( TextEffectID  te_id,
uint8  percent,
StringID  string 
)

Update vehicle loading indicators.

Parameters:
te_id TextEffectID to be updated.
string String wich is printed.

Definition at line 584 of file misc_gui.cpp.

References SetDParam().

Referenced by LoadUnloadVehicle().


Variable Documentation

const NWidgetPart _nested_about_widgets[] [static]
Initial value:
 {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, COLOUR_GREY),
    NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_ABOUT_OPENTTD, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
  EndContainer(),
  NWidget(WWT_PANEL, COLOUR_GREY), SetPIP(4, 2, 4),
    NWidget(WWT_LABEL, COLOUR_GREY), SetDataTip(STR_ABOUT_ORIGINAL_COPYRIGHT, STR_NULL),
    NWidget(WWT_LABEL, COLOUR_GREY), SetDataTip(STR_ABOUT_VERSION, STR_NULL),
    NWidget(WWT_FRAME, COLOUR_GREY), SetPadding(0, 5, 1, 5),
      NWidget(WWT_EMPTY, INVALID_COLOUR, WID_A_SCROLLING_TEXT),
    EndContainer(),
    NWidget(WWT_LABEL, COLOUR_GREY, WID_A_WEBSITE), SetDataTip(STR_BLACK_RAW_STRING, STR_NULL),
    NWidget(WWT_LABEL, COLOUR_GREY), SetDataTip(STR_ABOUT_COPYRIGHT_OPENTTD, STR_NULL),
  EndContainer(),
}

Definition at line 352 of file misc_gui.cpp.

const NWidgetPart _nested_land_info_widgets[] [static]
Initial value:
 {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, COLOUR_GREY),
    NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_LAND_AREA_INFORMATION_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
    NWidget(WWT_DEBUGBOX, COLOUR_GREY),
  EndContainer(),
  NWidget(WWT_PANEL, COLOUR_GREY, WID_LI_BACKGROUND), EndContainer(),
}

Definition at line 42 of file misc_gui.cpp.

const NWidgetPart _nested_query_string_widgets[] [static]
Initial value:
 {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, COLOUR_GREY),
    NWidget(WWT_CAPTION, COLOUR_GREY, WID_QS_CAPTION), SetDataTip(STR_WHITE_STRING, STR_NULL),
  EndContainer(),
  NWidget(WWT_PANEL, COLOUR_GREY),
    NWidget(WWT_EDITBOX, COLOUR_GREY, WID_QS_TEXT), SetMinimalSize(256, 12), SetFill(1, 1), SetPadding(2, 2, 2, 2),
  EndContainer(),
  NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
    NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_QS_DEFAULT), SetMinimalSize(87, 12), SetFill(1, 1), SetDataTip(STR_BUTTON_DEFAULT, STR_NULL),
    NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_QS_CANCEL), SetMinimalSize(86, 12), SetFill(1, 1), SetDataTip(STR_BUTTON_CANCEL, STR_NULL),
    NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_QS_OK), SetMinimalSize(87, 12), SetFill(1, 1), SetDataTip(STR_BUTTON_OK, STR_NULL),
  EndContainer(),
}

Definition at line 998 of file misc_gui.cpp.

const NWidgetPart _nested_query_widgets[] [static]
Initial value:
 {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, COLOUR_RED),
    NWidget(WWT_CAPTION, COLOUR_RED, WID_Q_CAPTION), SetDataTip(STR_JUST_STRING, STR_NULL),
  EndContainer(),
  NWidget(WWT_PANEL, COLOUR_RED), SetPIP(8, 15, 8),
    NWidget(WWT_TEXT, COLOUR_RED, WID_Q_TEXT), SetMinimalSize(200, 12),
    NWidget(NWID_HORIZONTAL, NC_EQUALSIZE), SetPIP(20, 29, 20),
      NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_Q_NO), SetMinimalSize(71, 12), SetDataTip(STR_QUIT_NO, STR_NULL),
      NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_Q_YES), SetMinimalSize(71, 12), SetDataTip(STR_QUIT_YES, STR_NULL),
    EndContainer(),
  EndContainer(),
}

Definition at line 1140 of file misc_gui.cpp.

const NWidgetPart _nested_tooltips_widgets[] [static]
Initial value:

Definition at line 604 of file misc_gui.cpp.