OpenTTD
|
Public Member Functions | |
StatusBarWindow (WindowDesc *desc) | |
virtual Point | OnInitialPosition (int16 sm_width, int16 sm_height, int window_number) |
Compute the initial position of the window. | |
virtual void | FindWindowPlacementAndResize (int def_width, int def_height) |
Resize window towards the default size. | |
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 | DrawWidget (const Rect &r, int widget) const |
Draw the contents of a nested widget. | |
virtual void | OnInvalidateData (int data=0, bool gui_scope=true) |
Some data on this window has become invalid. | |
virtual void | OnClick (Point pt, int widget, int click_count) |
A click with the left mouse button has been made on the window. | |
virtual void | OnTick () |
Called once per (game) tick. | |
![]() | |
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 Scrollbar * | GetScrollbar (uint widnum) const |
Return the Scrollbar to a widget index. | |
Scrollbar * | GetScrollbar (uint widnum) |
Return the Scrollbar to a widget index. | |
const QueryString * | GetQueryString (uint widnum) const |
Return the querystring associated to a editbox. | |
QueryString * | GetQueryString (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 void | OnPaint () |
The window must be repainted. | |
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 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 | 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 | 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. | |
![]() | |
void * | operator new (size_t size) |
Memory allocator for a single class instance. | |
void | operator delete[] (void *ptr) |
Memory release for an array of class instances. |
Data Fields | |
bool | saving |
int | ticker_scroll |
int | reminder_timeout |
![]() | |
WindowDesc * | window_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. | |
ViewportData * | viewport |
Pointer to viewport data, if present. | |
const NWidgetCore * | nested_focus |
Currently focused nested widget, or NULL if no nested widget has focus. | |
SmallMap< int, QueryString * > | querystrings |
QueryString associated to WWT_EDITBOX widgets. | |
NWidgetBase * | nested_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. | |
NWidgetStacked * | shade_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. | |
Window * | parent |
Parent window. | |
Window * | z_front |
The window in front of us in z-order. | |
Window * | z_back |
The window behind us in z-order. |
Static Public Attributes | |
static const int | TICKER_STOP = 1640 |
scrolling is finished when counter reaches this value | |
static const int | REMINDER_START = 91 |
initial value of the reminder counter (right dot on the right) | |
static const int | REMINDER_STOP = 0 |
reminder disappears when counter reaches this value | |
static const int | COUNTER_STEP = 2 |
this is subtracted from active counters every tick |
Additional Inherited Members | |
![]() | |
static int | SortButtonWidth () |
Get width of up/down arrow of sort button state. | |
![]() | |
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. | |
![]() | |
SmallVector< int, 4 > | scheduled_invalidation_data |
Data of scheduled OnInvalidateData() calls. |
Definition at line 79 of file statusbar_gui.cpp.
|
inlinevirtual |
Draw the contents of a nested widget.
r | Rectangle occupied by the widget. |
widget | Number of the widget to draw. |
Reimplemented from Window.
Definition at line 137 of file statusbar_gui.cpp.
References _date, _do_autosave, _local_company, _pause_mode, DrawSprite(), DrawString(), FindWindowById(), FONT_HEIGHT_NORMAL, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::GetIfValid(), GetSpriteSize(), InvalidateWindowData(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::IsValidID(), CompanyProperties::money, PM_UNPAUSED, SA_HOR_CENTER, SBI_NEWS_DELETED, SetDParam(), NewsItem::string_id, TICKER_STOP, WC_NEWS_WINDOW, WC_STATUS_BAR, WD_FRAMERECT_LEFT, WD_FRAMERECT_RIGHT, WD_FRAMERECT_TOP, WID_S_LEFT, WID_S_MIDDLE, and WID_S_RIGHT.
|
inlinevirtual |
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.
def_width | default width in pixels of the window |
def_height | default height in pixels of the window |
Reimplemented from Window.
Definition at line 105 of file statusbar_gui.cpp.
References _toolbar_width.
|
inlinevirtual |
A click with the left mouse button has been made on the window.
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 211 of file statusbar_gui.cpp.
References _local_company, COMPANY_SPECTATOR, ResetObjectToPlace(), ShowCompanyFinances(), ShowLastNewsMessage(), WID_S_MIDDLE, and WID_S_RIGHT.
|
inlinevirtual |
Compute the initial position of the window.
sm_width | Smallest width of the window. |
sm_height | Smallest height of the window. |
window_number | The window number of the new window. |
Reimplemented from Window.
Definition at line 99 of file statusbar_gui.cpp.
|
inlinevirtual |
Some data on this window has become invalid.
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 195 of file statusbar_gui.cpp.
References REMINDER_START, REMINDER_STOP, SBI_NEWS_DELETED, SBI_SAVELOAD_FINISH, SBI_SAVELOAD_START, SBI_SHOW_REMINDER, SBI_SHOW_TICKER, and TICKER_STOP.
|
inlinevirtual |
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.
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 from Window.
Definition at line 110 of file statusbar_gui.cpp.
References DAYS_IN_YEAR, GetStringBoundingBox(), MAX_YEAR, maxdim(), CompanyProperties::money, SetDParam(), SetDParamMaxValue(), WID_S_LEFT, and WID_S_RIGHT.