Window for displaying a textfile. More...

#include <textfile_gui.h>

Inheritance diagram for TextfileWindow:

Data Structures
struct	HistoryEntry

struct	Hyperlink

struct	Line

Public Member Functions
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.

void	OnClick (Point pt, WidgetID widget, int click_count) override
	A click with the left mouse button has been made on the window.

void	DrawWidget (const Rect &r, WidgetID widget) const override
	Draw the contents of a nested widget.

void	OnResize () override
	Called after the window got resized.

void	OnInvalidateData (int data=0, bool gui_scope=true) override
	Some data on this window has become invalid.

void	OnDropdownSelect (WidgetID widget, int index) override
	A dropdown option associated to this window has been selected.

void	Reset () override
	Reset the search, i.e.

FontSize	DefaultSize () override
	Get the default (font) size of the string.

std::optional< std::string_view >	NextString () override
	Get the next string to search through.

bool	Monospace () override
	Whether to search for a monospace font or not.

void	SetFontNames (FontCacheSettings settings, const char font_name, const void *os_data) override
	Set the right font names.

void	ScrollToLine (size_t line)

virtual void	LoadTextfile (const std::string &textfile, Subdirectory dir)
	Loads the textfile text from file and setup lines.

Public Member Functions inherited from Window
	Window (WindowDesc &desc)
	Empty constructor, initialization has been moved to InitNested() called from the constructor of the derived class.

void *	operator new[] (size_t size)=delete
	Helper allocation function to disallow something.

template<class NWID >
const NWID *	GetWidget (WidgetID widnum) const
	Get the nested widget with number widnum from the nested widget tree.

template<class NWID >
NWID *	GetWidget (WidgetID widnum)
	Get the nested widget with number widnum from the nested widget tree.

const Scrollbar *	GetScrollbar (WidgetID widnum) const
	Return the Scrollbar to a widget index.

Scrollbar *	GetScrollbar (WidgetID widnum)
	Return the Scrollbar to a widget index.

const QueryString *	GetQueryString (WidgetID widnum) const
	Return the querystring associated to a editbox.

QueryString *	GetQueryString (WidgetID widnum)
	Return the querystring associated to a editbox.

void	UpdateQueryStringSize ()
	Update size of all QueryStrings of this window.

virtual const struct Textbuf *	GetFocusedTextbuf () const
	Get the current input text buffer.

virtual Point	GetCaretPosition () const
	Get the current caret position if an edit box has the focus.

virtual Rect	GetTextBoundingRect (const char from, const char to) const
	Get the bounding rectangle for a text range if an edit box has the focus.

virtual ptrdiff_t	GetTextCharacterAtPosition (const Point &pt) const
	Get the character that is rendered at a position by the focused edit box.

void	InitNested (WindowNumber number=0)
	Perform complete initialization of the Window with nested widgets, to allow use.

void	CreateNestedTree ()
	Perform the first part of the initialization of a nested widget tree.

void	FinishInitNested (WindowNumber window_number=0)
	Perform the second part of the initialization of a nested widget tree.

template<typename T , std::enable_if_t< std::is_base_of< StrongTypedefBase, T >::value, int > = 0>
void	FinishInitNested (T number)

void	SetTimeout ()
	Set the timeout flag of the window and initiate the timer.

void	SetWhiteBorder ()
	Set the timeout flag of the window and initiate the timer.

void	DisableAllWidgetHighlight ()
	Disable the highlighted status of all widgets.

void	SetWidgetHighlight (WidgetID widget_index, TextColour highlighted_colour)
	Sets the highlighted status of a widget.

bool	IsWidgetHighlighted (WidgetID widget_index) const
	Gets the highlighted status of a widget.

void	SetWidgetDisabledState (WidgetID widget_index, bool disab_stat)
	Sets the enabled/disabled status of a widget.

void	DisableWidget (WidgetID widget_index)
	Sets a widget to disabled.

void	EnableWidget (WidgetID widget_index)
	Sets a widget to Enabled.

bool	IsWidgetDisabled (WidgetID widget_index) const
	Gets the enabled/disabled status of a widget.

bool	IsWidgetFocused (WidgetID widget_index) const
	Check if given widget is focused within this window.

bool	IsWidgetGloballyFocused (WidgetID widget_index) const
	Check if given widget has user input focus.

void	SetWidgetLoweredState (WidgetID widget_index, bool lowered_stat)
	Sets the lowered/raised status of a widget.

void	ToggleWidgetLoweredState (WidgetID widget_index)
	Invert the lowered/raised status of a widget.

void	LowerWidget (WidgetID widget_index)
	Marks a widget as lowered.

void	RaiseWidget (WidgetID widget_index)
	Marks a widget as raised.

void	RaiseWidgetWhenLowered (WidgetID widget_index)
	Marks a widget as raised and dirty (redraw), when it is marked as lowered.

bool	IsWidgetLowered (WidgetID widget_index) const
	Gets the lowered state of a widget.

void	UnfocusFocusedWidget ()
	Makes no widget on this window have focus.

bool	SetFocusedWidget (WidgetID widget_index)
	Set focus within this window to the given widget.

EventState	HandleEditBoxKey (WidgetID wid, char32_t key, uint16_t keycode)
	Process keypress for editbox widget.

virtual void	InsertTextString (WidgetID wid, const char str, bool marked, const char caret, const char insert_location, const char replacement_end)
	Insert a text string at the cursor position into the edit box widget.

void	HandleButtonClick (WidgetID widget)
	Do all things to make a button look clicked and mark it to be unclicked in a few ticks.

int	GetRowFromWidget (int clickpos, WidgetID widget, int padding, int line_height=-1) const
	Compute the row of a widget that a user clicked in.

void	RaiseButtons (bool autoraise=false)
	Raise the buttons of the window.

template<typename... Args>
void	SetWidgetsDisabledState (bool disab_stat, Args... widgets)
	Sets the enabled/disabled status of a list of widgets.

template<typename... Args>
void	SetWidgetsLoweredState (bool lowered_stat, Args... widgets)
	Sets the lowered/raised status of a list of widgets.

template<typename... Args>
void	RaiseWidgetsWhenLowered (Args... widgets)
	Raises the widgets and sets widgets dirty that are lowered.

void	SetWidgetDirty (WidgetID widget_index) const
	Invalidate a widget, i.e.

void	DrawWidgets () const
	Paint all widgets of a window.

void	DrawViewport () const
	Draw the viewport of this window.

void	DrawSortButtonState (WidgetID widget, SortButtonState state) const
	Draw a sort button's up or down arrow symbol.

Window *	FindChildWindow (WindowClass wc=WC_INVALID) const
	Find the Window whose parent pointer points to this window.

void	CloseChildWindows (WindowClass wc=WC_INVALID) const
	Close all children a window might have in a head-recursive manner.

virtual void	Close (int data=0)
	Hide the window and all its child windows, and mark them for a later deletion.

void	SetDirty () const
	Mark entire window as dirty (in need of re-paint)

void	ReInit (int rx=0, int ry=0, bool reposition=false)
	Re-initialize a window, and optionally change its size.

bool	IsShaded () const
	Is window shaded currently?

void	SetShaded (bool make_shaded)
	Set the shaded state of the window to make_shaded.

void	ScheduleResize ()
	Mark this window as resized and in need of OnResize() event.

void	ProcessScheduledResize ()
	Process scheduled OnResize() event.

void	InvalidateData (int data=0, bool gui_scope=true)
	Mark this window's data as invalid (in need of re-computing)

void	ProcessScheduledInvalidations ()
	Process all scheduled invalidations.

void	ProcessHighlightedInvalidations ()
	Process all invalidation of highlighted widgets.

virtual void	OnInit ()
	Notification that the nested widget tree gets initialized.

virtual void	ApplyDefaults ()
	Read default values from WindowDesc configuration an apply them to the window.

virtual Point	OnInitialPosition (int16_t sm_width, int16_t sm_height, int window_number)
	Compute the initial position of the window.

virtual void	OnPaint ()
	The window must be repainted.

virtual void	SetStringParameters (WidgetID widget) const
	Initialize string parameters for a widget.

virtual void	OnFocus ()
	The window has gained focus.

virtual void	OnFocusLost (bool closing)
	The window has lost focus.

virtual EventState	OnKeyPress (char32_t key, uint16_t keycode)
	A key has been pressed.

virtual EventState	OnHotkey (int hotkey)
	A hotkey has been pressed.

virtual EventState	OnCTRLStateChange ()
	The state of the control key has changed.

virtual bool	OnRightClick (Point pt, WidgetID widget)
	A click with the right mouse button has been made on the window.

virtual void	OnHover (Point pt, WidgetID widget)
	The mouse is hovering over a widget in the window, perform an action for it.

virtual bool	OnTooltip (Point pt, WidgetID widget, TooltipCloseCondition close_cond)
	Event to display a custom tooltip.

virtual void	OnMouseDrag (Point pt, WidgetID widget)
	An 'object' is being dragged at the provided position, highlight the target if possible.

virtual void	OnDragDrop (Point pt, WidgetID widget)
	A dragged 'object' has been released.

virtual void	OnScroll (Point delta)
	Handle the request for (viewport) scrolling.

virtual void	OnMouseOver (Point pt, WidgetID widget)
	The mouse is currently moving over the window or has just moved outside of the window.

virtual void	OnMouseWheel (int wheel)
	The mouse wheel has been turned.

virtual void	OnMouseLoop ()
	Called for every mouse loop run, which is at least once per (game) tick.

virtual void	OnGameTick ()
	Called once per (game) tick.

virtual void	OnRealtimeTick (uint delta_ms)
	Called periodically.

virtual void	OnTimeout ()
	Called when this window's timeout has been reached.

virtual void	OnDropdownClose (Point pt, WidgetID widget, int index, bool instant_close)
	A dropdown window associated to this window has been closed.

virtual void	OnEditboxChanged (WidgetID widget)
	The text in an editbox has been edited.

virtual void	OnQueryTextFinished (std::optional< std::string > str)
	The query window opened from this window has closed.

virtual void	OnPlaceObject (Point pt, TileIndex tile)
	The user clicked some place on the map when a tile highlight mode has been set.

virtual bool	OnVehicleSelect (const struct Vehicle *v)
	The user clicked on a vehicle while HT_VEHICLE has been set.

virtual bool	OnVehicleSelect (VehicleList::const_iterator begin, VehicleList::const_iterator end)
	The user clicked on a vehicle while HT_VEHICLE has been set.

virtual void	OnPlaceObjectAbort ()
	The user cancelled a tile highlight mode that has been set.

virtual void	OnPlaceDrag (ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt)
	The user is dragging over the map when the tile highlight mode has been set.

virtual void	OnPlaceMouseUp (ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt, TileIndex start_tile, TileIndex end_tile)
	The user has dragged over the map when the tile highlight mode has been set.

virtual void	OnPlacePresize (Point pt, TileIndex tile)
	The user moves over the map when a tile highlight mode has been set when the special mouse mode has been set to 'PRESIZE' mode.

virtual bool	IsNewGRFInspectable () const
	Is the data related to this window NewGRF inspectable?

virtual void	ShowNewGRFInspectWindow () const
	Show the NewGRF inspection window.

template<>
const NWidgetBase *	GetWidget (WidgetID widnum) const
	Specialized case of Window::GetWidget for the nested widget base class.

Public Member Functions inherited from ZeroedMemoryAllocator
void *	operator new (size_t size)
	Memory allocator for a single class instance.

void *	operator new[] (size_t size)
	Memory allocator for an array of class instances.

void	operator delete (void *ptr)
	Memory release for a single class instance.

void	operator delete[] (void *ptr)
	Memory release for an array of class instances.

Public Member Functions inherited from MissingGlyphSearcher
virtual	~MissingGlyphSearcher ()=default
	Make sure everything gets destructed right.

bool	FindMissingGlyphs ()
	Check whether there are glyphs missing in the current language.

Data Fields
TextfileType	file_type
	Type of textfile to view.

Scrollbar *	vscroll
	Vertical scrollbar.

Scrollbar *	hscroll
	Horizontal scrollbar.

Data Fields inherited from Window
WindowDesc &	window_desc
	Window description.

WindowFlags	flags
	Window flags.

WindowClass	window_class
	Window class.

WindowNumber	window_number
	Window number within the window class.

int	scale
	Scale of this window – used to determine how to resize.

uint8_t	timeout_timer
	Timer value of the WF_TIMEOUT for flags.

uint8_t	white_border_timer
	Timer value of the WF_WHITE_BORDER for flags.

int	left
	x position of left edge of the window

int	top
	y position of top edge of the window

int	width
	width of the window (number of pixels to the right in x direction)

int	height
	Height of the window (number of pixels down in y direction)

ResizeInfo	resize
	Resize information.

Owner	owner
	The owner of the content shown in this window. Company colour is acquired from this variable.

ViewportData *	viewport
	Pointer to viewport data, if present.

const NWidgetCore *	nested_focus
	Currently focused nested widget, or `nullptr` if no nested widget has focus.

std::map< WidgetID, QueryString * >	querystrings
	QueryString associated to WWT_EDITBOX widgets.

std::unique_ptr< NWidgetBase >	nested_root
	Root of the nested tree.

WidgetLookup	widget_lookup
	Indexed access to the nested widget tree. Do not access directly, use Window::GetWidget() instead.

NWidgetStacked *	shade_select
	Selection widget (NWID_SELECTION) to use for shading the window. If `nullptr`, window cannot shade.

Dimension	unshaded_size
	Last known unshaded size (only valid while shaded).

WidgetID	mouse_capture_widget
	ID of current mouse capture widget (e.g. dragged scrollbar). -1 if no widget has mouse capture.

Window *	parent
	Parent window.

WindowList::iterator	z_position

Protected Member Functions
	TextfileWindow (TextfileType file_type)

void	ConstructWindow ()

void	LoadText (std::string_view buf)
	Load a text into the textfile viewer.

void	FindHyperlinksInMarkdown (Line &line, size_t line_index)
	Find any hyperlinks in a given line.

virtual void	OnHyperlinkClick (const Hyperlink &link)
	Handle the clicking on a hyperlink.

virtual void	AfterLoadText ()
	Post-processing after the text is loaded.

void	NavigateToFile (std::string newfile, size_t line)
	Navigate to the requested file.

void	AppendHistory (const std::string &filepath)
	Append the new location to the history, so the user can go back.

void	UpdateHistoryScrollpos ()
	Update the scroll position to the current, so we can restore there if we go back.

void	NavigateHistory (int delta)
	Navigate through the history, either forward or backward.

Protected Member Functions inherited from Window
void	InitializeData (WindowNumber window_number)
	Initializes the data (except the position and initial size) of a new Window.

void	InitializePositionSize (int x, int y, int min_width, int min_height)
	Set the position and smallest size of the window.

virtual void	FindWindowPlacementAndResize (int def_width, int def_height)
	Resize window towards the default size.

virtual	~Window ()
	Remove window and all its child windows from the window stack.

Protected Attributes
std::string	filename {}
	Filename of the textfile.

std::string	filepath {}
	Full path to the filename.

std::vector< Line >	lines
	#text, split into lines in a table with lines.

std::vector< size_t >	jumplist
	Table of contents list, line numbers.

std::vector< Hyperlink >	links
	Clickable links in lines.

std::vector< Hyperlink >	link_anchors
	Anchor names of headings that can be linked to.

std::vector< HistoryEntry >	history
	Browsing history in this window.

size_t	history_pos = 0
	Position in browsing history (for forward movement).

bool	trusted = false
	Whether the content is trusted (read: not from content like NewGRFs, etc).

Protected Attributes inherited from Window
std::vector< int >	scheduled_invalidation_data
	Data of scheduled OnInvalidateData() calls.

bool	scheduled_resize
	Set if window has been resized.

Private Member Functions
uint	ReflowContent ()
	Get the total height of the content displayed in this window, if wrapping is disabled.

uint	GetContentHeight ()

void	SetupScrollbars (bool force_reflow)
	Set scrollbars to the right lengths.

void	CheckHyperlinkClick (Point pt)
	Check if the user clicked on a hyperlink, and handle it if so.

void	AfterLoadMarkdown ()
	Post-processing of markdown files.

Private Attributes
uint	search_iterator = 0
	Iterator for the font check search.

uint	max_length = 0
	Maximum length of unwrapped text line.

Additional Inherited Members
Public Types inherited from Window
using	IteratorToFront = WindowIterator< false >
	Iterate in Z order towards front.

using	IteratorToBack = WindowIterator< true >
	Iterate in Z order towards back.

using	Iterate = AllWindows< false >
	Iterate all windows in whatever order is easiest.

using	IterateFromBack = AllWindows< false >
	Iterate all windows in Z order from back to front.

using	IterateFromFront = AllWindows< true >
	Iterate all windows in Z order from front to back.

Static Public Member Functions inherited from Window
static int	SortButtonWidth ()
	Get width of up/down arrow of sort button state.

static void	DeleteClosedWindows ()
	Delete all closed windows.

Detailed Description

Window for displaying a textfile.

Definition at line 21 of file textfile_gui.h.

Constructor & Destructor Documentation

◆ TextfileWindow()

TextfileWindow::TextfileWindow ( TextfileType file_type )

protected

Definition at line 85 of file textfile_gui.cpp.

Member Function Documentation

◆ AfterLoadMarkdown()

void TextfileWindow::AfterLoadMarkdown ( )

private

Post-processing of markdown files.

Definition at line 509 of file textfile_gui.cpp.

References FindHyperlinksInMarkdown(), Window::GetWidget(), jumplist, lines, link_anchors, MakeAnchorSlug(), and TextfileWindow::Line::text.

Referenced by AfterLoadText().

◆ AfterLoadText()

void TextfileWindow::AfterLoadText ( )

protectedvirtual

Post-processing after the text is loaded.

Reimplemented in GameManualTextfileWindow.

Definition at line 497 of file textfile_gui.cpp.

References AfterLoadMarkdown(), filename, Window::GetWidget(), jumplist, link_anchors, Window::ReInit(), StrEndsWithIgnoreCase(), SZSP_HORIZONTAL, and WID_TF_SEL_JUMPLIST.

Referenced by GameManualTextfileWindow::AfterLoadText(), and LoadText().

◆ AppendHistory()

void TextfileWindow::AppendHistory ( const std::string & filepath )

protected

Append the new location to the history, so the user can go back.

Parameters

filepath The location the user is navigating to.

Definition at line 356 of file textfile_gui.cpp.

References Window::DisableWidget(), Window::EnableWidget(), filepath, Window::GetWidget(), history, history_pos, UpdateHistoryScrollpos(), WID_TF_NAVBACK, and WID_TF_NAVFORWARD.

Referenced by NavigateToFile(), and OnHyperlinkClick().

◆ CheckHyperlinkClick()

void TextfileWindow::CheckHyperlinkClick ( Point pt )

private

Check if the user clicked on a hyperlink, and handle it if so.

Parameters

pt	The loation the user clicked.

Definition at line 306 of file textfile_gui.cpp.

References TextfileWindow::Line::bottom, Debug, WidgetDimensions::frametext, FS_MONO, GetCharacterHeight(), Layouter::GetCharAtPosition(), Scrollbar::GetPosition(), Window::GetRowFromWidget(), Window::GetScrollbar(), Window::GetWidget(), RectPadding::Horizontal(), Window::IsWidgetLowered(), lines, links, OnHyperlinkClick(), WidgetDimensions::scaled, TextfileWindow::Line::top, WID_TF_BACKGROUND, WID_TF_VSCROLLBAR, and WID_TF_WRAPTEXT.

Referenced by OnClick().

◆ ConstructWindow()

void TextfileWindow::ConstructWindow ( )

protected

Definition at line 91 of file textfile_gui.cpp.

◆ DefaultSize()

FontSize TextfileWindow::DefaultSize ( )

overridevirtual

Get the default (font) size of the string.

Returns: The font size.

Implements MissingGlyphSearcher.

Definition at line 630 of file textfile_gui.cpp.

References FS_MONO.

◆ DrawWidget()

void TextfileWindow::DrawWidget	(	const Rect &	r,
		WidgetID	widget
	)		const

overridevirtual

Draw the contents of a nested widget.

Parameters

r	Rectangle occupied by the widget.
widget	Number of the widget to draw.

Note: This method may not change any state, it may only use drawing functions.

Reimplemented from Window.

Definition at line 558 of file textfile_gui.cpp.

References DrawString(), DrawStringMultiLine(), FillDrawPixelInfo(), FS_MONO, Scrollbar::GetCapacity(), GetCharacterHeight(), Scrollbar::GetPosition(), Window::GetWidget(), hscroll, Window::IsWidgetLowered(), lines, SA_LEFT, SA_TOP, WidgetDimensions::scaled, ScrollRect(), Rect::Shrink(), vscroll, WID_TF_BACKGROUND, and WID_TF_WRAPTEXT.

◆ FindHyperlinksInMarkdown()

void TextfileWindow::FindHyperlinksInMarkdown	(	Line &	line,
		size_t	line_index
	)

protected

Find any hyperlinks in a given line.

Parameters

line	The line to search for hyperlinks.
line_index	The index of the line.

Definition at line 244 of file textfile_gui.cpp.

References _markdown_link_regex, ClassifyHyperlink(), TextfileWindow::Hyperlink::destination, File, Window::GetWidget(), Internal, TextfileWindow::Hyperlink::line, links, TextfileWindow::Line::text, Utf8Encode(), and Web.

Referenced by AfterLoadMarkdown().

◆ GetContentHeight()

uint TextfileWindow::GetContentHeight ( )

private

Definition at line 130 of file textfile_gui.cpp.

◆ LoadText()

void TextfileWindow::LoadText ( std::string_view buf )

protected

Load a text into the textfile viewer.

This will split the text into newlines and stores it for fast drawing.

Parameters

buf	The text to load.

Definition at line 793 of file textfile_gui.cpp.

References AfterLoadText(), CheckForMissingGlyphs(), FS_MONO, GetStringBoundingBox(), Window::GetWidget(), lines, max_length, Window::ReInit(), StrMakeValid(), SVS_ALLOW_NEWLINE, SVS_REPLACE_TAB_CR_NL_WITH_SPACE, and SVS_REPLACE_WITH_QUESTION_MARK.

Referenced by LoadTextfile().

◆ LoadTextfile()

void TextfileWindow::LoadTextfile	(	const std::string &	textfile,
		Subdirectory	dir
	)

virtual

Loads the textfile text from file and setup lines.

Definition at line 737 of file textfile_gui.cpp.

References filename, filepath, FioFOpenFile(), Window::GetWidget(), Gunzip(), history, jumplist, lines, LoadText(), Window::ReInit(), SZSP_HORIZONTAL, WID_TF_SEL_JUMPLIST, and Xunzip().

Referenced by NavigateHistory(), NavigateToFile(), and ScriptTextfileWindow::OnInvalidateData().

◆ Monospace()

bool TextfileWindow::Monospace ( )

overridevirtual

Whether to search for a monospace font or not.

Returns: True if searching for monospace.

Implements MissingGlyphSearcher.

Definition at line 642 of file textfile_gui.cpp.

◆ NavigateHistory()

void TextfileWindow::NavigateHistory ( int delta )

protected

Navigate through the history, either forward or backward.

Parameters

delta The direction to navigate.

Definition at line 379 of file textfile_gui.cpp.

References filename, filepath, Window::GetScrollbar(), history, history_pos, LoadTextfile(), NO_DIRECTORY, Window::SetDirty(), Scrollbar::SetPosition(), Window::SetWidgetDisabledState(), UpdateHistoryScrollpos(), WID_TF_HSCROLLBAR, WID_TF_NAVBACK, WID_TF_NAVFORWARD, and WID_TF_VSCROLLBAR.

Referenced by OnClick().

◆ NavigateToFile()

void TextfileWindow::NavigateToFile	(	std::string	newfile,
		size_t	line
	)

protected

Navigate to the requested file.

Parameters

newfile	The file to navigate to.
line	The line to scroll to.

Definition at line 435 of file textfile_gui.cpp.

References AppendHistory(), TextfileWindow::Hyperlink::destination, filename, filepath, FioCheckFileExists(), Window::GetScrollbar(), Window::GetWidget(), link_anchors, LoadTextfile(), NO_DIRECTORY, Scrollbar::SetPosition(), StrEndsWithIgnoreCase(), UpdateHistoryScrollpos(), WID_TF_HSCROLLBAR, and WID_TF_VSCROLLBAR.

Referenced by OnHyperlinkClick().

◆ NextString()

std::optional< std::string_view > TextfileWindow::NextString ( )

overridevirtual

Get the next string to search through.

Returns: The next string or nullopt if there is none.

Implements MissingGlyphSearcher.

Definition at line 635 of file textfile_gui.cpp.

References lines, and search_iterator.

◆ OnClick()

void TextfileWindow::OnClick	(	Point	pt,
		WidgetID	widget,
		int	click_count
	)

overridevirtual

A click with the left mouse button has been made on the window.

Parameters

pt	the point inside the window that has been clicked.
widget	the clicked widget.
click_count	Number of fast consecutive clicks at same position

Reimplemented from Window.

Definition at line 526 of file textfile_gui.cpp.

References CheckHyperlinkClick(), Window::GetWidget(), Window::InvalidateData(), jumplist, lines, NavigateHistory(), SetDParamStr(), ShowDropDownList(), Window::ToggleWidgetLoweredState(), WID_TF_BACKGROUND, WID_TF_JUMPLIST, WID_TF_NAVBACK, WID_TF_NAVFORWARD, and WID_TF_WRAPTEXT.

◆ OnDropdownSelect()

void TextfileWindow::OnDropdownSelect	(	WidgetID	widget,
		int	index
	)

overridevirtual

A dropdown option associated to this window has been selected.

Parameters

widget	the widget (button) that the dropdown is associated with.
index	the element in the dropdown that is selected.

Reimplemented from Window.

Definition at line 605 of file textfile_gui.cpp.

References WID_TF_JUMPLIST.

◆ OnHyperlinkClick()

void TextfileWindow::OnHyperlinkClick ( const Hyperlink & link )

protectedvirtual

Handle the clicking on a hyperlink.

Parameters

link	The link that is clicked on.

Definition at line 401 of file textfile_gui.cpp.

References AppendHistory(), ClassifyHyperlink(), TextfileWindow::Hyperlink::destination, File, filepath, Window::GetWidget(), Internal, link_anchors, NavigateToFile(), UpdateHistoryScrollpos(), and Web.

Referenced by CheckHyperlinkClick().

◆ OnInvalidateData()

void TextfileWindow::OnInvalidateData	(	int	data = `0`,
		bool	gui_scope = `true`
	)

overridevirtual

Some data on this window has become invalid.

Parameters

data	information about the changed data.
gui_scope	Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See InvalidateWindowData() for details.

Reimplemented from Window.

Definition at line 598 of file textfile_gui.cpp.

References Window::GetWidget(), and SetupScrollbars().

◆ OnResize()

void TextfileWindow::OnResize ( )

overridevirtual

Called after the window got resized.

For nested windows with a viewport, call NWidgetViewport::UpdateViewportCoordinates.

Reimplemented from Window.

Definition at line 590 of file textfile_gui.cpp.

References hscroll, WidgetDimensions::scaled, Scrollbar::SetCapacityFromWidget(), SetupScrollbars(), vscroll, and WID_TF_BACKGROUND.

◆ ReflowContent()

uint TextfileWindow::ReflowContent ( )

private

Get the total height of the content displayed in this window, if wrapping is disabled.

Returns: the height in pixels

Definition at line 109 of file textfile_gui.cpp.

References WidgetDimensions::frametext, FS_MONO, GetCharacterHeight(), GetStringHeight(), Window::GetWidget(), Window::height, RectPadding::Horizontal(), Window::IsWidgetLowered(), lines, WidgetDimensions::scaled, WID_TF_BACKGROUND, and WID_TF_WRAPTEXT.

Referenced by SetupScrollbars().

◆ Reset()

void TextfileWindow::Reset ( )

overridevirtual

Reset the search, i.e.

begin from the beginning again.

Implements MissingGlyphSearcher.

Definition at line 625 of file textfile_gui.cpp.

References search_iterator.

◆ ScrollToLine()

void TextfileWindow::ScrollToLine ( size_t line )

Definition at line 612 of file textfile_gui.cpp.

◆ SetFontNames()

void TextfileWindow::SetFontNames	(	FontCacheSettings *	settings,
		const char *	font_name,
		const void *	os_data
	)

overridevirtual

Set the right font names.

Parameters

settings	The settings to modify.
font_name	The new font name.
os_data	Opaque pointer to OS-specific data.

Implements MissingGlyphSearcher.

Definition at line 647 of file textfile_gui.cpp.

References Window::GetWidget(), and settings.

◆ SetupScrollbars()

void TextfileWindow::SetupScrollbars ( bool force_reflow )

private

Set scrollbars to the right lengths.

Definition at line 149 of file textfile_gui.cpp.

References Window::GetWidget(), Window::height, hscroll, Window::IsWidgetLowered(), max_length, ReflowContent(), Scrollbar::SetCount(), Window::SetWidgetDisabledState(), vscroll, WID_TF_HSCROLLBAR, and WID_TF_WRAPTEXT.

Referenced by OnInvalidateData(), and OnResize().

◆ UpdateHistoryScrollpos()

void TextfileWindow::UpdateHistoryScrollpos ( )

protected

Update the scroll position to the current, so we can restore there if we go back.

Definition at line 369 of file textfile_gui.cpp.

References Scrollbar::GetPosition(), Window::GetScrollbar(), history, history_pos, and WID_TF_VSCROLLBAR.

Referenced by AppendHistory(), NavigateHistory(), NavigateToFile(), and OnHyperlinkClick().

◆ UpdateWidgetSize()

void TextfileWindow::UpdateWidgetSize	(	WidgetID	widget,
		Dimension &	size,
		const Dimension &	padding,
		Dimension &	fill,
		Dimension &	resize
	)

overridevirtual

Update size and resize step of a widget in the window.

After retrieval of the minimal size and the resize-steps of a widget, this function is called to allow further refinement, typically by computing the real maximal size of the content. Afterwards, size is taken to be the minimal size of the widget and resize is taken to contain the resize steps. For the convenience of the callee, padding contains the amount of padding between the content and the edge of the widget. This should be added to the returned size.

Parameters

	widget	Widget number.
[in,out]	size	Size of the widget.
	padding	Recommended amount of space between the widget content and the widget edge.
[in,out]	fill	Fill step of the widget.
[in,out]	resize	Resize step of the widget.

Reimplemented from Window.

Definition at line 136 of file textfile_gui.cpp.

References WidgetDimensions::frametext, FS_MONO, GetCharacterHeight(), Window::resize, WidgetDimensions::scaled, RectPadding::Vertical(), and WID_TF_BACKGROUND.

Field Documentation

◆ file_type

TextfileType TextfileWindow::file_type

Type of textfile to view.

Definition at line 22 of file textfile_gui.h.

Referenced by ScriptTextfileWindow::OnInvalidateData().

◆ filename

std::string TextfileWindow::filename {}

protected

Filename of the textfile.

Definition at line 68 of file textfile_gui.h.

Referenced by AfterLoadText(), LoadTextfile(), NavigateHistory(), and NavigateToFile().

◆ filepath

std::string TextfileWindow::filepath {}

protected

Full path to the filename.

Definition at line 69 of file textfile_gui.h.

Referenced by AppendHistory(), LoadTextfile(), NavigateHistory(), NavigateToFile(), and OnHyperlinkClick().

◆ history

std::vector<HistoryEntry> TextfileWindow::history

protected

Browsing history in this window.

Definition at line 75 of file textfile_gui.h.

Referenced by AppendHistory(), LoadTextfile(), NavigateHistory(), and UpdateHistoryScrollpos().

◆ history_pos

size_t TextfileWindow::history_pos = 0

protected

Position in browsing history (for forward movement).

Definition at line 76 of file textfile_gui.h.

Referenced by AppendHistory(), NavigateHistory(), and UpdateHistoryScrollpos().

◆ hscroll

Scrollbar* TextfileWindow::hscroll

Horizontal scrollbar.

Definition at line 24 of file textfile_gui.h.

Referenced by DrawWidget(), OnResize(), and SetupScrollbars().

◆ jumplist

std::vector<size_t> TextfileWindow::jumplist

protected

Table of contents list, line numbers.

Definition at line 72 of file textfile_gui.h.

Referenced by AfterLoadMarkdown(), AfterLoadText(), LoadTextfile(), and OnClick().

◆ lines

std::vector<Line> TextfileWindow::lines

protected

#text, split into lines in a table with lines.

Definition at line 71 of file textfile_gui.h.

Referenced by GameManualTextfileWindow::AfterLoadChangelog(), AfterLoadMarkdown(), CheckHyperlinkClick(), DrawWidget(), LoadText(), LoadTextfile(), NextString(), OnClick(), and ReflowContent().

◆ link_anchors

std::vector<Hyperlink> TextfileWindow::link_anchors

protected

Anchor names of headings that can be linked to.

Definition at line 74 of file textfile_gui.h.

Referenced by AfterLoadMarkdown(), AfterLoadText(), GameManualTextfileWindow::AfterLoadText(), NavigateToFile(), and OnHyperlinkClick().

◆ links

std::vector<Hyperlink> TextfileWindow::links

protected

Clickable links in lines.

Definition at line 73 of file textfile_gui.h.

Referenced by CheckHyperlinkClick(), and FindHyperlinksInMarkdown().

◆ max_length

uint TextfileWindow::max_length = 0

private

Maximum length of unwrapped text line.

Definition at line 101 of file textfile_gui.h.

Referenced by LoadText(), and SetupScrollbars().

◆ search_iterator

uint TextfileWindow::search_iterator = 0

private

Iterator for the font check search.

Definition at line 100 of file textfile_gui.h.

Referenced by NextString(), and Reset().

◆ trusted

bool TextfileWindow::trusted = false

protected

Whether the content is trusted (read: not from content like NewGRFs, etc).

Definition at line 77 of file textfile_gui.h.

◆ vscroll

Scrollbar* TextfileWindow::vscroll

Vertical scrollbar.

Definition at line 23 of file textfile_gui.h.

Referenced by DrawWidget(), OnResize(), and SetupScrollbars().

The documentation for this struct was generated from the following files:

src/textfile_gui.h
src/textfile_gui.cpp

Data Structures

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TextfileWindow()

Member Function Documentation

◆ AfterLoadMarkdown()

◆ AfterLoadText()

◆ AppendHistory()

◆ CheckHyperlinkClick()

◆ ConstructWindow()

◆ DefaultSize()

◆ DrawWidget()

◆ FindHyperlinksInMarkdown()

◆ GetContentHeight()

◆ LoadText()

◆ LoadTextfile()

◆ Monospace()

◆ NavigateHistory()

◆ NavigateToFile()

◆ NextString()

◆ OnClick()

◆ OnDropdownSelect()

◆ OnHyperlinkClick()

◆ OnInvalidateData()

◆ OnResize()

◆ ReflowContent()

◆ Reset()

◆ ScrollToLine()

◆ SetFontNames()

◆ SetupScrollbars()

◆ UpdateHistoryScrollpos()

◆ UpdateWidgetSize()

Field Documentation

◆ file_type

◆ filename

◆ filepath

◆ history

◆ history_pos

◆ hscroll

◆ jumplist

◆ lines

◆ link_anchors

◆ links

◆ max_length

◆ search_iterator

◆ trusted

◆ vscroll