OpenTTD Source: src/date_gui.cpp Source File

OpenTTD Source 15.0-beta1

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 <http://www.gnu.org/licenses/>.
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 "safeguards.h"
23
24
26 struct SetDateWindow : Window {
27 SetDateCallback *callback;
28 void *callback_data;
29 TimerGameEconomy::YearMonthDay date;
30 TimerGameEconomy::Year min_year;
31 TimerGameEconomy::Year max_year;
32
43 SetDateWindow(WindowDesc &desc, WindowNumber window_number, Window *parent, TimerGameEconomy::Date initial_date, TimerGameEconomy::Year min_year, TimerGameEconomy::Year max_year, SetDateCallback *callback, void *callback_data) :
44 Window(desc),
45 callback(callback),
46 callback_data(callback_data),
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 SetDParam(0, i);
94 list.push_back(MakeDropDownListStringItem(STR_JUST_INT, i.base()));
95 }
96 selected = this->date.year.base();
97 break;
98 }
99
100 ShowDropDownList(this, std::move(list), selected, widget);
101 }
102
103 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
104 {
105 Dimension d = {0, 0};
106 switch (widget) {
107 default: return;
108
109 case WID_SD_DAY:
110 for (uint i = 0; i < 31; i++) {
111 d = maxdim(d, GetStringBoundingBox(STR_DAY_NUMBER_1ST + i));
112 }
113 break;
114
115 case WID_SD_MONTH:
116 for (uint i = 0; i < 12; i++) {
117 d = maxdim(d, GetStringBoundingBox(STR_MONTH_JAN + i));
118 }
119 break;
120
121 case WID_SD_YEAR:
122 SetDParamMaxValue(0, this->max_year);
123 d = maxdim(d, GetStringBoundingBox(STR_JUST_INT));
124 break;
125 }
126
127 d.width += padding.width;
128 d.height += padding.height;
129 size = d;
130 }
131
132 void SetStringParameters(WidgetID widget) const override
133 {
134 switch (widget) {
135 case WID_SD_DAY: SetDParam(0, this->date.day - 1 + STR_DAY_NUMBER_1ST); break;
136 case WID_SD_MONTH: SetDParam(0, this->date.month + STR_MONTH_JAN); break;
137 case WID_SD_YEAR: SetDParam(0, this->date.year); break;
138 }
139 }
140
141 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
142 {
143 switch (widget) {
144 case WID_SD_DAY:
145 case WID_SD_MONTH:
146 case WID_SD_YEAR:
147 ShowDateDropDown(widget);
148 break;
149
150 case WID_SD_SET_DATE:
151 if (this->callback != nullptr) this->callback(this, TimerGameEconomy::ConvertYMDToDate(this->date.year, this->date.month, this->date.day), this->callback_data);
152 this->Close();
153 break;
154 }
155 }
156
157 void OnDropdownSelect(WidgetID widget, int index) override
158 {
159 switch (widget) {
160 case WID_SD_DAY:
161 this->date.day = index;
162 break;
163
164 case WID_SD_MONTH:
165 this->date.month = index;
166 break;
167
168 case WID_SD_YEAR:
169 this->date.year = index;
170 break;
171 }
172 this->SetDirty();
173 }
174};
175
177 static constexpr NWidgetPart _nested_set_date_widgets[] = {
178 NWidget(NWID_HORIZONTAL),
179 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
180 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_DATE_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
181 EndContainer(),
182 NWidget(WWT_PANEL, COLOUR_BROWN),
183 NWidget(NWID_VERTICAL), SetPIP(6, 6, 6),
184 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE), SetPIP(6, 6, 6),
185 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_SD_DAY), SetFill(1, 0), SetDataTip(STR_JUST_STRING, STR_DATE_DAY_TOOLTIP),
186 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_SD_MONTH), SetFill(1, 0), SetDataTip(STR_JUST_STRING, STR_DATE_MONTH_TOOLTIP),
187 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_SD_YEAR), SetFill(1, 0), SetDataTip(STR_JUST_INT, STR_DATE_YEAR_TOOLTIP),
188 EndContainer(),
189 NWidget(NWID_HORIZONTAL),
190 NWidget(NWID_SPACER), SetFill(1, 0),
191 NWidget(WWT_PUSHTXTBTN, COLOUR_BROWN, WID_SD_SET_DATE), SetMinimalSize(100, 12), SetDataTip(STR_DATE_SET_DATE, STR_DATE_SET_DATE_TOOLTIP),
192 NWidget(NWID_SPACER), SetFill(1, 0),
193 EndContainer(),
194 EndContainer(),
195 EndContainer()
196};
197
199 static WindowDesc _set_date_desc(
200 WDP_CENTER, nullptr, 0, 0,
201 WC_SET_DATE, WC_NONE,
202 0,
203 _nested_set_date_widgets
204);
205
216 void ShowSetDateWindow(Window *parent, int window_number, TimerGameEconomy::Date initial_date, TimerGameEconomy::Year min_year, TimerGameEconomy::Year max_year, SetDateCallback *callback, void *callback_data)
217{
218 CloseWindowByClass(WC_SET_DATE);
219 new SetDateWindow(_set_date_desc, window_number, parent, initial_date, min_year, max_year, callback, callback_data);
220}
EconomyTime
Storage class for Economy time constants.
Definition timer_game_economy.h:49
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:46
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:66
_nested_set_date_widgets
static constexpr NWidgetPart _nested_set_date_widgets[]
Widgets for the date setting window.
Definition date_gui.cpp:177
_set_date_desc
static WindowDesc _set_date_desc(WDP_CENTER, nullptr, 0, 0, WC_SET_DATE, WC_NONE, 0, _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, void *callback_data)
Create the new 'set date' window.
Definition date_gui.cpp:216
date_gui.h
Functions related to the graphical selection of a date.
SetDateCallback
void SetDateCallback(const Window *w, TimerGameEconomy::Date date, void *data)
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, bool instant_close, bool persist)
Show a drop down list.
Definition dropdown.cpp:404
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:50
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:851
SetFill
constexpr NWidgetPart SetFill(uint16_t fill_x, uint16_t fill_y)
Widget part function for setting filling.
Definition widget_type.h:1181
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:1271
SetDataTip
constexpr NWidgetPart SetDataTip(uint32_t data, StringID tip)
Widget part function for setting the data and tooltip.
Definition widget_type.h:1202
SetMinimalSize
constexpr NWidgetPart SetMinimalSize(int16_t x, int16_t y)
Widget part function for setting the minimal size.
Definition widget_type.h:1137
NWidget
constexpr NWidgetPart NWidget(WidgetType tp, Colours col, WidgetID idx=-1)
Widget part function for starting a new 'real' widget.
Definition widget_type.h:1320
EndContainer
constexpr NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition widget_type.h:1191
Window::SetDirty
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition window.cpp:940
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.
SetDParamMaxValue
void SetDParamMaxValue(size_t n, uint64_t max_value, uint min_count, FontSize size)
Set DParam n to some number that is suitable for string size computations.
Definition strings.cpp:127
SetDParam
void SetDParam(size_t n, uint64_t v)
Set a string parameter v at index n in the global string parameter array.
Definition strings.cpp:104
strings_func.h
Functions related to OTTD's strings.
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition geometry_type.hpp:30
NWidgetPart
Partial widget specification to allow NWidgets to be written nested.
Definition widget_type.h:1075
Point
Coordinates of a point in 2D.
Definition geometry_type.hpp:21
SetDateWindow
Window to select a date graphically by using dropdowns.
Definition date_gui.cpp:26
SetDateWindow::SetDateWindow
SetDateWindow(WindowDesc &desc, WindowNumber window_number, Window *parent, TimerGameEconomy::Date initial_date, TimerGameEconomy::Year min_year, TimerGameEconomy::Year max_year, SetDateCallback *callback, void *callback_data)
Create the new 'set date' window.
Definition date_gui.cpp:43
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:141
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:103
SetDateWindow::OnDropdownSelect
void OnDropdownSelect(WidgetID widget, int index) override
A dropdown option associated to this window has been selected.
Definition date_gui.cpp:157
SetDateWindow::min_year
TimerGameEconomy::Year min_year
The minimum year in the year dropdown.
Definition date_gui.cpp:30
SetDateWindow::callback
SetDateCallback * callback
Callback to call when a date has been selected.
Definition date_gui.cpp:27
SetDateWindow::SetStringParameters
void SetStringParameters(WidgetID widget) const override
Initialize string parameters for a widget.
Definition date_gui.cpp:132
SetDateWindow::callback_data
void * callback_data
Callback data pointer.
Definition date_gui.cpp:28
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:31
SetDateWindow::date
TimerGameEconomy::YearMonthDay date
The currently selected date.
Definition date_gui.cpp:29
StrongType::Typedef
Templated helper to make a type-safe 'typedef' representing a single POD value.
Definition strong_typedef_type.hpp:150
WindowDesc
High level window description.
Definition window_gui.h:159
Window
Data structure for an opened window.
Definition window_gui.h:273
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:1047
Window::parent
Window * parent
Parent window.
Definition window_gui.h:328
Window::resize
ResizeInfo resize
Resize information.
Definition window_gui.h:314
Window::left
int left
x position of left edge of the window
Definition window_gui.h:309
Window::top
int top
y position of top edge of the window
Definition window_gui.h:310
Window::GetWidget
const NWID * GetWidget(WidgetID widnum) const
Get the nested widget with number widnum from the nested widget tree.
Definition window_gui.h:977
Window::InitNested
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition window.cpp:1746
Window::height
int height
Height of the window (number of pixels down in y direction)
Definition window_gui.h:312
Window::width
int width
width of the window (number of pixels to the right in x direction)
Definition window_gui.h:311
Window::window_number
WindowNumber window_number
Window number within the window class.
Definition window_gui.h:302
timer_game_economy.h
Definition of the game-economy-timer.
NC_EQUALSIZE
@ NC_EQUALSIZE
Value of the NCB_EQUALSIZE flag.
Definition widget_type.h:524
WWT_PUSHTXTBTN
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
Definition widget_type.h:113
NWID_SPACER
@ NWID_SPACER
Invisible widget that takes some space.
Definition widget_type.h:79
NWID_HORIZONTAL
@ NWID_HORIZONTAL
Horizontal container.
Definition widget_type.h:75
WWT_PANEL
@ WWT_PANEL
Simple depressed panel.
Definition widget_type.h:50
WWT_CAPTION
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition widget_type.h:61
NWID_VERTICAL
@ NWID_VERTICAL
Vertical container.
Definition widget_type.h:77
WWT_CLOSEBOX
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition widget_type.h:69
WWT_DROPDOWN
@ WWT_DROPDOWN
Drop down list.
Definition widget_type.h:70
CloseWindowByClass
void CloseWindowByClass(WindowClass cls, int data)
Close all windows of a given class.
Definition window.cpp:1152
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:148
WidgetID
int WidgetID
Widget ID.
Definition window_type.h:18
WindowNumber
int32_t WindowNumber
Number to differentiate different windows of the same class.
Definition window_type.h:740
WC_SET_DATE
@ WC_SET_DATE
Set date; Window numbers:
Definition window_type.h:168
WC_NONE
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition window_type.h:45