Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes

Window Struct Reference

Data structure for an opened window. More...

#include <window_gui.h>

Inheritance diagram for Window:
ZeroedMemoryAllocator AboutWindow AIConfigWindow AIDebugWindow AIListWindow AISettingsWindow BaseGraphWindow BaseNetworkContentDownloadStatusWindow BaseVehicleListWindow BootstrapAskForDownloadWindow BootstrapBackground BuildAirToolbarWindow BuildBridgeWindow BuildDocksToolbarWindow BuildIndustryWindow BuildRailToolbarWindow BuildRoadToolbarWindow BuildTreesWindow BuildVehicleWindow BuyCompanyWindow CheatWindow CompanyFinancesWindow CompanyInfrastructureWindow CompanyLeagueWindow CompanyStationsWindow CompanyWindow CreateScenarioWindow CustomCurrencyWindow DepotWindow DropdownWindow EndGameHighScoreBaseWindow EnginePreviewWindow ErrmsgWindow ExtraViewportWindow FoundTownWindow GameOptionsWindow GameSettingsWindow GenerateLandscapeWindow GenerateProgressWindow GoalListWindow GoalQuestionWindow GraphLegendWindow IConsoleWindow IndustryCargoesWindow IndustryDirectoryWindow IndustryViewWindow LandInfoWindow LinkGraphLegendWindow MainToolbarWindow MainWindow MessageHistoryWindow MusicTrackSelectionWindow MusicWindow NetworkChatWindow NetworkClientListPopupWindow NetworkClientListWindow NetworkCompanyPasswordWindow NetworkContentListWindow NetworkGameWindow NetworkJoinStatusWindow NetworkLobbyWindow NetworkStartServerWindow NewGRFInspectWindow NewGRFParametersWindow NewGRFWindow NewsWindow OrdersWindow OskWindow PerformanceRatingDetailWindow PickerWindowBase QueryStringWindow QueryWindow RefitWindow ReplaceVehicleWindow SaveLoadWindow ScanProgressWindow ScenarioEditorLandscapeGenerationWindow ScenarioEditorToolbarWindow SelectCompanyLiveryWindow SelectCompanyManagerFaceWindow SelectGameWindow SelectStationWindow< T > SetDateWindow SignListWindow SignWindow SmallMapWindow SpriteAlignerWindow StationViewWindow StatusBarWindow StoryBookWindow SubsidyListWindow TerraformToolbarWindow TextfileWindow TimetableWindow TooltipsWindow TownAuthorityWindow TownDirectoryWindow TownViewWindow TransparenciesWindow VehicleDetailsWindow VehicleViewWindow WaypointWindow

Public Member Functions

 Window (WindowDesc *desc)
 Empty constructor, initialization has been moved to InitNested() called from the constructor of the derived class.
virtual ~Window ()
 Remove window and all its child windows from the window stack.
void * operator new[] (size_t size)
 Helper allocation function to disallow something.
void operator delete (void *ptr)
 Helper allocation function to disallow something.
template<class NWID >
const NWID * GetWidget (uint widnum) const
 Specialized case of Window::GetWidget for the nested widget base class.
template<class NWID >
NWID * GetWidget (uint widnum)
 Get the nested widget with number widnum from the nested widget tree.
const ScrollbarGetScrollbar (uint widnum) const
 Return the Scrollbar to a widget index.
ScrollbarGetScrollbar (uint widnum)
 Return the Scrollbar to a widget index.
const QueryStringGetQueryString (uint widnum) const
 Return the querystring associated to a editbox.
QueryStringGetQueryString (uint widnum)
 Return the querystring associated to a editbox.
virtual const char * GetFocusedText () const
 Get the current input text if an edit box has the focus.
virtual const char * GetCaret () const
 Get the string at the caret if an edit box has the focus.
virtual const char * GetMarkedText (size_t *length) const
 Get the range of the currently marked input text.
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 const char * 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 (bool fill_nested=true)
 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.
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 (byte widget_index, TextColour highlighted_colour)
 Sets the highlighted status of a widget.
bool IsWidgetHighlighted (byte widget_index) const
 Gets the highlighted status of a widget.
void SetWidgetDisabledState (byte widget_index, bool disab_stat)
 Sets the enabled/disabled status of a widget.
void DisableWidget (byte widget_index)
 Sets a widget to disabled.
void EnableWidget (byte widget_index)
 Sets a widget to Enabled.
bool IsWidgetDisabled (byte widget_index) const
 Gets the enabled/disabled status of a widget.
bool IsWidgetFocused (byte widget_index) const
 Check if given widget is focused within this window.
bool IsWidgetGloballyFocused (byte widget_index) const
 Check if given widget has user input focus.
void SetWidgetLoweredState (byte widget_index, bool lowered_stat)
 Sets the lowered/raised status of a widget.
void ToggleWidgetLoweredState (byte widget_index)
 Invert the lowered/raised status of a widget.
void LowerWidget (byte widget_index)
 Marks a widget as lowered.
void RaiseWidget (byte widget_index)
 Marks a widget as raised.
bool IsWidgetLowered (byte widget_index) const
 Gets the lowered state of a widget.
void UnfocusFocusedWidget ()
 Makes no widget on this window have focus.
bool SetFocusedWidget (int widget_index)
 Set focus within this window to the given widget.
EventState HandleEditBoxKey (int wid, WChar key, uint16 keycode)
 Process keypress for editbox widget.
virtual void InsertTextString (int 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 (byte widget)
 Do all things to make a button look clicked and mark it to be unclicked in a few ticks.
int GetRowFromWidget (int clickpos, int 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.
void CDECL SetWidgetsDisabledState (bool disab_stat, int widgets,...)
 Sets the enabled/disabled status of a list of widgets.
void CDECL SetWidgetsLoweredState (bool lowered_stat, int widgets,...)
 Sets the lowered/raised status of a list of widgets.
void SetWidgetDirty (byte 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 (int widget, SortButtonState state) const
 Draw a sort button's up or down arrow symbol.
void DeleteChildWindows (WindowClass wc=WC_INVALID) const
 Delete all children a window might have in a head-recursive manner.
void SetDirty () const
 Mark entire window as dirty (in need of re-paint).
void ReInit (int rx=0, int ry=0)
 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 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 sm_width, int16 sm_height, int window_number)
 Compute the initial position of the window.
virtual void OnPaint ()
 The window must be repainted.
virtual void DrawWidget (const Rect &r, int widget) const
 Draw the contents of a nested widget.
virtual void UpdateWidgetSize (int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
 Update size and resize step of a widget in the window.
virtual void SetStringParameters (int widget) const
 Initialize string parameters for a widget.
virtual void OnFocus ()
 Called when window gains focus.
virtual void OnFocusLost ()
 Called when window looses focus.
virtual EventState OnKeyPress (WChar key, uint16 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 void OnClick (Point pt, int widget, int click_count)
 A click with the left mouse button has been made on the window.
virtual bool OnRightClick (Point pt, int widget)
 A click with the right mouse button has been made on the window.
virtual void OnHover (Point pt, int widget)
 The mouse is hovering over a widget in the window, perform an action for it, like opening a custom tooltip.
virtual void OnMouseDrag (Point pt, int widget)
 An 'object' is being dragged at the provided position, highlight the target if possible.
virtual void OnDragDrop (Point pt, int widget)
 A dragged 'object' has been released.
virtual void OnScroll (Point delta)
 Handle the request for (viewport) scrolling.
virtual void OnMouseOver (Point pt, int 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 OnTick ()
 Called once per (game) tick.
virtual void OnHundredthTick ()
 Called once every 100 (game) ticks.
virtual void OnTimeout ()
 Called when this window's timeout has been reached.
virtual void OnResize ()
 Called after the window got resized.
virtual void OnDropdownSelect (int widget, int index)
 A dropdown option associated to this window has been selected.
virtual void OnDropdownClose (Point pt, int widget, int index, bool instant_close)
 A dropdown window associated to this window has been closed.
virtual void OnEditboxChanged (int widget)
 The text in an editbox has been edited.
virtual void OnQueryTextFinished (char *str)
 The query window opened from this window has closed.
virtual void OnInvalidateData (int data=0, bool gui_scope=true)
 Some data on this window has become invalid.
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 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.

Data Fields

WindowDescwindow_desc
 Window description.
WindowFlags flags
 Window flags.
WindowClass window_class
 Window class.
WindowNumber window_number
 Window number within the window class.
uint8 timeout_timer
 Timer value of the WF_TIMEOUT for flags.
uint8 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 NULL if no nested widget has focus.
SmallMap< int, QueryString * > querystrings
 QueryString associated to WWT_EDITBOX widgets.
NWidgetBasenested_root
 Root of the nested tree.
NWidgetBase ** nested_array
 Array of pointers into the tree. Do not access directly, use Window::GetWidget() instead.
uint nested_array_size
 Size of the nested array.
NWidgetStackedshade_select
 Selection widget (NWID_SELECTION) to use for shading the window. If NULL, window cannot shade.
Dimension unshaded_size
 Last known unshaded size (only valid while shaded).
int scrolling_scrollbar
 Widgetindex of just being dragged scrollbar. -1 if none is active.
Windowparent
 Parent window.
Windowz_front
 The window in front of us in z-order.
Windowz_back
 The window behind us in z-order.

Protected Member Functions

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.
void FindWindowPlacementAndResize (int def_width, int def_height)
 Resize window towards the default size.

Protected Attributes

SmallVector< int, 4 > scheduled_invalidation_data
 Data of scheduled OnInvalidateData() calls.

Detailed Description

Data structure for an opened window.

Definition at line 272 of file window_gui.h.


Constructor & Destructor Documentation

Window::Window ( WindowDesc desc  ) 

Empty constructor, initialization has been moved to InitNested() called from the constructor of the derived class.

Parameters:
desc The description of the window.

Definition at line 1765 of file window.cpp.


Member Function Documentation

void Window::CreateNestedTree ( bool  fill_nested = true  ) 

Perform the first part of the initialization of a nested widget tree.

Construct a nested widget tree in nested_root, and optionally fill the nested_array array to provide quick access to the uninitialized widgets. This is mainly useful for setting very basic properties.

Parameters:
fill_nested Fill the nested_array (enabling is expensive!).
Note:
Filling the nested array requires an additional traversal through the nested widget tree, and is best performed by FinishInitNested rather than here.

Definition at line 1726 of file window.cpp.

References MakeWindowNWidgetTree(), nested_array, nested_array_size, nested_root, WindowDesc::nwid_parts, and window_desc.

Referenced by AIDebugWindow::AIDebugWindow(), AIListWindow::AIListWindow(), AISettingsWindow::AISettingsWindow(), DropdownWindow::DropdownWindow(), InitNested(), NetworkContentListWindow::NetworkContentListWindow(), VehicleDetailsWindow::VehicleDetailsWindow(), and WaypointWindow::WaypointWindow().

void Window::DeleteChildWindows ( WindowClass  wc = WC_INVALID  )  const

Delete all children a window might have in a head-recursive manner.

Parameters:
wc Window class of the window to remove; WC_INVALID if class does not matter

Definition at line 1020 of file window.cpp.

References FindChildWindow().

Referenced by TimetableWindow::OnClick(), OrdersWindow::OnClick(), NewGRFParametersWindow::OnClick(), AISettingsWindow::OnClick(), TimetableWindow::OnInvalidateData(), OrdersWindow::OnInvalidateData(), NewGRFParametersWindow::OnInvalidateData(), NewGRFWindow::OnNewGRFsScanned(), and ~Window().

void Window::DisableWidget ( byte  widget_index  )  [inline]

Sets a widget to disabled.

Parameters:
widget_index index of this widget in the window

Definition at line 398 of file window_gui.h.

References SetWidgetDisabledState().

Referenced by CustomCurrencyWindow::OnClick(), NewGRFWindow::OnInvalidateData(), CompanyWindow::OnInvalidateData(), VehicleDetailsWindow::OnPaint(), TimetableWindow::OnPaint(), and BuildRoadToolbarWindow::UpdateOptionWidgetStatus().

virtual void Window::DrawWidget ( const Rect r,
int  widget 
) const [inline, virtual]

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 in AIListWindow, AISettingsWindow, AIConfigWindow, AIDebugWindow, BuildAirportWindow, ReplaceVehicleWindow, BootstrapBackground, BuildBridgeWindow, BuildVehicleWindow, CheatWindow, CompanyFinancesWindow, SelectCompanyLiveryWindow, SelectCompanyManagerFaceWindow, CompanyInfrastructureWindow, CompanyWindow, BuyCompanyWindow, DepotWindow, EnginePreviewWindow, SaveLoadWindow, GenerateLandscapeWindow, GenerateProgressWindow, GoalQuestionWindow, GraphLegendWindow, BaseGraphWindow, PaymentRatesGraphWindow, CompanyLeagueWindow, PerformanceRatingDetailWindow, VehicleGroupWindow, BuildIndustryWindow, IndustryDirectoryWindow, IndustryCargoesWindow, SelectGameWindow, LinkGraphLegendWindow, LandInfoWindow, AboutWindow, TooltipsWindow, QueryWindow, MusicTrackSelectionWindow, MusicWindow, NetworkChatWindow, NetworkGameWindow, NetworkStartServerWindow, NetworkLobbyWindow, NetworkClientListPopupWindow, NetworkClientListWindow, NetworkJoinStatusWindow, SpriteAlignerWindow, NewGRFParametersWindow, ScanProgressWindow, NewsWindow, MessageHistoryWindow, BuildObjectWindow, OrdersWindow, OskWindow, BuildRailStationWindow, BuildSignalWindow, BuildRailDepotWindow, BuildRailWaypointWindow, BuildRoadDepotWindow, BuildRoadStationWindow, GameOptionsWindow, GameSettingsWindow, SmallMapWindow, CompanyStationsWindow, SelectStationWindow< T >, StatusBarWindow, StoryBookWindow, SubsidyListWindow, ScenarioEditorLandscapeGenerationWindow, TimetableWindow, ScenarioEditorToolbarWindow, TownAuthorityWindow, TownViewWindow, TownDirectoryWindow, TransparenciesWindow, BuildTreesWindow, RefitWindow, VehicleListWindow, VehicleDetailsWindow, VehicleViewWindow, and DropdownWindow.

Definition at line 564 of file window_gui.h.

Referenced by NWidgetLeaf::Draw(), and NWidgetBackground::Draw().

void Window::EnableWidget ( byte  widget_index  )  [inline]

Sets a widget to Enabled.

Parameters:
widget_index index of this widget in the window

Definition at line 407 of file window_gui.h.

References SetWidgetDisabledState().

Referenced by CustomCurrencyWindow::OnClick(), and SelectCompanyLiveryWindow::OnInvalidateData().

void Window::FindWindowPlacementAndResize ( int  def_width,
int  def_height 
) [protected]

Resize window towards the default size.

Prior to construction, a position for the new window (for its default size) has been found with LocalGetWindowPlacement(). Initially, the window is constructed with minimal size. Resizing the window to its default size is done here.

Parameters:
def_width default width in pixels of the window
def_height default height in pixels of the window
See also:
Window::Window(), Window::InitializeData(), Window::InitializePositionSize()

Definition at line 1448 of file window.cpp.

References FindWindowById(), height, ViewPort::left, left, max(), min(), OnResize(), resize, ResizeWindow(), SetDirty(), ResizeInfo::step_height, ResizeInfo::step_width, ViewPort::top, top, viewport, WC_MAIN_TOOLBAR, WC_STATUS_BAR, and width.

Referenced by FinishInitNested().

const char * Window::GetCaret (  )  const [virtual]

Get the string at the caret if an edit box has the focus.

Returns:
The text at the caret or NULL if no edit box is focused.

Reimplemented in IConsoleWindow.

Definition at line 339 of file window.cpp.

References QueryString::GetCaret(), GetQueryString(), NWidgetCore::index, nested_focus, NWidgetBase::type, and WWT_EDITBOX.

Point Window::GetCaretPosition (  )  const [virtual]

Get the current caret position if an edit box has the focus.

Returns:
Top-left location of the caret, relative to the window.

Reimplemented in IConsoleWindow.

Definition at line 366 of file window.cpp.

References QueryString::GetCaretPosition(), GetQueryString(), NWidgetCore::index, nested_focus, NWidgetBase::type, and WWT_EDITBOX.

Referenced by SetCandidatePos(), and SetCompositionPos().

const char * Window::GetFocusedText (  )  const [virtual]

Get the current input text if an edit box has the focus.

Returns:
The currently focused input text or NULL if no input focused.

Reimplemented in IConsoleWindow.

Definition at line 326 of file window.cpp.

References GetQueryString(), QueryString::GetText(), NWidgetCore::index, nested_focus, NWidgetBase::type, and WWT_EDITBOX.

const char * Window::GetMarkedText ( size_t *  length  )  const [virtual]

Get the range of the currently marked input text.

Parameters:
[out] length Length of the marked text.
Returns:
Pointer to the start of the marked text or NULL if no text is marked.

Reimplemented in IConsoleWindow.

Definition at line 353 of file window.cpp.

References QueryString::GetMarkedText(), GetQueryString(), NWidgetCore::index, nested_focus, NWidgetBase::type, and WWT_EDITBOX.

const QueryString * Window::GetQueryString ( uint  widnum  )  const

Return the querystring associated to a editbox.

Parameters:
widnum Editbox widget index
Returns:
QueryString or NULL.

Definition at line 305 of file window.cpp.

References SmallVector< T, S >::End(), SmallMap< T, U, S >::Find(), and querystrings.

Referenced by DispatchLeftClickEvent(), NWidgetLeaf::Draw(), GetCaret(), GetCaretPosition(), GetFocusedText(), GetMarkedText(), GetTextBoundingRect(), GetTextCharacterAtPosition(), HandleEditBoxKey(), and InsertTextString().

QueryString * Window::GetQueryString ( uint  widnum  ) 

Return the querystring associated to a editbox.

Parameters:
widnum Editbox widget index
Returns:
QueryString or NULL.

Definition at line 316 of file window.cpp.

References SmallVector< T, S >::End(), SmallMap< T, U, S >::Find(), and querystrings.

int Window::GetRowFromWidget ( int  clickpos,
int  widget,
int  padding,
int  line_height = -1 
) const

Compute the row of a widget that a user clicked in.

Parameters:
clickpos Vertical position of the mouse click.
widget Widget number of the widget clicked in.
padding Amount of empty space between the widget edge and the top of the first row.
line_height Height of a single row. A negative value means using the vertical resize step of the widget.
Returns:
Row number clicked at. If clicked at a wrong position, INT_MAX is returned.
Note:
The widget does not know where a list printed at the widget ends, so below a list is not a wrong position.

Definition at line 177 of file window.cpp.

References NWidgetBase::pos_y, and NWidgetBase::resize_y.

Referenced by Scrollbar::GetScrolledRowFromWidget(), TownAuthorityWindow::OnClick(), and MusicTrackSelectionWindow::OnClick().

Scrollbar * Window::GetScrollbar ( uint  widnum  ) 

Return the Scrollbar to a widget index.

Parameters:
widnum Scrollbar widget index
Returns:
Scrollbar to the widget

Definition at line 295 of file window.cpp.

const Scrollbar * Window::GetScrollbar ( uint  widnum  )  const
Rect Window::GetTextBoundingRect ( const char *  from,
const char *  to 
) const [virtual]

Get the bounding rectangle for a text range if an edit box has the focus.

Parameters:
from Start of the string range.
to End of the string range.
Returns:
Rectangle encompassing the string range, relative to the window.

Reimplemented in IConsoleWindow.

Definition at line 382 of file window.cpp.

References QueryString::GetBoundingRect(), GetQueryString(), NWidgetCore::index, nested_focus, NWidgetBase::type, and WWT_EDITBOX.

const char * Window::GetTextCharacterAtPosition ( const Point pt  )  const [virtual]

Get the character that is rendered at a position by the focused edit box.

Parameters:
pt The position to test.
Returns:
Pointer to the character at the position or NULL if no character is at the position.

Reimplemented in IConsoleWindow.

Definition at line 397 of file window.cpp.

References QueryString::GetCharAtPosition(), GetQueryString(), NWidgetCore::index, nested_focus, NWidgetBase::type, and WWT_EDITBOX.

template<class NWID >
const NWID * Window::GetWidget ( uint  widnum  )  const [inline]

Specialized case of Window::GetWidget for the nested widget base class.

Get the nested widget with number widnum from the nested widget tree.

Template Parameters:
NWID Type of the nested widget.
Parameters:
widnum Widget number of the widget to retrieve.
Returns:
The requested widget if it is instantiated, NULL otherwise.

Definition at line 827 of file window_gui.h.

Referenced by QueryString::GetBoundingRect(), QueryString::GetCaretPosition(), QueryString::GetCharAtPosition(), LinkGraphOverlay::GetWidgetDpi(), HandleScrollbarScrolling(), Scrollbar::SetCapacityFromWidget(), LinkGraphOverlay::SetCargoMask(), LinkGraphOverlay::SetCompanyMask(), and ShowDropDownList().

template<class NWID >
NWID * Window::GetWidget ( uint  widnum  )  [inline]

Get the nested widget with number widnum from the nested widget tree.

Template Parameters:
NWID Type of the nested widget.
Parameters:
widnum Widget number of the widget to retrieve.
Returns:
The requested widget if it is instantiated, NULL otherwise.

Definition at line 804 of file window_gui.h.

References nested_array, and nested_array_size.

void Window::HandleButtonClick ( byte  widget  ) 
EventState Window::HandleEditBoxKey ( int  wid,
WChar  key,
uint16  keycode 
)

Process keypress for editbox widget.

Parameters:
wid Editbox widget.
key the Unicode value of the key.
keycode the untranslated key code including shift state.
Returns:
ES_HANDLED if the key press has been handled and no other window should receive the event.

Definition at line 2474 of file window.cpp.

References QueryString::ACTION_CLEAR, QueryString::ACTION_DESELECT, QueryString::ACTION_NOTHING, Textbuf::bytes, QueryString::cancel_button, Textbuf::DeleteAll(), GetQueryString(), HKPR_CANCEL, HKPR_CONFIRM, HKPR_CURSOR, HKPR_EDITING, HKPR_NOT_HANDLED, InvalidateData(), QueryString::ok_button, OnClick(), OnEditboxChanged(), SetWidgetDirty(), UnfocusFocusedWidget(), WC_OSK, WID_OSK_CANCEL, WID_OSK_OK, and window_class.

Referenced by HandleKeypress().

void Window::InitializeData ( WindowNumber  window_number  )  [protected]

Initializes the data (except the position and initial size) of a new Window.

Parameters:
desc Window description.
window_number Number being assigned to the new window
Returns:
Window pointer of the newly created window
Precondition:
If nested widgets are used (widget is NULL), nested_root and nested_array_size must be initialized. In addition, nested_array is either NULL, or already initialized.

Definition at line 1388 of file window.cpp.

References _current_text_dir, AddWindowToZOrdering(), NWidgetBase::AssignSizePosition(), WindowDesc::cls, WindowDesc::default_pos, EditBoxInGlobalFocus(), flags, NWidgetBase::GetWidgetOfType(), nested_array, nested_array_size, nested_focus, nested_root, OnInit(), owner, resize, NWidgetBase::resize_x, NWidgetBase::resize_y, SetFocusedWindow(), NWidgetBase::SetupSmallestSize(), SetWhiteBorder(), NWidgetBase::smallest_x, ST_SMALLEST, ResizeInfo::step_height, ResizeInfo::step_width, TD_RTL, WDP_CENTER, window_class, window_desc, and WWT_EDITBOX.

Referenced by FinishInitNested().

void Window::InitializePositionSize ( int  x,
int  y,
int  sm_width,
int  sm_height 
) [protected]

Set the position and smallest size of the window.

Parameters:
x Offset in pixels from the left of the screen of the new window.
y Offset in pixels from the top of the screen of the new window.
sm_width Smallest width in pixels of the window.
sm_height Smallest height in pixels of the window.

Definition at line 1430 of file window.cpp.

References height, left, top, and width.

Referenced by FinishInitNested().

void Window::InitNested ( WindowNumber  window_number = 0  ) 

Perform complete initialization of the Window with nested widgets, to allow use.

Parameters:
window_number Number of the new window.

Definition at line 1755 of file window.cpp.

References CreateNestedTree(), and FinishInitNested().

Referenced by BaseNetworkContentDownloadStatusWindow::BaseNetworkContentDownloadStatusWindow(), BootstrapAskForDownloadWindow::BootstrapAskForDownloadWindow(), NetworkChatWindow::NetworkChatWindow(), and ScanProgressWindow::ScanProgressWindow().

void Window::InsertTextString ( int  wid,
const char *  str,
bool  marked,
const char *  caret,
const char *  insert_location,
const char *  replacement_end 
) [virtual]

Insert a text string at the cursor position into the edit box widget.

Parameters:
wid Edit box widget.
str Text string to insert.

Reimplemented in IConsoleWindow.

Definition at line 2618 of file window.cpp.

References GetQueryString(), Textbuf::InsertString(), OnEditboxChanged(), and SetWidgetDirty().

Referenced by HandleTextInput().

virtual bool Window::IsNewGRFInspectable (  )  const [inline, virtual]

Is the data related to this window NewGRF inspectable?

Returns:
true iff it is inspectable.

Reimplemented in IndustryViewWindow, LandInfoWindow, and VehicleViewWindow.

Definition at line 786 of file window_gui.h.

Referenced by NWidgetLeaf::SetupSmallestSize().

bool Window::IsWidgetFocused ( byte  widget_index  )  const [inline]

Check if given widget is focused within this window.

Parameters:
widget_index : index of the widget in the window to check
Returns:
true if given widget is the focused window in this window

Definition at line 428 of file window_gui.h.

References NWidgetCore::index, and nested_focus.

Referenced by IsWidgetGloballyFocused().

bool Window::IsWidgetGloballyFocused ( byte  widget_index  )  const [inline]

Check if given widget has user input focus.

This means that both the window has focus and that the given widget has focus within the window.

Parameters:
widget_index : index of the widget in the window to check
Returns:
true if given widget is the focused window in this window and this window has focus

Definition at line 439 of file window_gui.h.

References IsWidgetFocused().

bool Window::IsWidgetHighlighted ( byte  widget_index  )  const

Gets the highlighted status of a widget.

Parameters:
widget_index index of this widget in the window
Returns:
status of the widget ie: highlighted = true, not highlighted = false

Definition at line 241 of file window.cpp.

References nested_array_size.

Referenced by DispatchLeftClickEvent(), and ProcessHighlightedInvalidations().

bool Window::IsWidgetLowered ( byte  widget_index  )  const [inline]
virtual void Window::OnClick ( Point  pt,
int  widget,
int  click_count 
) [inline, virtual]

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 in AIListWindow, AISettingsWindow, AIConfigWindow, AIDebugWindow, BuildAirToolbarWindow, BuildAirportWindow, ReplaceVehicleWindow, BuildBridgeWindow, BuildVehicleWindow, CheatWindow, CompanyFinancesWindow, SelectCompanyLiveryWindow, SelectCompanyManagerFaceWindow, CompanyWindow, BuyCompanyWindow, SetDateWindow, DepotWindow, BuildDocksToolbarWindow, BuildDocksStationWindow, BuildDocksDepotWindow, EnginePreviewWindow, SaveLoadWindow, GenerateLandscapeWindow, CreateScenarioWindow, GenerateProgressWindow, GoalListWindow, GoalQuestionWindow, GraphLegendWindow, BaseGraphWindow, PerformanceHistoryGraphWindow, PaymentRatesGraphWindow, PerformanceRatingDetailWindow, VehicleGroupWindow, EndGameHighScoreBaseWindow, BuildIndustryWindow, IndustryViewWindow, IndustryDirectoryWindow, IndustryCargoesWindow, SelectGameWindow, LinkGraphLegendWindow, QueryStringWindow, QueryWindow, MusicTrackSelectionWindow, MusicWindow, NetworkChatWindow, NetworkGameWindow, NetworkStartServerWindow, NetworkLobbyWindow, NetworkClientListWindow, NetworkJoinStatusWindow, NetworkCompanyPasswordWindow, SpriteAlignerWindow, NewGRFParametersWindow, NewsWindow, MessageHistoryWindow, BuildObjectWindow, OrdersWindow, OskWindow, BuildRailToolbarWindow, BuildRailStationWindow, BuildSignalWindow, BuildRailDepotWindow, BuildRailWaypointWindow, BuildRoadToolbarWindow, BuildRoadDepotWindow, BuildRoadStationWindow, GameOptionsWindow, GameSettingsWindow, CustomCurrencyWindow, SmallMapWindow, CompanyStationsWindow, StationViewWindow, SelectStationWindow< T >, StatusBarWindow, StoryBookWindow, SubsidyListWindow, TerraformToolbarWindow, ScenarioEditorLandscapeGenerationWindow, TimetableWindow, MainToolbarWindow, ScenarioEditorToolbarWindow, TownAuthorityWindow, TownViewWindow, TownDirectoryWindow, FoundTownWindow, TransparenciesWindow, BuildTreesWindow, RefitWindow, VehicleListWindow, VehicleDetailsWindow, VehicleViewWindow, ExtraViewportWindow, WaypointWindow, and DropdownWindow.

Definition at line 620 of file window_gui.h.

Referenced by DispatchLeftClickEvent(), HandleEditBoxKey(), OskWindow::OnClick(), and OnHotkey().

virtual EventState Window::OnCTRLStateChange (  )  [inline, virtual]

The state of the control key has changed.

Returns:
ES_HANDLED if the change has been handled and no other window should receive the event.

Reimplemented in DepotWindow, BuildRailToolbarWindow, and BuildRoadToolbarWindow.

Definition at line 611 of file window_gui.h.

Referenced by HandleCtrlChanged().

virtual void Window::OnDragDrop ( Point  pt,
int  widget 
) [inline, virtual]

A dragged 'object' has been released.

Parameters:
pt the point inside the window where the release took place.
widget the widget where the release took place.

Reimplemented in DepotWindow, VehicleGroupWindow, OrdersWindow, and RefitWindow.

Definition at line 650 of file window_gui.h.

Referenced by HandleMouseDragDrop().

void Window::OnDropdownClose ( Point  pt,
int  widget,
int  index,
bool  instant_close 
) [virtual]

A dropdown window associated to this window has been closed.

Parameters:
pt the point inside the window the mouse resides on after closure.
widget the widget (button) that the dropdown is associated with.
index the element in the dropdown that is selected.
instant_close whether the dropdown was configured to close on mouse up.

Reimplemented in AISettingsWindow, NewGRFParametersWindow, and GameSettingsWindow.

Definition at line 258 of file window.cpp.

References NWidgetCore::disp_flags, GetWidgetFromPos(), OnDropdownSelect(), RaiseWidget(), SetWidgetDirty(), and NWidgetBase::type.

virtual void Window::OnDropdownSelect ( int  widget,
int  index 
) [inline, virtual]
virtual void Window::OnEditboxChanged ( int  widget  )  [inline, virtual]

The text in an editbox has been edited.

Parameters:
widget The widget of the editbox.

Reimplemented in AIDebugWindow, GenerateLandscapeWindow, NetworkChatWindow, NetworkGameWindow, NetworkStartServerWindow, OskWindow, and GameSettingsWindow.

Definition at line 713 of file window_gui.h.

Referenced by HandleEditBoxKey(), InsertTextString(), and OskWindow::OnEditboxChanged().

EventState Window::OnHotkey ( int  hotkey  )  [virtual]
virtual void Window::OnHover ( Point  pt,
int  widget 
) [inline, virtual]

The mouse is hovering over a widget in the window, perform an action for it, like opening a custom tooltip.

Parameters:
pt The point where the mouse is hovering.
widget The widget where the mouse is hovering.

Reimplemented in IndustryCargoesWindow.

Definition at line 636 of file window_gui.h.

Referenced by DispatchHoverEvent().

virtual void Window::OnInit (  )  [inline, virtual]

Notification that the nested widget tree gets initialized.

The event can be used to perform general computations.

Note:
nested_root and/or nested_array (normally accessed via GetWidget()) may not exist during this call.

Reimplemented in BuildVehicleWindow, SelectCompanyManagerFaceWindow, PaymentRatesGraphWindow, BuildIndustryWindow, IndustryCargoesWindow, SelectGameWindow, LandInfoWindow, BuildSignalWindow, SmallMapWindow, TerraformToolbarWindow, BuildTreesWindow, and RefitWindow.

Definition at line 536 of file window_gui.h.

Referenced by InitializeData(), and ReInit().

Point Window::OnInitialPosition ( int16  sm_width,
int16  sm_height,
int  window_number 
) [virtual]

Compute the initial position of the window.

Parameters:
sm_width Smallest width of the window.
sm_height Smallest height of the window.
window_number The window number of the new window.
Returns:
Initial position of the top-left corner of the window.

Reimplemented in BuildBridgeWindow, SetDateWindow, TooltipsWindow, NetworkChatWindow, NetworkClientListPopupWindow, NewsWindow, StatusBarWindow, TerraformToolbarWindow, TransparenciesWindow, and DropdownWindow.

Definition at line 1714 of file window.cpp.

References LocalGetWindowPlacement(), and window_desc.

Referenced by FinishInitNested().

virtual void Window::OnInvalidateData ( int  data = 0,
bool  gui_scope = true 
) [inline, virtual]

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 in AIListWindow, AISettingsWindow, AIConfigWindow, AIDebugWindow, ReplaceVehicleWindow, BuildVehicleWindow, SelectCompanyLiveryWindow, CompanyInfrastructureWindow, CompanyWindow, DepotWindow, BuildDocksToolbarWindow, EnginePreviewWindow, SaveLoadWindow, GenerateLandscapeWindow, GoalListWindow, GraphLegendWindow, BaseGraphWindow, PaymentRatesGraphWindow, CompanyLeagueWindow, PerformanceRatingDetailWindow, VehicleGroupWindow, BuildIndustryWindow, IndustryViewWindow, IndustryDirectoryWindow, IndustryCargoesWindow, SelectGameWindow, LinkGraphLegendWindow, MainWindow, LandInfoWindow, MusicTrackSelectionWindow, MusicWindow, NetworkChatWindow, NetworkGameWindow, SpriteAlignerWindow, NewGRFParametersWindow, NewsWindow, MessageHistoryWindow, OrdersWindow, OskWindow, BuildSignalWindow, BuildRoadToolbarWindow, GameOptionsWindow, GameSettingsWindow, SmallMapWindow, CompanyStationsWindow, StationViewWindow, SelectStationWindow< T >, StatusBarWindow, StoryBookWindow, SubsidyListWindow, TimetableWindow, MainToolbarWindow, ScenarioEditorToolbarWindow, TownViewWindow, TownDirectoryWindow, FoundTownWindow, TransparenciesWindow, RefitWindow, VehicleListWindow, VehicleDetailsWindow, VehicleViewWindow, ExtraViewportWindow, and WaypointWindow.

Definition at line 728 of file window_gui.h.

Referenced by InvalidateData(), and ProcessScheduledInvalidations().

virtual EventState Window::OnKeyPress ( WChar  key,
uint16  keycode 
) [inline, virtual]

A key has been pressed.

Parameters:
key the Unicode value of the key.
keycode the untranslated key code including shift state.
Returns:
ES_HANDLED if the key press has been handled and no other window should receive the event.

Reimplemented in BuildBridgeWindow, IConsoleWindow, SaveLoadWindow, EndGameHighScoreBaseWindow, QueryWindow, NetworkChatWindow, NetworkGameWindow, and NewsWindow.

Definition at line 602 of file window_gui.h.

Referenced by HandleKeypress().

virtual void Window::OnMouseDrag ( Point  pt,
int  widget 
) [inline, virtual]

An 'object' is being dragged at the provided position, highlight the target if possible.

Parameters:
pt The point inside the window that the mouse hovers over.
widget The widget the mouse hovers over.

Reimplemented in DepotWindow, VehicleGroupWindow, OrdersWindow, and RefitWindow.

Definition at line 643 of file window_gui.h.

Referenced by HandleMouseDragDrop().

virtual void Window::OnMouseOver ( Point  pt,
int  widget 
) [inline, virtual]

The mouse is currently moving over the window or has just moved outside of the window.

In the latter case pt is (-1, -1).

Parameters:
pt the point inside the window that the mouse hovers over.
widget the widget the mouse hovers over.

Reimplemented in NetworkClientListWindow, and SmallMapWindow.

Definition at line 664 of file window_gui.h.

Referenced by HandleMouseOver().

virtual void Window::OnMouseWheel ( int  wheel  )  [inline, virtual]

The mouse wheel has been turned.

Parameters:
wheel the amount of movement of the mouse wheel.

Reimplemented in IConsoleWindow, MainWindow, SmallMapWindow, and ExtraViewportWindow.

Definition at line 670 of file window_gui.h.

virtual void Window::OnPlaceDrag ( ViewportPlaceMethod  select_method,
ViewportDragDropSelectionProcess  select_proc,
Point  pt 
) [inline, virtual]

The user is dragging over the map when the tile highlight mode has been set.

Parameters:
select_method the method of selection (allowed directions)
select_proc what will be created when the drag is over.
pt the exact point on the map where the mouse is.

Reimplemented in BuildAirToolbarWindow, BuildDocksToolbarWindow, BuildRailToolbarWindow, BuildRoadToolbarWindow, TerraformToolbarWindow, ScenarioEditorLandscapeGenerationWindow, and BuildTreesWindow.

Definition at line 758 of file window_gui.h.

Referenced by VpHandlePlaceSizingDrag().

virtual void Window::OnPlaceMouseUp ( ViewportPlaceMethod  select_method,
ViewportDragDropSelectionProcess  select_proc,
Point  pt,
TileIndex  start_tile,
TileIndex  end_tile 
) [inline, virtual]

The user has dragged over the map when the tile highlight mode has been set.

Parameters:
select_method the method of selection (allowed directions)
select_proc what should be created.
pt the exact point on the map where the mouse was released.
start_tile the begin tile of the drag.
end_tile the end tile of the drag.

Reimplemented in BuildAirToolbarWindow, BuildDocksToolbarWindow, BuildRailToolbarWindow, BuildRoadToolbarWindow, TerraformToolbarWindow, ScenarioEditorLandscapeGenerationWindow, and BuildTreesWindow.

Definition at line 769 of file window_gui.h.

Referenced by PlaceRail_Bridge(), PlaceRoad_Bridge(), and VpHandlePlaceSizingDrag().

virtual void Window::OnPlaceObject ( Point  pt,
TileIndex  tile 
) [inline, virtual]

The user clicked some place on the map when a tile highlight mode has been set.

Parameters:
pt the exact point on the map that has been clicked.
tile the tile on the map that has been clicked.

Reimplemented in BuildAirToolbarWindow, CompanyWindow, BuildDocksToolbarWindow, BuildIndustryWindow, OrdersWindow, BuildRailToolbarWindow, BuildRoadToolbarWindow, TerraformToolbarWindow, ScenarioEditorLandscapeGenerationWindow, MainToolbarWindow, ScenarioEditorToolbarWindow, FoundTownWindow, and BuildTreesWindow.

Definition at line 736 of file window_gui.h.

virtual void Window::OnPlacePresize ( Point  pt,
TileIndex  tile 
) [inline, virtual]

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.

An example of this is the tile highlight for dock building.

Parameters:
pt the exact point on the map where the mouse is.
tile the tile on the map where the mouse is.

Reimplemented in BuildDocksToolbarWindow, BuildRailToolbarWindow, and BuildRoadToolbarWindow.

Definition at line 778 of file window_gui.h.

virtual void Window::OnQueryTextFinished ( char *  str  )  [inline, virtual]

The query window opened from this window has closed.

Parameters:
str the new value of the string, NULL if the window was cancelled or an empty string when the default button was pressed, i.e. StrEmpty(str).

Reimplemented in AISettingsWindow, BuildVehicleWindow, CheatWindow, SelectCompanyManagerFaceWindow, CompanyWindow, DepotWindow, GenerateLandscapeWindow, CreateScenarioWindow, VehicleGroupWindow, IndustryViewWindow, NetworkGameWindow, NetworkStartServerWindow, NetworkJoinStatusWindow, SpriteAlignerWindow, NewGRFParametersWindow, OrdersWindow, GameSettingsWindow, CustomCurrencyWindow, StationViewWindow, TimetableWindow, ScenarioEditorToolbarWindow, TownViewWindow, VehicleDetailsWindow, and WaypointWindow.

Definition at line 721 of file window_gui.h.

virtual bool Window::OnRightClick ( Point  pt,
int  widget 
) [inline, virtual]

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

Parameters:
pt the point inside the window that has been clicked.
widget the clicked widget.
Returns:
true if the click was actually handled, i.e. do not show a tooltip if tooltip-on-right-click is enabled.

Reimplemented in DepotWindow, and SmallMapWindow.

Definition at line 629 of file window_gui.h.

Referenced by DispatchRightClickEvent().

virtual void Window::OnScroll ( Point  delta  )  [inline, virtual]

Handle the request for (viewport) scrolling.

Parameters:
delta the amount the viewport must be scrolled.

Reimplemented in MainWindow, SmallMapWindow, and ExtraViewportWindow.

Definition at line 656 of file window_gui.h.

Referenced by HandleViewportScroll().

virtual bool Window::OnVehicleSelect ( const struct Vehicle v  )  [inline, virtual]

The user clicked on a vehicle while HT_VEHICLE has been set.

Parameters:
v clicked vehicle. It is guaranteed to be v->IsPrimaryVehicle() == true
Returns:
True if the click is handled, false if it is ignored.

Definition at line 743 of file window_gui.h.

Referenced by VehicleClicked().

void Window::operator delete ( void *  ptr  )  [inline]

Helper allocation function to disallow something.

Don't free the window directly; it corrupts the linked list when iterating

Parameters:
ptr the pointer not to free

Reimplemented from ZeroedMemoryAllocator.

Definition at line 301 of file window_gui.h.

void* Window::operator new[] ( size_t  size  )  [inline]

Helper allocation function to disallow something.

Don't allow arrays; arrays of Windows are pointless as you need to destruct them all at the same time too, which is kinda hard.

Parameters:
size the amount of space not to allocate

Reimplemented from ZeroedMemoryAllocator.

Definition at line 291 of file window_gui.h.

void Window::ReInit ( int  rx = 0,
int  ry = 0 
)
bool Window::SetFocusedWidget ( int  widget_index  ) 

Set focus within this window to the given widget.

The function however doesn't change which window has focus.

Parameters:
widget_index Index of the widget in the window to set the focus to.
Returns:
Focus has changed.

Definition at line 462 of file window.cpp.

References _video_driver, VideoDriver::EditBoxLostFocus(), nested_array, nested_array_size, nested_focus, NWidgetBase::SetDirty(), NWidgetBase::type, and WWT_EDITBOX.

Referenced by DispatchLeftClickEvent(), NetworkChatWindow::NetworkChatWindow(), NetworkContentListWindow::NetworkContentListWindow(), FoundTownWindow::OnClick(), and OnHotkey().

void Window::SetShaded ( bool  make_shaded  ) 

Set the shaded state of the window to make_shaded.

Parameters:
make_shaded If true, shade the window (roll up until just the title bar is visible), else unshade/unroll the window to its original size.
Note:
The method uses Window::ReInit(), thus after the call, the whole window should be considered changed.

Definition at line 979 of file window.cpp.

References height, nested_focus, ReInit(), NWidgetStacked::SetDisplayedPlane(), shade_select, NWidgetStacked::shown_plane, SZSP_HORIZONTAL, UnfocusFocusedWidget(), unshaded_size, and width.

Referenced by BringWindowToFrontById(), DispatchLeftClickEvent(), DispatchMouseWheelEvent(), and CompanyFinancesWindow::OnClick().

virtual void Window::SetStringParameters ( int  widget  )  const [inline, virtual]

Initialize string parameters for a widget.

Calls to this function are made during initialization to measure the size (that is as part of InitNested()), during drawing, and while re-initializing the window. Only for widgets that render text initializing is requested.

Parameters:
widget Widget number.

Reimplemented in AIListWindow, AISettingsWindow, AIConfigWindow, AIDebugWindow, BuildAirportWindow, ReplaceVehicleWindow, BuildVehicleWindow, CompanyFinancesWindow, SelectCompanyLiveryWindow, CompanyInfrastructureWindow, CompanyWindow, BuyCompanyWindow, SetDateWindow, DepotWindow, GenerateLandscapeWindow, CreateScenarioWindow, GoalListWindow, GoalQuestionWindow, VehicleGroupWindow, BuildIndustryWindow, IndustryViewWindow, IndustryDirectoryWindow, IndustryCargoesWindow, AboutWindow, QueryStringWindow, QueryWindow, MusicTrackSelectionWindow, NetworkGameWindow, NetworkStartServerWindow, NetworkLobbyWindow, NewGRFInspectWindow, SpriteAlignerWindow, NewGRFParametersWindow, NewsWindow, BuildObjectWindow, OrdersWindow, OskWindow, BuildRailToolbarWindow, BuildRailStationWindow, BuildSignalWindow, GameOptionsWindow, GameSettingsWindow, CustomCurrencyWindow, SmallMapWindow, CompanyStationsWindow, StationViewWindow, StoryBookWindow, TimetableWindow, TownAuthorityWindow, TownViewWindow, TownDirectoryWindow, RefitWindow, VehicleListWindow, VehicleDetailsWindow, VehicleViewWindow, ExtraViewportWindow, and WaypointWindow.

Definition at line 586 of file window_gui.h.

Referenced by NWidgetLeaf::Draw(), NWidgetBackground::Draw(), NWidgetLeaf::SetupSmallestSize(), and NWidgetBackground::SetupSmallestSize().

void Window::SetWidgetDirty ( byte  widget_index  )  const

Invalidate a widget, i.e.

mark it as being changed and in need of redraw.

Parameters:
widget_index the widget to redraw.

Definition at line 555 of file window.cpp.

References nested_array, and NWidgetBase::SetDirty().

Referenced by IndustryDirectoryWindow::BuildSortIndustriesList(), VehicleGroupWindow::DirtyHighlightedGroupWidget(), DisableAllWidgetHighlight(), HandleButtonClick(), StationViewWindow::HandleCargoWaitingClick(), HandleEditBoxKey(), HandleZoomMessage(), InsertTextString(), RefitWindow::OnClick(), TransparenciesWindow::OnClick(), MusicWindow::OnClick(), IndustryCargoesWindow::OnClick(), SaveLoadWindow::OnClick(), DepotWindow::OnClick(), CompanyWindow::OnClick(), DepotWindow::OnCTRLStateChange(), OrdersWindow::OnDragDrop(), OnDropdownClose(), OskWindow::OnEditboxChanged(), StoryBookWindow::OnInvalidateData(), OskWindow::OnInvalidateData(), IndustryCargoesWindow::OnInvalidateData(), GoalListWindow::OnInvalidateData(), RefitWindow::OnMouseDrag(), OrdersWindow::OnMouseDrag(), DepotWindow::OnMouseDrag(), StoryBookWindow::OnPaint(), AIDebugWindow::OnPaint(), BuildRoadToolbarWindow::OnPlaceObjectAbort(), OrdersWindow::OnPlaceObjectAbort(), VehicleGroupWindow::OnPlaceObjectAbort(), DepotWindow::OnPlaceObjectAbort(), NetworkStartServerWindow::OnQueryTextFinished(), CreateScenarioWindow::OnQueryTextFinished(), GenerateLandscapeWindow::OnQueryTextFinished(), MainToolbarWindow::OnTick(), StatusBarWindow::OnTick(), ScenarioEditorToolbarWindow::OnTimeout(), MainToolbarWindow::OnTimeout(), ScenarioEditorLandscapeGenerationWindow::OnTimeout(), NetworkStartServerWindow::OnTimeout(), CreateScenarioWindow::OnTimeout(), GenerateLandscapeWindow::OnTimeout(), DepotWindow::OnTimeout(), OrdersWindow::OrderClick_Goto(), OrdersWindow::OrderClick_Nonstop(), OrdersWindow::OrderClick_Unload(), ProcessHighlightedInvalidations(), RaiseButtons(), StoryBookWindow::RefreshSelectedPage(), SetWidgetHighlight(), SetWindowWidgetDirty(), ShowDropDownList(), BuildBridgeWindow::SortBridgeList(), CompanyStationsWindow::SortStationsList(), ToggleRailButton_Remove(), ToggleRoadButton_Remove(), BuildRoadToolbarWindow::UpdateOptionWidgetStatus(), and StoryBookWindow::UpdatePrevNextDisabledState().

void Window::SetWidgetDisabledState ( byte  widget_index,
bool  disab_stat 
) [inline]

Sets the enabled/disabled status of a widget.

By default, widgets are enabled. On certain conditions, they have to be disabled.

Parameters:
widget_index index of this widget in the window
disab_stat status to use ie: disabled = true, enabled = false

Definition at line 388 of file window_gui.h.

References nested_array, and nested_array_size.

Referenced by AISettingsWindow::AISettingsWindow(), NetworkContentListWindow::BuildContentList(), DisableWidget(), EnableWidget(), HandleZoomMessage(), NetworkContentListWindow::NetworkContentListWindow(), RefitWindow::OnClick(), RefitWindow::OnInit(), WaypointWindow::OnInvalidateData(), StoryBookWindow::OnInvalidateData(), GameSettingsWindow::OnInvalidateData(), GameOptionsWindow::OnInvalidateData(), BuildSignalWindow::OnInvalidateData(), NewGRFWindow::OnInvalidateData(), NewGRFParametersWindow::OnInvalidateData(), NetworkContentListWindow::OnInvalidateData(), MusicTrackSelectionWindow::OnInvalidateData(), LinkGraphLegendWindow::OnInvalidateData(), PerformanceRatingDetailWindow::OnInvalidateData(), GenerateLandscapeWindow::OnInvalidateData(), SaveLoadWindow::OnInvalidateData(), CompanyWindow::OnInvalidateData(), AIDebugWindow::OnInvalidateData(), AIConfigWindow::OnInvalidateData(), VehicleDetailsWindow::OnPaint(), VehicleListWindow::OnPaint(), TownAuthorityWindow::OnPaint(), ScenarioEditorToolbarWindow::OnPaint(), MainToolbarWindow::OnPaint(), TimetableWindow::OnPaint(), StationViewWindow::OnPaint(), BuildRailStationWindow::OnPaint(), NetworkLobbyWindow::OnPaint(), NetworkGameWindow::OnPaint(), CreateScenarioWindow::OnPaint(), CompanyWindow::OnPaint(), SelectCompanyLiveryWindow::OnPaint(), CompanyFinancesWindow::OnPaint(), BuildIndustryWindow::SetButtons(), TextfileWindow::SetupScrollbars(), SetWidgetsDisabledState(), SmallMapWindow::SetZoomLevel(), BuildRoadToolbarWindow::UpdateOptionWidgetStatus(), OskWindow::UpdateOskState(), and StoryBookWindow::UpdatePrevNextDisabledState().

void Window::SetWidgetHighlight ( byte  widget_index,
TextColour  highlighted_colour 
)

Sets the highlighted status of a widget.

Parameters:
widget_index index of this widget in the window
highlighted_colour Colour of highlight, or TC_INVALID to disable.

Definition at line 208 of file window.cpp.

References CLRBITS, flags, nested_array_size, SetWidgetDirty(), valid, and WF_HIGHLIGHTED.

Referenced by DispatchLeftClickEvent().

void CDECL Window::SetWidgetsDisabledState ( bool  disab_stat,
int  widgets,
  ... 
)
void CDECL Window::SetWidgetsLoweredState ( bool  lowered_stat,
int  widgets,
  ... 
)

Sets the lowered/raised status of a list of widgets.

Parameters:
lowered_stat status to use ie: lowered = true, raised = false
widgets list of widgets ended by WIDGET_LIST_END

Definition at line 513 of file window.cpp.

References SetWidgetLoweredState(), and WIDGET_LIST_END.

Referenced by SelectCompanyManagerFaceWindow::OnPaint(), ScenarioEditorToolbarWindow::OnTimeout(), and BuildRoadToolbarWindow::UpdateOptionWidgetStatus().

virtual void Window::ShowNewGRFInspectWindow (  )  const [inline, virtual]

Show the NewGRF inspection window.

When this function is called it is up to the window to call and pass the right parameters to the ShowInspectWindow function.

Precondition:
this->IsNewGRFInspectable()

Reimplemented in IndustryViewWindow, LandInfoWindow, and VehicleViewWindow.

Definition at line 794 of file window_gui.h.

Referenced by DispatchLeftClickEvent().

void Window::ToggleWidgetLoweredState ( byte  widget_index  )  [inline]
void Window::UnfocusFocusedWidget (  ) 

Makes no widget on this window have focus.

The function however doesn't change which window has focus.

Definition at line 446 of file window.cpp.

References _video_driver, VideoDriver::EditBoxLostFocus(), nested_focus, NWidgetBase::SetDirty(), NWidgetBase::type, and WWT_EDITBOX.

Referenced by HandleEditBoxKey(), and SetShaded().

virtual void Window::UpdateWidgetSize ( int  widget,
Dimension size,
const Dimension padding,
Dimension fill,
Dimension resize 
) [inline, virtual]

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.
size Size of the widget.
padding Recommended amount of space between the widget content and the widget edge.
fill Fill step of the widget.
resize Resize step of the widget.

Reimplemented in AIListWindow, AISettingsWindow, AIConfigWindow, AIDebugWindow, BuildAirportWindow, ReplaceVehicleWindow, BuildBridgeWindow, BuildVehicleWindow, CheatWindow, CompanyFinancesWindow, SelectCompanyLiveryWindow, SelectCompanyManagerFaceWindow, CompanyInfrastructureWindow, CompanyWindow, BuyCompanyWindow, SetDateWindow, DepotWindow, EnginePreviewWindow, SaveLoadWindow, GenerateLandscapeWindow, CreateScenarioWindow, GenerateProgressWindow, GoalListWindow, GoalQuestionWindow, BaseGraphWindow, PaymentRatesGraphWindow, CompanyLeagueWindow, PerformanceRatingDetailWindow, VehicleGroupWindow, BuildIndustryWindow, IndustryViewWindow, IndustryDirectoryWindow, IndustryCargoesWindow, SelectGameWindow, LinkGraphLegendWindow, LandInfoWindow, AboutWindow, TooltipsWindow, QueryStringWindow, QueryWindow, MusicTrackSelectionWindow, MusicWindow, NetworkChatWindow, NetworkGameWindow, NetworkStartServerWindow, NetworkLobbyWindow, NetworkClientListPopupWindow, NetworkClientListWindow, NetworkJoinStatusWindow, NewGRFInspectWindow, SpriteAlignerWindow, NewGRFParametersWindow, ScanProgressWindow, NewsWindow, MessageHistoryWindow, BuildObjectWindow, OrdersWindow, BuildRailStationWindow, BuildSignalWindow, BuildRailWaypointWindow, GameOptionsWindow, GameSettingsWindow, CustomCurrencyWindow, CompanyStationsWindow, StationViewWindow, SelectStationWindow< T >, StatusBarWindow, StoryBookWindow, SubsidyListWindow, TimetableWindow, ScenarioEditorToolbarWindow, TownAuthorityWindow, TownViewWindow, TownDirectoryWindow, BuildTreesWindow, RefitWindow, VehicleListWindow, VehicleDetailsWindow, and VehicleViewWindow.

Definition at line 578 of file window_gui.h.

Referenced by NWidgetLeaf::SetupSmallestSize(), NWidgetBackground::SetupSmallestSize(), NWidgetMatrix::SetupSmallestSize(), and NWidgetStacked::SetupSmallestSize().


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