OpenTTD Source  20241120-master-g6d3adc6169
WindowDesc Struct Reference

High level window description. More...

#include <window_gui.h>

Inheritance diagram for WindowDesc:
ZeroedMemoryAllocator

Public Member Functions

 WindowDesc (WindowPosition default_pos, const char *ini_key, int16_t def_width_trad, int16_t def_height_trad, WindowClass window_class, WindowClass parent_class, uint32_t flags, const std::span< const NWidgetPart > nwid_parts, HotkeyList *hotkeys=nullptr, const std::source_location location=std::source_location::current())
 Window description constructor.
 
int16_t GetDefaultWidth () const
 Determine default width of window. More...
 
int16_t GetDefaultHeight () const
 Determine default height of window. More...
 
- 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...
 

Static Public Member Functions

static void LoadFromConfig ()
 Load all WindowDesc settings from _windows_file.
 
static void SaveToConfig ()
 Save all WindowDesc settings to _windows_file.
 

Data Fields

const std::source_location source_location
 Source location of this definition.
 
WindowPosition default_pos
 Preferred position of the window. More...
 
WindowClass cls
 Class of the window,. More...
 
WindowClass parent_cls
 Class of the parent window. More...
 
const char * ini_key
 Key to store window defaults in openttd.cfg. nullptr if nothing shall be stored.
 
uint32_t flags
 Flags. More...
 
const std::span< const NWidgetPartnwid_parts
 Span of nested widget parts describing the window.
 
HotkeyListhotkeys
 Hotkeys for the window.
 
bool pref_sticky
 Preferred stickyness.
 
int16_t pref_width
 User-preferred width of the window. Zero if unset.
 
int16_t pref_height
 User-preferred height of the window. Zero if unset.
 

Private Member Functions

 WindowDesc (const WindowDesc &)=delete
 Delete copy constructor to prevent compilers from copying the structure, which fails due to _window_descs.
 
WindowDescoperator= (const WindowDesc &)=delete
 

Private Attributes

int16_t default_width_trad
 Preferred initial width of the window (pixels at 1x zoom).
 
int16_t default_height_trad
 Preferred initial height of the window (pixels at 1x zoom).
 

Detailed Description

High level window description.

Definition at line 159 of file window_gui.h.

Member Function Documentation

◆ GetDefaultHeight()

int16_t WindowDesc::GetDefaultHeight ( ) const

Determine default height of window.

This is either a stored user preferred size, or the built-in default.

Returns
Height in pixels.

Definition at line 147 of file window.cpp.

References default_height_trad, pref_height, and ScaleGUITrad().

Referenced by LocalGetWindowPlacement().

◆ GetDefaultWidth()

int16_t WindowDesc::GetDefaultWidth ( ) const

Determine default width of window.

This is either a stored user preferred size, or the built-in default.

Returns
Width in pixels.

Definition at line 137 of file window.cpp.

References default_width_trad, pref_width, and ScaleGUITrad().

Referenced by Window::FinishInitNested(), LocalGetWindowPlacement(), and Window::ReInit().

Field Documentation

◆ cls

WindowClass WindowDesc::cls

Class of the window,.

See also
WindowClass.

Definition at line 170 of file window_gui.h.

Referenced by AllocateWindowDescFront(), and Window::InitializeData().

◆ default_pos

WindowPosition WindowDesc::default_pos

Preferred position of the window.

See also
WindowPosition()

Definition at line 169 of file window_gui.h.

Referenced by Window::InitializeData().

◆ flags

uint32_t WindowDesc::flags

Flags.

See also
WindowDefaultFlag

Definition at line 173 of file window_gui.h.

Referenced by CloseAllNonVitalWindows(), CloseConstructionWindows(), and CloseNonVitalWindows().

◆ parent_cls

WindowClass WindowDesc::parent_cls

Class of the parent window.

See also
WindowClass

Definition at line 171 of file window_gui.h.

Referenced by LocalGetWindowPlacement().


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