OpenTTD Source: src/textfile_gui.h Source File

OpenTTD Source 1.11.0-RC1

textfile_gui.h
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 #ifndef TEXTFILE_GUI_H
11 #define TEXTFILE_GUI_H
12
13 #include "fileio_type.h"
14 #include "strings_func.h"
15 #include "textfile_type.h"
16 #include "window_gui.h"
17
18 const char *GetTextfile(TextfileType type, Subdirectory dir, const char *filename);
19
21 struct TextfileWindow : public Window, MissingGlyphSearcher {
22 TextfileType file_type;
23 Scrollbar *vscroll;
24 Scrollbar *hscroll;
25 char *text;
26 std::vector<const char *> lines;
27 uint search_iterator;
28
29 static const int TOP_SPACING = WD_FRAMETEXT_TOP;
30 static const int BOTTOM_SPACING = WD_FRAMETEXT_BOTTOM;
31
32 TextfileWindow(TextfileType file_type);
33 ~TextfileWindow();
34
35 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override;
36 void OnClick(Point pt, int widget, int click_count) override;
37 void DrawWidget(const Rect &r, int widget) const override;
38 void OnResize() override;
39
40 void Reset() override;
41 FontSize DefaultSize() override;
42 const char *NextString() override;
43 bool Monospace() override;
44 void SetFontNames(FreeTypeSettings *settings, const char *font_name, const void *os_data) override;
45
46 virtual void LoadTextfile(const char *textfile, Subdirectory dir);
47
48 private:
49 uint GetContentHeight();
50 void SetupScrollbars();
51 };
52
53 #endif /* TEXTFILE_GUI_H */
TextfileWindow::DefaultSize
FontSize DefaultSize() override
Get the default (font) size of the string.
Definition: textfile_gui.cpp:178
TextfileWindow::LoadTextfile
virtual void LoadTextfile(const char *textfile, Subdirectory dir)
Loads the textfile text from file and setup lines.
Definition: textfile_gui.cpp:317
TextfileWindow::UpdateWidgetSize
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: textfile_gui.cpp:94
MissingGlyphSearcher
A searcher for missing glyphs.
Definition: strings_func.h:244
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition: geometry_type.hpp:27
TextfileWindow::SetupScrollbars
void SetupScrollbars()
Set scrollbars to the right lengths.
Definition: textfile_gui.cpp:107
TextfileWindow::lines
std::vector< const char * > lines
text, split into lines in a table with lines.
Definition: textfile_gui.h:26
TextfileWindow::OnResize
void OnResize() override
Called after the window got resized.
Definition: textfile_gui.cpp:165
TextfileWindow::BOTTOM_SPACING
static const int BOTTOM_SPACING
Additional spacing at the bottom of the WID_TF_BACKGROUND widget.
Definition: textfile_gui.h:30
WD_FRAMETEXT_TOP
@ WD_FRAMETEXT_TOP
Top offset of the text of the frame.
Definition: window_gui.h:72
Scrollbar
Scrollbar data structure.
Definition: widget_type.h:588
TextfileWindow::file_type
TextfileType file_type
Type of textfile to view.
Definition: textfile_gui.h:22
window_gui.h
TextfileWindow::SetFontNames
void SetFontNames(FreeTypeSettings *settings, const char *font_name, const void *os_data) override
Set the right font names.
Definition: textfile_gui.cpp:195
textfile_type.h
Window::resize
ResizeInfo resize
Resize information.
Definition: window_gui.h:322
TextfileWindow::TOP_SPACING
static const int TOP_SPACING
Additional spacing at the top of the WID_TF_BACKGROUND widget.
Definition: textfile_gui.h:29
WD_FRAMETEXT_BOTTOM
@ WD_FRAMETEXT_BOTTOM
Bottom offset of the text of the frame.
Definition: window_gui.h:73
TextfileWindow::NextString
const char * NextString() override
Get the next string to search through.
Definition: textfile_gui.cpp:183
settings
fluid_settings_t * settings
FluidSynth settings handle.
Definition: fluidsynth.cpp:21
TextfileWindow::OnClick
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: textfile_gui.cpp:124
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
TextfileWindow::text
char * text
Lines of text from the NewGRF's textfile.
Definition: textfile_gui.h:25
TextfileWindow::hscroll
Scrollbar * hscroll
Horizontal scrollbar.
Definition: textfile_gui.h:24
TextfileWindow::Reset
void Reset() override
Reset the search, i.e.
Definition: textfile_gui.cpp:173
strings_func.h
TextfileWindow::search_iterator
uint search_iterator
Iterator for the font check search.
Definition: textfile_gui.h:27
TextfileWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: textfile_gui.cpp:135
GetTextfile
const char * GetTextfile(TextfileType type, Subdirectory dir, const char *filename)
Search a textfile file next to the given content.
Definition: textfile_gui.cpp:385
TextfileWindow::Monospace
bool Monospace() override
Whether to search for a monospace font or not.
Definition: textfile_gui.cpp:190
fileio_type.h
Subdirectory
Subdirectory
The different kinds of subdirectories OpenTTD uses.
Definition: fileio_type.h:108
TextfileWindow
Window for displaying a textfile.
Definition: textfile_gui.h:21
FontSize
FontSize
Available font sizes.
Definition: gfx_type.h:206
Window
Data structure for an opened window.
Definition: window_gui.h:276
TextfileType
TextfileType
Additional text files accompanying Tar archives.
Definition: textfile_type.h:14
TextfileWindow::GetContentHeight
uint GetContentHeight()
Get the total height of the content displayed in this window, if wrapping is disabled.
Definition: textfile_gui.cpp:82
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:47
FreeTypeSettings
Settings for the freetype fonts.
Definition: fontcache.h:225
TextfileWindow::vscroll
Scrollbar * vscroll
Vertical scrollbar.
Definition: textfile_gui.h:23