4 * This file is part of OpenTTD.
5 * 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.
6 * 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.
7 * 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/>.
10 /** @file statusbar_gui.cpp The GUI for the bottom status bar. */
13 #include "date_func.h"
15 #include "news_func.h"
16 #include "company_func.h"
18 #include "strings_func.h"
19 #include "company_base.h"
20 #include "tilehighlight_func.h"
22 #include "company_gui.h"
23 #include "window_gui.h"
24 #include "saveload/saveload.h"
25 #include "window_func.h"
26 #include "statusbar_gui.h"
27 #include "toolbar_gui.h"
28 #include "core/geometry_func.hpp"
30 #include "widgets/statusbar_widget.h"
32 #include "table/strings.h"
33 #include "table/sprites.h"
35 static bool DrawScrollingStatusText(const NewsItem
*ni
, int scroll_pos
, int left
, int right
, int top
, int bottom
)
37 CopyInDParam(0, ni
->params
, lengthof(ni
->params
));
38 StringID str
= ni
->string_id
;
46 const char *last
= lastof(buffer
);
49 WChar c
= Utf8Consume(&s
);
52 } else if (c
== '\n') {
53 if (d
+ 4 >= last
) break;
54 d
[0] = d
[1] = d
[2] = d
[3] = ' ';
56 } else if (IsPrintable(c
)) {
57 if (d
+ Utf8CharLen(c
) >= last
) break;
58 d
+= Utf8Encode(d
, c
);
63 DrawPixelInfo tmp_dpi
;
64 if (!FillDrawPixelInfo(&tmp_dpi
, left
, top
, right
- left
, bottom
)) return true;
66 int width
= GetStringBoundingBox(buffer
).width
;
67 int pos
= (_current_text_dir
== TD_RTL
) ? (scroll_pos
- width
) : (right
- scroll_pos
- left
);
69 DrawPixelInfo
*old_dpi
= _cur_dpi
;
71 DrawString(pos
, INT16_MAX
, 0, buffer
, TC_LIGHT_BLUE
, SA_LEFT
| SA_FORCE
);
74 return (_current_text_dir
== TD_RTL
) ? (pos
< right
- left
) : (pos
+ width
> 0);
77 struct StatusBarWindow
: Window
{
82 static const int TICKER_STOP
= 1640; ///< scrolling is finished when counter reaches this value
83 static const int REMINDER_START
= 91; ///< initial value of the reminder counter (right dot on the right)
84 static const int REMINDER_STOP
= 0; ///< reminder disappears when counter reaches this value
85 static const int COUNTER_STEP
= 2; ///< this is subtracted from active counters every tick
87 StatusBarWindow(WindowDesc
*desc
) : Window(desc
)
89 this->ticker_scroll
= TICKER_STOP
;
90 this->reminder_timeout
= REMINDER_STOP
;
93 CLRBITS(this->flags
, WF_WHITE_BORDER
);
94 PositionStatusbar(this);
97 virtual Point
OnInitialPosition(int16 sm_width
, int16 sm_height
, int window_number
)
99 Point pt
= { 0, _screen
.height
- sm_height
};
103 virtual void FindWindowPlacementAndResize(int def_width
, int def_height
)
105 Window::FindWindowPlacementAndResize(_toolbar_width
, def_height
);
108 virtual void UpdateWidgetSize(int widget
, Dimension
*size
, const Dimension
&padding
, Dimension
*fill
, Dimension
*resize
)
113 SetDParamMaxValue(0, MAX_YEAR
* DAYS_IN_YEAR
);
114 d
= GetStringBoundingBox(STR_WHITE_DATE_LONG
);
118 int64 max_money
= UINT32_MAX
;
120 FOR_ALL_COMPANIES(c
) max_money
= max
<int64
>(c
->money
, max_money
);
121 SetDParam(0, 100LL * max_money
);
122 d
= GetStringBoundingBox(STR_COMPANY_MONEY
);
130 d
.width
+= padding
.width
;
131 d
.height
+= padding
.height
;
132 *size
= maxdim(d
, *size
);
135 virtual void DrawWidget(const Rect
&r
, int widget
) const
141 DrawString(r
.left
+ WD_FRAMERECT_LEFT
, r
.right
- WD_FRAMERECT_RIGHT
, r
.top
+ WD_FRAMERECT_TOP
, STR_WHITE_DATE_LONG
, TC_FROMSTRING
, SA_HOR_CENTER
);
145 /* Draw company money, if any */
146 const Company
*c
= Company::GetIfValid(_local_company
);
148 SetDParam(0, c
->money
);
149 DrawString(r
.left
+ WD_FRAMERECT_LEFT
, r
.right
- WD_FRAMERECT_RIGHT
, r
.top
+ WD_FRAMERECT_TOP
, STR_COMPANY_MONEY
, TC_FROMSTRING
, SA_HOR_CENTER
);
155 /* Draw status bar */
156 if (this->saving
) { // true when saving is active
157 DrawString(r
.left
+ WD_FRAMERECT_LEFT
, r
.right
- WD_FRAMERECT_RIGHT
, r
.top
+ WD_FRAMERECT_TOP
, STR_STATUSBAR_SAVING_GAME
, TC_FROMSTRING
, SA_HOR_CENTER
);
158 } else if (_do_autosave
) {
159 DrawString(r
.left
+ WD_FRAMERECT_LEFT
, r
.right
- WD_FRAMERECT_RIGHT
, r
.top
+ WD_FRAMERECT_TOP
, STR_STATUSBAR_AUTOSAVE
, TC_FROMSTRING
, SA_HOR_CENTER
);
160 } else if (_pause_mode
!= PM_UNPAUSED
) {
161 DrawString(r
.left
+ WD_FRAMERECT_LEFT
, r
.right
- WD_FRAMERECT_RIGHT
, r
.top
+ WD_FRAMERECT_TOP
, STR_STATUSBAR_PAUSED
, TC_FROMSTRING
, SA_HOR_CENTER
);
162 } else if (this->ticker_scroll
< TICKER_STOP
&& FindWindowById(WC_NEWS_WINDOW
, 0) == NULL
&& _statusbar_news_item
!= NULL
&& _statusbar_news_item
->string_id
!= 0) {
163 /* Draw the scrolling news text */
164 if (!DrawScrollingStatusText(_statusbar_news_item
, this->ticker_scroll
, r
.left
+ WD_FRAMERECT_LEFT
, r
.right
- WD_FRAMERECT_RIGHT
, r
.top
+ WD_FRAMERECT_TOP
, r
.bottom
)) {
165 InvalidateWindowData(WC_STATUS_BAR
, 0, SBI_NEWS_DELETED
);
166 if (Company::IsValidID(_local_company
)) {
167 /* This is the default text */
168 SetDParam(0, _local_company
);
169 DrawString(r
.left
+ WD_FRAMERECT_LEFT
, r
.right
- WD_FRAMERECT_RIGHT
, r
.top
+ WD_FRAMERECT_TOP
, STR_STATUSBAR_COMPANY_NAME
, TC_FROMSTRING
, SA_HOR_CENTER
);
173 if (Company::IsValidID(_local_company
)) {
174 /* This is the default text */
175 SetDParam(0, _local_company
);
176 DrawString(r
.left
+ WD_FRAMERECT_LEFT
, r
.right
- WD_FRAMERECT_RIGHT
, r
.top
+ WD_FRAMERECT_TOP
, STR_STATUSBAR_COMPANY_NAME
, TC_FROMSTRING
, SA_HOR_CENTER
);
180 if (this->reminder_timeout
> 0) {
181 Dimension icon_size
= GetSpriteSize(SPR_UNREAD_NEWS
);
182 DrawSprite(SPR_UNREAD_NEWS
, PAL_NONE
, r
.right
- WD_FRAMERECT_RIGHT
- icon_size
.width
, r
.top
+ WD_FRAMERECT_TOP
+ (int)(FONT_HEIGHT_NORMAL
- icon_size
.height
) / 2);
189 * Some data on this window has become invalid.
190 * @param data Information about the changed data.
191 * @param gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See #InvalidateWindowData() for details.
193 virtual void OnInvalidateData(int data
= 0, bool gui_scope
= true)
195 if (!gui_scope
) return;
197 default: NOT_REACHED();
198 case SBI_SAVELOAD_START
: this->saving
= true; break;
199 case SBI_SAVELOAD_FINISH
: this->saving
= false; break;
200 case SBI_SHOW_TICKER
: this->ticker_scroll
= 0; break;
201 case SBI_SHOW_REMINDER
: this->reminder_timeout
= REMINDER_START
; break;
202 case SBI_NEWS_DELETED
:
203 this->ticker_scroll
= TICKER_STOP
; // reset ticker ...
204 this->reminder_timeout
= REMINDER_STOP
; // ... and reminder
209 virtual void OnClick(Point pt
, int widget
, int click_count
)
212 case WID_S_MIDDLE
: ShowLastNewsMessage(); break;
213 case WID_S_RIGHT
: if (_local_company
!= COMPANY_SPECTATOR
) ShowCompanyFinances(_local_company
); break;
214 default: ResetObjectToPlace();
218 virtual void OnTick()
220 if (_pause_mode
!= PM_UNPAUSED
) return;
222 if (this->ticker_scroll
< TICKER_STOP
) { // Scrolling text
223 this->ticker_scroll
+= COUNTER_STEP
;
224 this->SetWidgetDirty(WID_S_MIDDLE
);
227 if (this->reminder_timeout
> REMINDER_STOP
) { // Red blot to show there are new unread newsmessages
228 this->reminder_timeout
-= COUNTER_STEP
;
229 } else if (this->reminder_timeout
< REMINDER_STOP
) {
230 this->reminder_timeout
= REMINDER_STOP
;
231 this->SetWidgetDirty(WID_S_MIDDLE
);
236 static const NWidgetPart _nested_main_status_widgets
[] = {
237 NWidget(NWID_HORIZONTAL
),
238 NWidget(WWT_PANEL
, COLOUR_GREY
, WID_S_LEFT
), SetMinimalSize(140, 12), EndContainer(),
239 NWidget(WWT_PUSHBTN
, COLOUR_GREY
, WID_S_MIDDLE
), SetMinimalSize(40, 12), SetDataTip(0x0, STR_STATUSBAR_TOOLTIP_SHOW_LAST_NEWS
), SetResize(1, 0),
240 NWidget(WWT_PUSHBTN
, COLOUR_GREY
, WID_S_RIGHT
), SetMinimalSize(140, 12),
244 static WindowDesc
_main_status_desc(
245 WDP_MANUAL
, NULL
, 0, 0,
246 WC_STATUS_BAR
, WC_NONE
,
248 _nested_main_status_widgets
, lengthof(_nested_main_status_widgets
)
252 * Checks whether the news ticker is currently being used.
254 bool IsNewsTickerShown()
256 const StatusBarWindow
*w
= dynamic_cast<StatusBarWindow
*>(FindWindowById(WC_STATUS_BAR
, 0));
257 return w
!= NULL
&& w
->ticker_scroll
< StatusBarWindow::TICKER_STOP
;
261 * Show our status bar.
265 new StatusBarWindow(&_main_status_desc
);