OpenTTD Source: src/date_gui.cpp Source File

OpenTTD Source 15.0-RC2

date_gui.cpp
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
10#include "stdafx.h"
11#include "strings_func.h"
12#include "timer/timer_game_economy.h"
13#include "window_func.h"
14#include "window_gui.h"
15#include "date_gui.h"
16#include "core/geometry_func.hpp"
17#include "dropdown_type.h"
18#include "dropdown_func.h"
19
20#include "widgets/date_widget.h"
21
22#include "table/strings.h"
23
24#include "safeguards.h"
25
26
28 struct SetDateWindow : Window {
29 SetDateCallback callback;
30 TimerGameEconomy::YearMonthDay date{};
31 TimerGameEconomy::Year min_year{};
32 TimerGameEconomy::Year max_year{};
33
44 SetDateWindow(WindowDesc &desc, WindowNumber window_number, Window *parent, TimerGameEconomy::Date initial_date, TimerGameEconomy::Year min_year, TimerGameEconomy::Year max_year, SetDateCallback &&callback) :
45 Window(desc),
46 callback(std::move(callback)),
47 min_year(std::max(EconomyTime::MIN_YEAR, min_year)),
48 max_year(std::min(EconomyTime::MAX_YEAR, max_year))
49 {
50 assert(this->min_year <= this->max_year);
51 this->parent = parent;
52 this->InitNested(window_number);
53
54 if (initial_date == 0) initial_date = TimerGameEconomy::date;
55 this->date = TimerGameEconomy::ConvertDateToYMD(initial_date);
56 this->date.year = Clamp(this->date.year, min_year, max_year);
57 }
58
59 Point OnInitialPosition([[maybe_unused]] int16_t sm_width, [[maybe_unused]] int16_t sm_height, [[maybe_unused]] int window_number) override
60 {
61 Point pt = { this->parent->left + this->parent->width / 2 - sm_width / 2, this->parent->top + this->parent->height / 2 - sm_height / 2 };
62 return pt;
63 }
64
69 void ShowDateDropDown(WidgetID widget)
70 {
71 int selected;
72 DropDownList list;
73
74 switch (widget) {
75 default: NOT_REACHED();
76
77 case WID_SD_DAY:
78 for (uint i = 0; i < 31; i++) {
79 list.push_back(MakeDropDownListStringItem(STR_DAY_NUMBER_1ST + i, i + 1));
80 }
81 selected = this->date.day;
82 break;
83
84 case WID_SD_MONTH:
85 for (uint i = 0; i < 12; i++) {
86 list.push_back(MakeDropDownListStringItem(STR_MONTH_JAN + i, i));
87 }
88 selected = this->date.month;
89 break;
90
91 case WID_SD_YEAR:
92 for (TimerGameEconomy::Year i = this->min_year; i <= this->max_year; i++) {
93 list.push_back(MakeDropDownListStringItem(GetString(STR_JUST_INT, i), i.base()));
94 }
95 selected = this->date.year.base();
96 break;
97 }
98
99 ShowDropDownList(this, std::move(list), selected, widget);
100 }
101
102 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
103 {
104 Dimension d = {0, 0};
105 switch (widget) {
106 default: return;
107
108 case WID_SD_DAY:
109 for (uint i = 0; i < 31; i++) {
110 d = maxdim(d, GetStringBoundingBox(STR_DAY_NUMBER_1ST + i));
111 }
112 break;
113
114 case WID_SD_MONTH:
115 for (uint i = 0; i < 12; i++) {
116 d = maxdim(d, GetStringBoundingBox(STR_MONTH_JAN + i));
117 }
118 break;
119
120 case WID_SD_YEAR:
121 d = maxdim(d, GetStringBoundingBox(GetString(STR_JUST_INT, GetParamMaxValue(this->max_year.base()))));
122 break;
123 }
124
125 d.width += padding.width;
126 d.height += padding.height;
127 size = d;
128 }
129
130 std::string GetWidgetString(WidgetID widget, StringID stringid) const override
131 {
132 switch (widget) {
133 case WID_SD_DAY: return GetString(STR_DAY_NUMBER_1ST + this->date.day - 1);
134 case WID_SD_MONTH: return GetString(STR_MONTH_JAN + this->date.month);
135 case WID_SD_YEAR: return GetString(STR_JUST_INT, this->date.year);
136 default: return this->Window::GetWidgetString(widget, stringid);
137 }
138 }
139
140 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
141 {
142 switch (widget) {
143 case WID_SD_DAY:
144 case WID_SD_MONTH:
145 case WID_SD_YEAR:
146 ShowDateDropDown(widget);
147 break;
148
149 case WID_SD_SET_DATE:
150 this->callback(this, TimerGameEconomy::ConvertYMDToDate(this->date.year, this->date.month, this->date.day));
151 this->Close();
152 break;
153 }
154 }
155
156 void OnDropdownSelect(WidgetID widget, int index, int) override
157 {
158 switch (widget) {
159 case WID_SD_DAY:
160 this->date.day = index;
161 break;
162
163 case WID_SD_MONTH:
164 this->date.month = index;
165 break;
166
167 case WID_SD_YEAR:
168 this->date.year = TimerGameEconomy::Year{index};
169 break;
170 }
171 this->SetDirty();
172 }
173};
174
176 static constexpr std::initializer_list<NWidgetPart> _nested_set_date_widgets = {
177 NWidget(NWID_HORIZONTAL),
178 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
179 NWidget(WWT_CAPTION, COLOUR_BROWN), SetStringTip(STR_DATE_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
180 EndContainer(),
181 NWidget(WWT_PANEL, COLOUR_BROWN),
182 NWidget(NWID_VERTICAL), SetPIP(6, 6, 6),
183 NWidget(NWID_HORIZONTAL, NWidContainerFlag::EqualSize), SetPIP(6, 6, 6),
184 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_SD_DAY), SetFill(1, 0), SetToolTip(STR_DATE_DAY_TOOLTIP),
185 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_SD_MONTH), SetFill(1, 0), SetToolTip(STR_DATE_MONTH_TOOLTIP),
186 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_SD_YEAR), SetFill(1, 0), SetToolTip(STR_DATE_YEAR_TOOLTIP),
187 EndContainer(),
188 NWidget(NWID_HORIZONTAL),
189 NWidget(NWID_SPACER), SetFill(1, 0),
190 NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_SD_SET_DATE), SetMinimalSize(100, 12), SetStringTip(STR_DATE_SET_DATE, STR_DATE_SET_DATE_TOOLTIP),
191 NWidget(NWID_SPACER), SetFill(1, 0),
192 EndContainer(),
193 EndContainer(),
194 EndContainer()
195};
196
198 static WindowDesc _set_date_desc(
199 WDP_CENTER, {}, 0, 0,
200 WC_SET_DATE, WC_NONE,
201 {},
202 _nested_set_date_widgets
203);
204
214 void ShowSetDateWindow(Window *parent, int window_number, TimerGameEconomy::Date initial_date, TimerGameEconomy::Year min_year, TimerGameEconomy::Year max_year, SetDateCallback &&callback)
215{
216 CloseWindowByClass(WC_SET_DATE);
217 new SetDateWindow(_set_date_desc, window_number, parent, initial_date, min_year, max_year, std::move(callback));
218}
EconomyTime
Storage class for Economy time constants.
Definition timer_game_economy.h:50
TimerGameEconomy::date
static Date date
Current date in days (day counter).
Definition timer_game_economy.h:38
TimerGameEconomy::ConvertDateToYMD
static YearMonthDay ConvertDateToYMD(Date date)
Converts a Date to a Year, Month & Day.
Definition timer_game_economy.cpp:47
TimerGameEconomy::ConvertYMDToDate
static Date ConvertYMDToDate(Year year, Month month, Day day)
Converts a tuple of Year, Month and Day to a Date.
Definition timer_game_economy.cpp:67
_set_date_desc
static WindowDesc _set_date_desc(WDP_CENTER, {}, 0, 0, WC_SET_DATE, WC_NONE, {}, _nested_set_date_widgets)
Description of the date setting window.
ShowSetDateWindow
void ShowSetDateWindow(Window *parent, int window_number, TimerGameEconomy::Date initial_date, TimerGameEconomy::Year min_year, TimerGameEconomy::Year max_year, SetDateCallback &&callback)
Create the new 'set date' window.
Definition date_gui.cpp:214
_nested_set_date_widgets
static constexpr std::initializer_list< NWidgetPart > _nested_set_date_widgets
Widgets for the date setting window.
Definition date_gui.cpp:176
date_gui.h
Functions related to the graphical selection of a date.
SetDateCallback
std::function< void(const Window *w, TimerGameEconomy::Date date)> SetDateCallback
Callback for when a date has been chosen.
Definition date_gui.h:21
date_widget.h
Types related to the date widgets.
WID_SD_DAY
@ WID_SD_DAY
Dropdown for the day.
Definition date_widget.h:15
WID_SD_YEAR
@ WID_SD_YEAR
Dropdown for the year.
Definition date_widget.h:17
WID_SD_SET_DATE
@ WID_SD_SET_DATE
Actually set the date.
Definition date_widget.h:18
WID_SD_MONTH
@ WID_SD_MONTH
Dropdown for the month.
Definition date_widget.h:16
ShowDropDownList
void ShowDropDownList(Window *w, DropDownList &&list, int selected, WidgetID button, uint width, DropDownOptions options)
Show a drop down list.
Definition dropdown.cpp:418
dropdown_func.h
Functions related to the drop down widget.
dropdown_type.h
Types related to the drop down widget.
DropDownList
std::vector< std::unique_ptr< const DropDownListItem > > DropDownList
A drop down list is a collection of drop down list items.
Definition dropdown_type.h:56
maxdim
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
Definition geometry_func.cpp:22
geometry_func.hpp
Geometry functions.
GetStringBoundingBox
Dimension GetStringBoundingBox(std::string_view str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition gfx.cpp:894
SetFill
constexpr NWidgetPart SetFill(uint16_t fill_x, uint16_t fill_y)
Widget part function for setting filling.
Definition widget_type.h:1219
SetPIP
constexpr NWidgetPart SetPIP(uint8_t pre, uint8_t inter, uint8_t post)
Widget part function for setting a pre/inter/post spaces.
Definition widget_type.h:1375
SetStringTip
constexpr NWidgetPart SetStringTip(StringID string, StringID tip={})
Widget part function for setting the string and tooltip.
Definition widget_type.h:1240
SetMinimalSize
constexpr NWidgetPart SetMinimalSize(int16_t x, int16_t y)
Widget part function for setting the minimal size.
Definition widget_type.h:1156
SetToolTip
constexpr NWidgetPart SetToolTip(StringID tip)
Widget part function for setting tooltip and clearing the widget data.
Definition widget_type.h:1318
EndContainer
constexpr NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition widget_type.h:1229
NWidget
constexpr NWidgetPart NWidget(WidgetType tp, Colours col, WidgetID idx=INVALID_WIDGET)
Widget part function for starting a new 'real' widget.
Definition widget_type.h:1424
Window::SetDirty
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition window.cpp:966
Clamp
constexpr T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition math_func.hpp:79
safeguards.h
A number of safeguards to prevent using unsafe methods.
stdafx.h
Definition of base types and functions in a cross-platform compatible way.
GetParamMaxValue
uint64_t GetParamMaxValue(uint64_t max_value, uint min_count, FontSize size)
Get some number that is suitable for string size computations.
Definition strings.cpp:236
GetString
std::string GetString(StringID string)
Resolve the given StringID into a std::string with formatting but no parameters.
Definition strings.cpp:424
strings_func.h
Functions related to OTTD's strings.
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition strings_type.h:19
Coord2D< int >
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition geometry_type.hpp:56
SetDateWindow
Window to select a date graphically by using dropdowns.
Definition date_gui.cpp:28
SetDateWindow::OnInitialPosition
Point OnInitialPosition(int16_t sm_width, int16_t sm_height, int window_number) override
Compute the initial position of the window.
Definition date_gui.cpp:59
SetDateWindow::OnClick
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition date_gui.cpp:140
SetDateWindow::UpdateWidgetSize
void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
Update size and resize step of a widget in the window.
Definition date_gui.cpp:102
SetDateWindow::OnDropdownSelect
void OnDropdownSelect(WidgetID widget, int index, int) override
A dropdown option associated to this window has been selected.
Definition date_gui.cpp:156
SetDateWindow::min_year
TimerGameEconomy::Year min_year
The minimum year in the year dropdown.
Definition date_gui.cpp:31
SetDateWindow::GetWidgetString
std::string GetWidgetString(WidgetID widget, StringID stringid) const override
Get the raw string for a widget.
Definition date_gui.cpp:130
SetDateWindow::callback
SetDateCallback callback
Callback to call when a date has been selected.
Definition date_gui.cpp:29
SetDateWindow::SetDateWindow
SetDateWindow(WindowDesc &desc, WindowNumber window_number, Window *parent, TimerGameEconomy::Date initial_date, TimerGameEconomy::Year min_year, TimerGameEconomy::Year max_year, SetDateCallback &&callback)
Create the new 'set date' window.
Definition date_gui.cpp:44
SetDateWindow::ShowDateDropDown
void ShowDateDropDown(WidgetID widget)
Helper function to construct the dropdown.
Definition date_gui.cpp:69
SetDateWindow::max_year
TimerGameEconomy::Year max_year
The maximum year (inclusive) in the year dropdown.
Definition date_gui.cpp:32
SetDateWindow::date
TimerGameEconomy::YearMonthDay date
The currently selected date.
Definition date_gui.cpp:30
StrongType::Typedef
Templated helper to make a type-safe 'typedef' representing a single POD value.
Definition strong_typedef_type.hpp:130
WindowDesc
High level window description.
Definition window_gui.h:168
WindowNumber
Number to differentiate different windows of the same class.
Definition window_type.h:760
Window
Data structure for an opened window.
Definition window_gui.h:274
Window::Close
virtual void Close(int data=0)
Hide the window and all its child windows, and mark them for a later deletion.
Definition window.cpp:1102
Window::parent
Window * parent
Parent window.
Definition window_gui.h:329
Window::GetWidgetString
virtual std::string GetWidgetString(WidgetID widget, StringID stringid) const
Get the raw string for a widget.
Definition window.cpp:504
Window::resize
ResizeInfo resize
Resize information.
Definition window_gui.h:315
Window::left
int left
x position of left edge of the window
Definition window_gui.h:310
Window::top
int top
y position of top edge of the window
Definition window_gui.h:311
Window::InitNested
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition window.cpp:1820
Window::height
int height
Height of the window (number of pixels down in y direction)
Definition window_gui.h:313
Window::width
int width
width of the window (number of pixels to the right in x direction)
Definition window_gui.h:312
Window::window_number
WindowNumber window_number
Window number within the window class.
Definition window_gui.h:303
timer_game_economy.h
Definition of the game-economy-timer.
WWT_PUSHTXTBTN
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
Definition widget_type.h:104
NWID_SPACER
@ NWID_SPACER
Invisible widget that takes some space.
Definition widget_type.h:70
NWID_HORIZONTAL
@ NWID_HORIZONTAL
Horizontal container.
Definition widget_type.h:66
WWT_PANEL
@ WWT_PANEL
Simple depressed panel.
Definition widget_type.h:39
WWT_CAPTION
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition widget_type.h:52
NWID_VERTICAL
@ NWID_VERTICAL
Vertical container.
Definition widget_type.h:68
WWT_CLOSEBOX
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition widget_type.h:60
WWT_DROPDOWN
@ WWT_DROPDOWN
Drop down list.
Definition widget_type.h:61
EqualSize
@ EqualSize
Containers should keep all their (resizing) children equally large.
Definition widget_type.h:541
CloseWindowByClass
void CloseWindowByClass(WindowClass cls, int data)
Close all windows of a given class.
Definition window.cpp:1205
window_func.h
Window functions not directly related to making/drawing windows.
window_gui.h
Functions, definitions and such used only by the GUI.
WDP_CENTER
@ WDP_CENTER
Center the window.
Definition window_gui.h:145
WidgetID
int WidgetID
Widget ID.
Definition window_type.h:20
WC_SET_DATE
@ WC_SET_DATE
Set date; Window numbers:
Definition window_type.h:173
WC_NONE
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition window_type.h:50