OpenTTD Source  20241120-master-g6d3adc6169
StoryBookWindow Struct Reference
Inheritance diagram for StoryBookWindow:
Window ZeroedMemoryAllocator

Data Structures

struct  LayoutCacheElement
 

Public Member Functions

 StoryBookWindow (WindowDesc &desc, WindowNumber window_number)
 
void UpdatePrevNextDisabledState ()
 Updates the disabled state of the prev/next buttons.
 
void SetSelectedPage (uint16_t page_index)
 Sets the selected page. More...
 
void SetStringParameters (WidgetID widget) const override
 
void OnPaint () override
 The window must be repainted. More...
 
void DrawWidget (const Rect &r, WidgetID widget) const override
 
void UpdateWidgetSize (WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
 
void OnResize () override
 Called after the window got resized. More...
 
void OnClick ([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
 
void OnDropdownSelect (WidgetID widget, int index) override
 
void OnInvalidateData ([[maybe_unused]] int data=0, [[maybe_unused]] bool gui_scope=true) override
 Some data on this window has become invalid. More...
 
void OnTimeout () override
 Called when this window's timeout has been reached.
 
void OnPlaceObject ([[maybe_unused]] Point pt, TileIndex tile) override
 
bool OnVehicleSelect (const Vehicle *v) override
 
void OnPlaceObjectAbort () override
 The user cancelled a tile highlight mode that has been set.
 
- 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. More...
 
void * operator new[] (size_t size)=delete
 Helper allocation function to disallow something. More...
 
template<class NWID >
const NWID * GetWidget (WidgetID widnum) const
 Get the nested widget with number widnum from the nested widget tree. More...
 
template<class NWID >
NWID * GetWidget (WidgetID widnum)
 Get the nested widget with number widnum from the nested widget tree. More...
 
const ScrollbarGetScrollbar (WidgetID widnum) const
 Return the Scrollbar to a widget index. More...
 
ScrollbarGetScrollbar (WidgetID widnum)
 Return the Scrollbar to a widget index. More...
 
const QueryStringGetQueryString (WidgetID widnum) const
 Return the querystring associated to a editbox. More...
 
QueryStringGetQueryString (WidgetID widnum)
 Return the querystring associated to a editbox. More...
 
void UpdateQueryStringSize ()
 Update size of all QueryStrings of this window.
 
virtual const struct TextbufGetFocusedTextbuf () const
 Get the current input text buffer. More...
 
virtual Point GetCaretPosition () const
 Get the current caret position if an edit box has the focus. More...
 
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. More...
 
virtual ptrdiff_t GetTextCharacterAtPosition (const Point &pt) const
 Get the character that is rendered at a position by the focused edit box. More...
 
void InitNested (WindowNumber number=0)
 Perform complete initialization of the Window with nested widgets, to allow use. More...
 
void CreateNestedTree ()
 Perform the first part of the initialization of a nested widget tree. More...
 
void FinishInitNested (WindowNumber window_number=0)
 Perform the second part of the initialization of a nested widget tree. More...
 
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. More...
 
bool IsWidgetHighlighted (WidgetID widget_index) const
 Gets the highlighted status of a widget. More...
 
void SetWidgetDisabledState (WidgetID widget_index, bool disab_stat)
 Sets the enabled/disabled status of a widget. More...
 
void DisableWidget (WidgetID widget_index)
 Sets a widget to disabled. More...
 
void EnableWidget (WidgetID widget_index)
 Sets a widget to Enabled. More...
 
bool IsWidgetDisabled (WidgetID widget_index) const
 Gets the enabled/disabled status of a widget. More...
 
bool IsWidgetFocused (WidgetID widget_index) const
 Check if given widget is focused within this window. More...
 
bool IsWidgetGloballyFocused (WidgetID widget_index) const
 Check if given widget has user input focus. More...
 
void SetWidgetLoweredState (WidgetID widget_index, bool lowered_stat)
 Sets the lowered/raised status of a widget. More...
 
void ToggleWidgetLoweredState (WidgetID widget_index)
 Invert the lowered/raised status of a widget. More...
 
void LowerWidget (WidgetID widget_index)
 Marks a widget as lowered. More...
 
void RaiseWidget (WidgetID widget_index)
 Marks a widget as raised. More...
 
void RaiseWidgetWhenLowered (WidgetID widget_index)
 Marks a widget as raised and dirty (redraw), when it is marked as lowered. More...
 
bool IsWidgetLowered (WidgetID widget_index) const
 Gets the lowered state of a widget. More...
 
void UnfocusFocusedWidget ()
 Makes no widget on this window have focus. More...
 
bool SetFocusedWidget (WidgetID widget_index)
 Set focus within this window to the given widget. More...
 
EventState HandleEditBoxKey (WidgetID wid, char32_t key, uint16_t keycode)
 Process keypress for editbox widget. More...
 
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. More...
 
void HandleButtonClick (WidgetID widget)
 Do all things to make a button look clicked and mark it to be unclicked in a few ticks. More...
 
int GetRowFromWidget (int clickpos, WidgetID widget, int padding, int line_height=-1) const
 Compute the row of a widget that a user clicked in. More...
 
void RaiseButtons (bool autoraise=false)
 Raise the buttons of the window. More...
 
template<typename... Args>
void SetWidgetsDisabledState (bool disab_stat, Args... widgets)
 Sets the enabled/disabled status of a list of widgets. More...
 
template<typename... Args>
void SetWidgetsLoweredState (bool lowered_stat, Args... widgets)
 Sets the lowered/raised status of a list of widgets. More...
 
template<typename... Args>
void RaiseWidgetsWhenLowered (Args... widgets)
 Raises the widgets and sets widgets dirty that are lowered. More...
 
void SetWidgetDirty (WidgetID widget_index) const
 Invalidate a widget, i.e. More...
 
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. More...
 
WindowFindChildWindow (WindowClass wc=WC_INVALID) const
 Find the Window whose parent pointer points to this window. More...
 
void CloseChildWindows (WindowClass wc=WC_INVALID) const
 Close all children a window might have in a head-recursive manner. More...
 
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. More...
 
bool IsShaded () const
 Is window shaded currently?
 
void SetShaded (bool make_shaded)
 Set the shaded state of the window to make_shaded. More...
 
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) More...
 
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. More...
 
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. More...
 
virtual void DrawWidget ([[maybe_unused]] const Rect &r, [[maybe_unused]] WidgetID widget) const
 Draw the contents of a nested widget. More...
 
virtual void UpdateWidgetSize ([[maybe_unused]] WidgetID widget, [[maybe_unused]] Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize)
 Update size and resize step of a widget in the window. More...
 
virtual void SetStringParameters ([[maybe_unused]] WidgetID widget) const
 Initialize string parameters for a widget. More...
 
virtual void OnFocus ()
 The window has gained focus. More...
 
virtual void OnFocusLost (bool closing)
 The window has lost focus. More...
 
virtual EventState OnKeyPress ([[maybe_unused]] char32_t key, [[maybe_unused]] uint16_t keycode)
 A key has been pressed. More...
 
virtual EventState OnHotkey (int hotkey)
 A hotkey has been pressed. More...
 
virtual EventState OnCTRLStateChange ()
 The state of the control key has changed. More...
 
virtual void OnClick ([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget, [[maybe_unused]] int click_count)
 A click with the left mouse button has been made on the window. More...
 
virtual bool OnRightClick ([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget)
 A click with the right mouse button has been made on the window. More...
 
virtual void OnHover ([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget)
 The mouse is hovering over a widget in the window, perform an action for it. More...
 
virtual bool OnTooltip ([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget, [[maybe_unused]] TooltipCloseCondition close_cond)
 Event to display a custom tooltip. More...
 
virtual void OnMouseDrag ([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget)
 An 'object' is being dragged at the provided position, highlight the target if possible. More...
 
virtual void OnDragDrop ([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget)
 A dragged 'object' has been released. More...
 
virtual void OnScroll ([[maybe_unused]] Point delta)
 Handle the request for (viewport) scrolling. More...
 
virtual void OnMouseOver ([[maybe_unused]] Point pt, [[maybe_unused]] WidgetID widget)
 The mouse is currently moving over the window or has just moved outside of the window. More...
 
virtual void OnMouseWheel ([[maybe_unused]] int wheel)
 The mouse wheel has been turned. More...
 
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 ([[maybe_unused]] uint delta_ms)
 Called periodically.
 
virtual void OnDropdownSelect ([[maybe_unused]] WidgetID widget, [[maybe_unused]] int index)
 A dropdown option associated to this window has been selected. More...
 
virtual void OnDropdownClose (Point pt, WidgetID widget, int index, bool instant_close)
 A dropdown window associated to this window has been closed. More...
 
virtual void OnEditboxChanged ([[maybe_unused]] WidgetID widget)
 The text in an editbox has been edited. More...
 
virtual void OnQueryTextFinished ([[maybe_unused]] std::optional< std::string > str)
 The query window opened from this window has closed. More...
 
virtual void OnPlaceObject ([[maybe_unused]] Point pt, [[maybe_unused]] TileIndex tile)
 The user clicked some place on the map when a tile highlight mode has been set. More...
 
virtual bool OnVehicleSelect ([[maybe_unused]] const struct Vehicle *v)
 The user clicked on a vehicle while HT_VEHICLE has been set. More...
 
virtual bool OnVehicleSelect ([[maybe_unused]] VehicleList::const_iterator begin, [[maybe_unused]] VehicleList::const_iterator end)
 The user clicked on a vehicle while HT_VEHICLE has been set. More...
 
virtual void OnPlaceDrag ([[maybe_unused]] ViewportPlaceMethod select_method, [[maybe_unused]] ViewportDragDropSelectionProcess select_proc, [[maybe_unused]] Point pt)
 The user is dragging over the map when the tile highlight mode has been set. More...
 
virtual void OnPlaceMouseUp ([[maybe_unused]] ViewportPlaceMethod select_method, [[maybe_unused]] ViewportDragDropSelectionProcess select_proc, [[maybe_unused]] Point pt, [[maybe_unused]] TileIndex start_tile, [[maybe_unused]] TileIndex end_tile)
 The user has dragged over the map when the tile highlight mode has been set. More...
 
virtual void OnPlacePresize ([[maybe_unused]] Point pt, [[maybe_unused]] 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. More...
 
virtual bool IsNewGRFInspectable () const
 Is the data related to this window NewGRF inspectable? More...
 
virtual void ShowNewGRFInspectWindow () const
 Show the NewGRF inspection window. More...
 
template<>
const NWidgetBaseGetWidget (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. More...
 
void * operator new[] (size_t size)
 Memory allocator for an array of class instances. More...
 
void operator delete (void *ptr)
 Memory release for a single class instance. More...
 
void operator delete[] (void *ptr)
 Memory release for an array of class instances. More...
 

Protected Types

enum class  ElementFloat { None , Left , Right }
 
typedef std::vector< LayoutCacheElementLayoutCache
 

Protected Member Functions

void BuildStoryPageList ()
 (Re)Build story page list.
 
void BuildStoryPageElementList ()
 (Re)Build story page element list.
 
bool IsPageAvailable (const StoryPage *page) const
 
StoryPageGetSelPage () const
 Get instance of selected page. More...
 
int GetSelPageNum () const
 Get the page number of selected page. More...
 
bool IsFirstPageSelected ()
 Check if the selected page is also the first available page.
 
bool IsLastPageSelected ()
 Check if the selected page is also the last available page.
 
void RefreshSelectedPage ()
 Updates the content of selected page.
 
void SelectPrevPage ()
 Selects the previous available page before the currently selected page.
 
void SelectNextPage ()
 Selects the next available page after the currently selected page.
 
DropDownList BuildDropDownList () const
 Builds the page selector drop down list.
 
uint GetAvailablePageContentWidth () const
 Get the width available for displaying content on the page panel.
 
uint GetHeadHeight (int max_width) const
 Counts how many pixels of height that are used by Date and Title (excluding marginal after Title, as each body element has an empty row before the element). More...
 
SpriteID GetPageElementSprite (const StoryPageElement &pe) const
 Decides which sprite to display for a given page element. More...
 
uint GetPageElementHeight (const StoryPageElement &pe, int max_width) const
 Get the height in pixels used by a page element. More...
 
ElementFloat GetPageElementFloat (const StoryPageElement &pe) const
 Get the float style of a page element. More...
 
int GetPageElementFloatWidth (const StoryPageElement &pe) const
 Get the width a page element would use if it was floating left or right. More...
 
void InvalidateStoryPageElementLayout ()
 Invalidate the current page layout.
 
void EnsureStoryPageElementLayout () const
 Create the page layout if it is missing.
 
int32_t GetContentHeight ()
 Get the total height of the content displayed in this window. More...
 
void DrawActionElement (int &y_offset, int width, int line_height, SpriteID action_sprite, StringID string_id=STR_JUST_RAW_STRING) const
 Draws a page element that is composed of a sprite to the left and a single line of text after that. More...
 
void OnPageElementClick (const StoryPageElement &pe)
 Internal event handler for when a page element is clicked. More...
 
- Protected Member Functions inherited from Window
void InitializeData (WindowNumber window_number)
 Initializes the data (except the position and initial size) of a new Window. More...
 
void InitializePositionSize (int x, int y, int min_width, int min_height)
 Set the position and smallest size of the window. More...
 
virtual void FindWindowPlacementAndResize (int def_width, int def_height)
 Resize window towards the default size. More...
 
virtual ~Window ()
 Remove window and all its child windows from the window stack.
 

Static Protected Member Functions

static bool PageOrderSorter (const StoryPage *const &a, const StoryPage *const &b)
 Sort story pages by order value.
 
static bool PageElementOrderSorter (const StoryPageElement *const &a, const StoryPageElement *const &b)
 Sort story page elements by order value.
 

Protected Attributes

Scrollbarvscroll
 Scrollbar of the page text.
 
LayoutCache layout_cache
 Cached element layout.
 
GUIStoryPageList story_pages
 Sorted list of pages.
 
GUIStoryPageElementList story_page_elements
 Sorted list of page elements that belong to the current page.
 
StoryPageID selected_page_id
 Pool index of selected page.
 
std::string selected_generic_title
 If the selected page doesn't have a custom title, this buffer is used to store a generic page title.
 
StoryPageElementID active_button_id
 Which button element the player is currently using.
 
- 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.
 

Static Protected Attributes

static const std::initializer_list< GUIStoryPageList::SortFunction *const > page_sorter_funcs
 
static const std::initializer_list< GUIStoryPageElementList::SortFunction *const > page_element_sorter_funcs
 

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. More...
 
static void DeleteClosedWindows ()
 Delete all closed windows.
 
- Data Fields inherited from Window
WindowDescwindow_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.
 
ViewportDataviewport
 Pointer to viewport data, if present.
 
const NWidgetCorenested_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< NWidgetBasenested_root
 Root of the nested tree.
 
WidgetLookup widget_lookup
 Indexed access to the nested widget tree. Do not access directly, use Window::GetWidget() instead.
 
NWidgetStackedshade_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.
 
Windowparent
 Parent window.
 
WindowList::iterator z_position
 

Detailed Description

Definition at line 41 of file story_gui.cpp.

Member Function Documentation

◆ DrawActionElement()

void StoryBookWindow::DrawActionElement ( int &  y_offset,
int  width,
int  line_height,
SpriteID  action_sprite,
StringID  string_id = STR_JUST_RAW_STRING 
) const
inlineprotected

Draws a page element that is composed of a sprite to the left and a single line of text after that.

These page elements are generally clickable and are thus called action elements.

Parameters
y_offsetCurrent y_offset which will get updated when this method has completed its drawing.
widthWidth of the region available for drawing.
line_heightHeight of one line of text.
action_spriteThe sprite to draw.
string_idThe string id to draw.
Returns
the number of lines.

Definition at line 517 of file story_gui.cpp.

References DrawSprite(), and GetSpriteSize().

◆ GetContentHeight()

int32_t StoryBookWindow::GetContentHeight ( )
inlineprotected

Get the total height of the content displayed in this window.

Returns
the height in pixels

Definition at line 496 of file story_gui.cpp.

References EnsureStoryPageElementLayout().

Referenced by OnPaint(), OnResize(), and RefreshSelectedPage().

◆ GetHeadHeight()

uint StoryBookWindow::GetHeadHeight ( int  max_width) const
inlineprotected

Counts how many pixels of height that are used by Date and Title (excluding marginal after Title, as each body element has an empty row before the element).

Parameters
max_widthAvailable width to display content.
Returns
the height in pixels.

Definition at line 281 of file story_gui.cpp.

References FS_NORMAL, GetCharacterHeight(), GetSelPage(), GetStringHeight(), Window::height, SetDParamStr(), and StoryPage::title.

Referenced by EnsureStoryPageElementLayout().

◆ GetPageElementFloat()

ElementFloat StoryBookWindow::GetPageElementFloat ( const StoryPageElement pe) const
inlineprotected

Get the float style of a page element.

Parameters
peThe story page element.
Returns
The float style.

Definition at line 353 of file story_gui.cpp.

References Window::flags, StoryPageElement::referenced_id, SPET_BUTTON_PUSH, SPET_BUTTON_TILE, SPET_BUTTON_VEHICLE, and StoryPageElement::type.

Referenced by EnsureStoryPageElementLayout().

◆ GetPageElementFloatWidth()

int StoryBookWindow::GetPageElementFloatWidth ( const StoryPageElement pe) const
inlineprotected

Get the width a page element would use if it was floating left or right.

Parameters
peThe story page element.
Returns
The calculated width of the element.

Definition at line 375 of file story_gui.cpp.

References WidgetDimensions::framerect, WidgetDimensions::frametext, FS_NORMAL, GetStringBoundingBox(), WidgetDimensions::scaled, SPET_BUTTON_PUSH, SPET_BUTTON_TILE, SPET_BUTTON_VEHICLE, StoryPageElement::text, StoryPageElement::type, and RectPadding::Vertical().

Referenced by EnsureStoryPageElementLayout().

◆ GetPageElementHeight()

uint StoryBookWindow::GetPageElementHeight ( const StoryPageElement pe,
int  max_width 
) const
inlineprotected

Get the height in pixels used by a page element.

Parameters
peThe story page element.
max_widthAvailable width to display content.
Returns
the height in pixels.

Definition at line 322 of file story_gui.cpp.

References WidgetDimensions::framerect, WidgetDimensions::frametext, FS_NORMAL, GetPageElementSprite(), GetSpriteSize(), GetStringBoundingBox(), GetStringHeight(), WidgetDimensions::scaled, SetDParamStr(), SPET_BUTTON_PUSH, SPET_BUTTON_TILE, SPET_BUTTON_VEHICLE, SPET_GOAL, SPET_LOCATION, SPET_TEXT, StoryPageElement::text, StoryPageElement::type, and RectPadding::Vertical().

Referenced by EnsureStoryPageElementLayout().

◆ GetPageElementSprite()

SpriteID StoryBookWindow::GetPageElementSprite ( const StoryPageElement pe) const
inlineprotected

Decides which sprite to display for a given page element.

Parameters
peThe page element.
Returns
The SpriteID of the sprite to display.
Precondition
pe.type must be SPET_GOAL or SPET_LOCATION.

Definition at line 301 of file story_gui.cpp.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_goal_pool >::Get(), StoryPageElement::referenced_id, SPET_GOAL, and StoryPageElement::type.

Referenced by GetPageElementHeight().

◆ GetSelPage()

StoryPage* StoryBookWindow::GetSelPage ( ) const
inlineprotected

Get instance of selected page.

Returns
Instance of selected page or nullptr if no page is selected.

Definition at line 134 of file story_gui.cpp.

Referenced by BuildStoryPageElementList(), EnsureStoryPageElementLayout(), GetHeadHeight(), and RefreshSelectedPage().

◆ GetSelPageNum()

int StoryBookWindow::GetSelPageNum ( ) const
inlineprotected

Get the page number of selected page.

Returns
Number of available pages before to the selected one, or -1 if no page is selected.

Definition at line 144 of file story_gui.cpp.

Referenced by RefreshSelectedPage().

◆ OnInvalidateData()

void StoryBookWindow::OnInvalidateData ( [[maybe_unused] ] int  data = 0,
[[maybe_unused] ] bool  gui_scope = true 
)
inlineoverridevirtual

Some data on this window has become invalid.

Parameters
dataInformation about the changed data. -1 Rebuild page list and refresh current page; >= 0 Id of the page that needs to be refreshed. If it is not the current page, nothing happens.
gui_scopeWhether 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 858 of file story_gui.cpp.

References BuildStoryPageList(), and GUIList< T, P, F >::ForceRebuild().

◆ OnPageElementClick()

◆ OnPaint()

void StoryBookWindow::OnPaint ( )
inlineoverridevirtual

The window must be repainted.

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

Reimplemented from Window.

Definition at line 663 of file story_gui.cpp.

References Window::DrawWidgets(), GetContentHeight(), Scrollbar::GetCount(), Scrollbar::SetCount(), Window::SetWidgetDirty(), WID_SB_PAGE_PANEL, and WID_SB_SCROLLBAR.

◆ OnResize()

void StoryBookWindow::OnResize ( )
inlineoverridevirtual

Called after the window got resized.

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

Reimplemented from Window.

Definition at line 795 of file story_gui.cpp.

References GetContentHeight(), InvalidateStoryPageElementLayout(), WidgetDimensions::scaled, Scrollbar::SetCapacityFromWidget(), Scrollbar::SetCount(), and WID_SB_PAGE_PANEL.

◆ SetSelectedPage()

void StoryBookWindow::SetSelectedPage ( uint16_t  page_index)
inline

Sets the selected page.

Parameters
page_indexpool index of the page to select.

Definition at line 633 of file story_gui.cpp.

Field Documentation

◆ page_element_sorter_funcs

const std::initializer_list< GUIStoryPageElementList::SortFunction *const > StoryBookWindow::page_element_sorter_funcs
staticprotected
Initial value:
= {
}
static bool PageElementOrderSorter(const StoryPageElement *const &a, const StoryPageElement *const &b)
Sort story page elements by order value.
Definition: story_gui.cpp:115

Definition at line 66 of file story_gui.cpp.

◆ page_sorter_funcs

const std::initializer_list< GUIStoryPageList::SortFunction *const > StoryBookWindow::page_sorter_funcs
staticprotected
Initial value:
= {
}
static bool PageOrderSorter(const StoryPage *const &a, const StoryPage *const &b)
Sort story pages by order value.
Definition: story_gui.cpp:87

Definition at line 65 of file story_gui.cpp.


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