tron@2186: /* $Id$ */ tron@2186: rubidium@9111: /** @file window.cpp Windowing system, widgets and events */ belugas@6117: truelight@0: #include "stdafx.h" glx@4755: #include Darkvater@1891: #include "openttd.h" tron@1299: #include "debug.h" rubidium@8254: #include "player_func.h" rubidium@8224: #include "gfx_func.h" dominik@126: #include "console.h" rubidium@8224: #include "viewport_func.h" tron@2159: #include "variables.h" truelight@4300: #include "genworld.h" truelight@6937: #include "blitter/factory.hpp" rubidium@8106: #include "window_gui.h" rubidium@8123: #include "zoom_func.h" rubidium@8130: #include "core/alloc_func.hpp" rubidium@8139: #include "map_func.h" rubidium@8144: #include "vehicle_base.h" rubidium@8270: #include "settings_type.h" rubidium@8965: #include "cheat_func.h" rubidium@9117: #include "window_func.h" rubidium@9127: #include "tilehighlight_func.h" truelight@0: rubidium@8264: #include "table/sprites.h" rubidium@8264: rubidium@8924: static Point _drag_delta; ///< delta between mouse cursor and upper left corner of dragged window rubidium@8924: static Window *_mouseover_last_w = NULL; ///< Window of the last MOUSEOVER event tron@350: rubidium@8857: /** rubidium@8857: * List of windows opened at the screen. rubidium@8857: * Uppermost window is at _z_windows[_last_z_window - 1], rubidium@8857: * bottom window is at _z_windows[0] rubidium@8857: */ rubidium@8925: Window *_z_windows[MAX_NUMBER_OF_WINDOWS]; Darkvater@5126: Window **_last_z_window; ///< always points to the next free space in the z-array Darkvater@5124: rubidium@8268: Point _cursorpos_drag_start; rubidium@8268: rubidium@8268: int _scrollbar_start_pos; rubidium@8268: int _scrollbar_size; rubidium@8268: byte _scroller_click_timeout; rubidium@8268: rubidium@8268: bool _scrolling_scrollbar; rubidium@8268: bool _scrolling_viewport; rubidium@8268: rubidium@8268: byte _special_mouse_mode; rubidium@8268: rubidium@8268: rubidium@9082: /** rubidium@9166: * Call the window event handler for handling event \a e. rubidium@9166: * This is a temporary helper functions that will be removed rubidium@9166: * once all windows that still rely on WindowEvent and rubidium@9166: * WindowEventCodes have been rewritten to use the 'OnXXX' rubidium@9166: * event handlers. rubidium@9082: * @param e Window event to handle rubidium@9082: */ rubidium@9082: void Window::HandleWindowEvent(WindowEvent *e) rubidium@9082: { rubidium@9082: if (wndproc != NULL) wndproc(this, e); rubidium@9082: } rubidium@9082: rubidium@9166: void Window::OnPaint() rubidium@9166: { rubidium@9166: WindowEvent e; rubidium@9166: e.event = WE_PAINT; rubidium@9166: this->HandleWindowEvent(&e); rubidium@9166: } rubidium@9166: rubidium@9285: Window::EventState Window::OnKeyPress(uint16 key, uint16 keycode) rubidium@9166: { rubidium@9166: WindowEvent e; rubidium@9166: e.event = WE_KEYPRESS; rubidium@9166: e.we.keypress.key = key; rubidium@9166: e.we.keypress.keycode = keycode; rubidium@9166: e.we.keypress.cont = true; rubidium@9166: this->HandleWindowEvent(&e); rubidium@9166: rubidium@9285: return e.we.keypress.cont ? ES_NOT_HANDLED : ES_HANDLED; rubidium@9166: } rubidium@9166: rubidium@9285: Window::EventState Window::OnCTRLStateChange() rubidium@9166: { rubidium@9166: WindowEvent e; rubidium@9166: e.event = WE_CTRL_CHANGED; rubidium@9166: e.we.ctrl.cont = true; rubidium@9166: this->HandleWindowEvent(&e); rubidium@9166: rubidium@9285: return e.we.ctrl.cont ? ES_NOT_HANDLED : ES_HANDLED; rubidium@9166: } rubidium@9166: rubidium@9166: void Window::OnClick(Point pt, int widget) rubidium@9166: { rubidium@9166: WindowEvent e; rubidium@9166: e.event = WE_CLICK; rubidium@9166: e.we.click.pt = pt; rubidium@9166: e.we.click.widget = widget; rubidium@9166: this->HandleWindowEvent(&e); rubidium@9166: } rubidium@9166: rubidium@9166: void Window::OnMouseLoop() rubidium@9166: { rubidium@9166: WindowEvent e; rubidium@9166: e.event = WE_MOUSELOOP; rubidium@9166: this->HandleWindowEvent(&e); rubidium@9166: } rubidium@9166: rubidium@9166: void Window::OnTick() rubidium@9166: { rubidium@9166: WindowEvent e; rubidium@9166: e.event = WE_TICK; rubidium@9166: this->HandleWindowEvent(&e); rubidium@9166: } rubidium@9166: rubidium@9166: void Window::OnHundredthTick() rubidium@9166: { rubidium@9166: WindowEvent e; rubidium@9166: e.event = WE_100_TICKS; rubidium@9166: this->HandleWindowEvent(&e); rubidium@9166: } rubidium@9166: rubidium@9166: void Window::OnTimeout() rubidium@9166: { rubidium@9166: WindowEvent e; rubidium@9166: e.event = WE_TIMEOUT; rubidium@9166: this->HandleWindowEvent(&e); rubidium@9166: } rubidium@9166: rubidium@9166: void Window::OnResize(Point new_size, Point delta) rubidium@9166: { rubidium@9166: WindowEvent e; rubidium@9166: e.event = WE_RESIZE; rubidium@9166: e.we.sizing.size = new_size; rubidium@9166: e.we.sizing.diff = delta; rubidium@9166: this->HandleWindowEvent(&e); rubidium@9166: } rubidium@9166: rubidium@9166: void Window::OnDropdownSelect(int widget, int index) rubidium@9166: { rubidium@9166: WindowEvent e; rubidium@9166: e.event = WE_DROPDOWN_SELECT; rubidium@9166: e.we.dropdown.button = widget; rubidium@9166: e.we.dropdown.index = index; rubidium@9166: this->HandleWindowEvent(&e); rubidium@9166: } rubidium@9166: rubidium@9166: void Window::OnQueryTextFinished(char *str) rubidium@9166: { rubidium@9166: WindowEvent e; rubidium@9166: e.event = WE_ON_EDIT_TEXT; rubidium@9166: e.we.edittext.str = str; rubidium@9166: this->HandleWindowEvent(&e); rubidium@9166: } rubidium@9166: rubidium@9166: void Window::OnInvalidateData(int data) rubidium@9166: { rubidium@9166: WindowEvent e; rubidium@9166: e.event = WE_INVALIDATE_DATA; rubidium@9166: e.we.invalidate.data = data; rubidium@9166: this->HandleWindowEvent(&e); rubidium@9166: } rubidium@9166: rubidium@9166: void Window::OnPlaceObject(Point pt, TileIndex tile) rubidium@9166: { rubidium@9166: WindowEvent e; rubidium@9166: e.event = WE_PLACE_OBJ; rubidium@9166: e.we.place.pt = pt; rubidium@9166: e.we.place.tile = tile; rubidium@9166: this->HandleWindowEvent(&e); rubidium@9166: } rubidium@9166: rubidium@9166: void Window::OnPlaceObjectAbort() rubidium@9166: { rubidium@9166: WindowEvent e; rubidium@9166: e.event = WE_ABORT_PLACE_OBJ; rubidium@9166: this->HandleWindowEvent(&e); rubidium@9166: } rubidium@9166: rubidium@9166: rubidium@9166: void Window::OnPlaceDrag(ViewportPlaceMethod select_method, byte select_proc, Point pt) rubidium@9166: { rubidium@9166: WindowEvent e; rubidium@9166: e.event = WE_PLACE_DRAG; rubidium@9166: e.we.place.select_method = select_method; rubidium@9166: e.we.place.select_proc = select_proc; rubidium@9166: e.we.place.pt = pt; rubidium@9166: this->HandleWindowEvent(&e); rubidium@9166: } rubidium@9166: rubidium@9166: void Window::OnPlaceMouseUp(ViewportPlaceMethod select_method, byte select_proc, Point pt, TileIndex start_tile, TileIndex end_tile) rubidium@9166: { rubidium@9166: WindowEvent e; rubidium@9166: e.event = WE_PLACE_MOUSEUP; rubidium@9166: e.we.place.select_method = select_method; rubidium@9166: e.we.place.select_proc = select_proc; rubidium@9166: e.we.place.pt = pt; rubidium@9166: e.we.place.tile = end_tile; rubidium@9166: e.we.place.starttile = start_tile; rubidium@9166: this->HandleWindowEvent(&e); rubidium@9166: } rubidium@9166: rubidium@9166: void Window::OnPlacePresize(Point pt, TileIndex tile) rubidium@9166: { rubidium@9166: WindowEvent e; rubidium@9166: e.event = WE_PLACE_PRESIZE; rubidium@9166: e.we.place.pt = pt; rubidium@9166: e.we.place.tile = tile; rubidium@9166: this->HandleWindowEvent(&e); rubidium@9166: } rubidium@9166: rubidium@9166: rubidium@9166: belugas@7993: void CDECL Window::SetWidgetsDisabledState(bool disab_stat, int widgets, ...) belugas@7993: { belugas@7993: va_list wdg_list; belugas@7993: belugas@7993: va_start(wdg_list, widgets); belugas@7993: belugas@7993: while (widgets != WIDGET_LIST_END) { belugas@7993: SetWidgetDisabledState(widgets, disab_stat); belugas@7993: widgets = va_arg(wdg_list, int); belugas@7993: } belugas@7993: belugas@7993: va_end(wdg_list); belugas@7993: } belugas@7993: belugas@7993: void CDECL Window::SetWidgetsHiddenState(bool hidden_stat, int widgets, ...) belugas@7993: { belugas@7993: va_list wdg_list; belugas@7993: belugas@7993: va_start(wdg_list, widgets); belugas@7993: belugas@7993: while (widgets != WIDGET_LIST_END) { belugas@7993: SetWidgetHiddenState(widgets, hidden_stat); belugas@7993: widgets = va_arg(wdg_list, int); belugas@7993: } belugas@7993: belugas@7993: va_end(wdg_list); belugas@7993: } belugas@7993: belugas@7993: void CDECL Window::SetWidgetsLoweredState(bool lowered_stat, int widgets, ...) belugas@7993: { belugas@7993: va_list wdg_list; belugas@7993: belugas@7993: va_start(wdg_list, widgets); belugas@7993: belugas@7993: while (widgets != WIDGET_LIST_END) { belugas@7993: SetWidgetLoweredState(widgets, lowered_stat); belugas@7993: widgets = va_arg(wdg_list, int); belugas@7993: } belugas@7993: belugas@7993: va_end(wdg_list); belugas@7993: } belugas@7993: belugas@7993: void Window::RaiseButtons() belugas@7993: { rubidium@9124: for (uint i = 0; i < this->widget_count; i++) { belugas@8032: if (this->IsWidgetLowered(i)) { belugas@8032: this->RaiseWidget(i); belugas@8032: this->InvalidateWidget(i); belugas@7993: } belugas@7993: } belugas@7993: } belugas@7993: glx@8026: void Window::InvalidateWidget(byte widget_index) const belugas@7993: { belugas@7993: const Widget *wi = &this->widget[widget_index]; belugas@7993: belugas@7993: /* Don't redraw the window if the widget is invisible or of no-type */ belugas@7993: if (wi->type == WWT_EMPTY || IsWidgetHidden(widget_index)) return; belugas@7993: belugas@7993: SetDirtyBlocks(this->left + wi->left, this->top + wi->top, this->left + wi->right + 1, this->top + wi->bottom + 1); belugas@7993: } belugas@7993: belugas@8035: void Window::HandleButtonClick(byte widget) belugas@8035: { belugas@8035: this->LowerWidget(widget); belugas@8035: this->flags4 |= 5 << WF_TIMEOUT_SHL; belugas@8035: this->InvalidateWidget(widget); belugas@8035: } belugas@8035: Darkvater@5124: static void StartWindowDrag(Window *w); Darkvater@5124: static void StartWindowSizing(Window *w); tron@2817: rubidium@8857: /** rubidium@8857: * Dispatch left mouse-button (possibly double) click in window. rubidium@8857: * @param w Window to dispatch event in rubidium@8857: * @param x X coordinate of the click rubidium@8857: * @param y Y coordinate of the click rubidium@8857: * @param double_click Was it a double click? rubidium@8857: */ truelight@7009: static void DispatchLeftClickEvent(Window *w, int x, int y, bool double_click) tron@2596: { rubidium@9166: int widget = 0; truelight@0: if (w->desc_flags & WDF_DEF_WIDGET) { rubidium@9166: widget = GetWidgetFromPos(w, x, y); rubidium@9166: if (widget < 0) return; // exit if clicked outside of widgets truelight@158: rubidium@5236: /* don't allow any interaction if the button has been disabled */ rubidium@9166: if (w->IsWidgetDisabled(widget)) return; darkvater@222: rubidium@9166: const Widget *wi = &w->widget[widget]; truelight@0: Darkvater@4938: if (wi->type & WWB_MASK) { darkvater@211: /* special widget handling for buttons*/ tron@2952: switch (wi->type) { Darkvater@4938: case WWT_PANEL | WWB_PUSHBUTTON: /* WWT_PUSHBTN */ Darkvater@4938: case WWT_IMGBTN | WWB_PUSHBUTTON: /* WWT_PUSHIMGBTN */ Darkvater@4938: case WWT_TEXTBTN | WWB_PUSHBUTTON: /* WWT_PUSHTXTBTN */ rubidium@9166: w->HandleButtonClick(widget); Darkvater@4938: break; truelight@0: } bjarni@842: } else if (wi->type == WWT_SCROLLBAR || wi->type == WWT_SCROLL2BAR || wi->type == WWT_HSCROLLBAR) { rubidium@9166: ScrollbarClickHandler(w, wi, x, y); truelight@0: } truelight@0: truelight@0: if (w->desc_flags & WDF_STD_BTN) { rubidium@9166: if (widget == 0) { /* 'X' */ rubidium@9115: delete w; celestar@984: return; tron@1109: } tron@1109: rubidium@9166: if (widget == 1) { /* 'Title bar' */ Darkvater@5124: StartWindowDrag(w); darkvater@1112: return; darkvater@1112: } truelight@0: } truelight@867: darkvater@1112: if (w->desc_flags & WDF_RESIZABLE && wi->type == WWT_RESIZEBOX) { Darkvater@5124: StartWindowSizing(w); rubidium@9166: w->InvalidateWidget(widget); darkvater@1112: return; darkvater@1112: } truelight@867: truelight@867: if (w->desc_flags & WDF_STICKY_BUTTON && wi->type == WWT_STICKYBOX) { truelight@867: w->flags4 ^= WF_STICKY; rubidium@9166: w->InvalidateWidget(widget); darkvater@1112: return; darkvater@682: } truelight@0: } darkvater@1038: rubidium@9166: Point pt = { x, y }; rubidium@9166: rubidium@9166: if (double_click) { rubidium@9166: w->OnDoubleClick(pt, widget); rubidium@9166: } else { rubidium@9166: w->OnClick(pt, widget); rubidium@9166: } truelight@0: } truelight@0: rubidium@8857: /** rubidium@8857: * Dispatch right mouse-button click in window. rubidium@8857: * @param w Window to dispatch event in rubidium@8857: * @param x X coordinate of the click rubidium@8857: * @param y Y coordinate of the click rubidium@8857: */ belugas@4171: static void DispatchRightClickEvent(Window *w, int x, int y) tron@2596: { rubidium@9166: int widget = 0; truelight@0: truelight@0: /* default tooltips handler? */ truelight@0: if (w->desc_flags & WDF_STD_TOOLTIPS) { rubidium@9166: widget = GetWidgetFromPos(w, x, y); rubidium@9166: if (widget < 0) return; // exit if clicked outside of widgets truelight@0: rubidium@9166: if (w->widget[widget].tooltips != 0) { rubidium@9166: GuiShowTooltips(w->widget[widget].tooltips); truelight@0: return; truelight@0: } truelight@0: } truelight@0: rubidium@9166: Point pt = { x, y }; rubidium@9166: w->OnRightClick(pt, widget); truelight@0: } truelight@0: rubidium@8857: /** rubidium@8857: * Dispatch the mousewheel-action to the window. rubidium@8857: * The window will scroll any compatible scrollbars if the mouse is pointed over the bar or its contents rubidium@8857: * @param w Window Darkvater@2021: * @param widget the widget where the scrollwheel was used Darkvater@2021: * @param wheel scroll up or down Darkvater@2021: */ belugas@4171: static void DispatchMouseWheelEvent(Window *w, int widget, int wheel) truelight@0: { Darkvater@2021: if (widget < 0) return; Darkvater@2021: rubidium@9124: const Widget *wi1 = &w->widget[widget]; rubidium@9124: const Widget *wi2 = &w->widget[widget + 1]; Darkvater@2021: darkvater@982: /* The listbox can only scroll if scrolling was done on the scrollbar itself, tron@1019: * or on the listbox (and the next item is (must be) the scrollbar) darkvater@982: * XXX - should be rewritten as a widget-dependent scroller but that's darkvater@982: * not happening until someone rewrites the whole widget-code */ rubidium@9124: Scrollbar *sb; tron@1019: if ((sb = &w->vscroll, wi1->type == WWT_SCROLLBAR) || (sb = &w->vscroll2, wi1->type == WWT_SCROLL2BAR) || darkvater@982: (sb = &w->vscroll2, wi2->type == WWT_SCROLL2BAR) || (sb = &w->vscroll, wi2->type == WWT_SCROLLBAR) ) { darkvater@982: darkvater@982: if (sb->count > sb->cap) { skidd13@7922: int pos = Clamp(sb->pos + wheel, 0, sb->count - sb->cap); darkvater@982: if (pos != sb->pos) { darkvater@982: sb->pos = pos; rubidium@9116: w->SetDirty(); darkvater@982: } truelight@0: } truelight@0: } truelight@0: } truelight@0: rubidium@8857: /** rubidium@8857: * Generate repaint events for the visible part of window *wz within the rectangle. rubidium@8857: * rubidium@8857: * The function goes recursively upwards in the window stack, and splits the rectangle rubidium@8857: * into multiple pieces at the window edges, so obscured parts are not redrawn. rubidium@8857: * rubidium@8857: * @param wz Pointer into window stack, pointing at the window that needs to be repainted rubidium@8857: * @param left Left edge of the rectangle that should be repainted rubidium@8857: * @param top Top edge of the rectangle that should be repainted rubidium@8857: * @param right Right edge of the rectangle that should be repainted rubidium@8857: * @param bottom Bottom edge of the rectangle that should be repainted rubidium@8857: */ Darkvater@5124: static void DrawOverlappedWindow(Window* const *wz, int left, int top, int right, int bottom) truelight@0: { Darkvater@5137: Window* const *vz = wz; truelight@0: Darkvater@5124: while (++vz != _last_z_window) { Darkvater@5124: const Window *v = *vz; Darkvater@5124: truelight@0: if (right > v->left && tron@2026: bottom > v->top && truelight@0: left < v->left + v->width && truelight@0: top < v->top + v->height) { rubidium@8857: /* v and rectangle intersect with eeach other */ rubidium@8857: int x; rubidium@8857: rubidium@6491: if (left < (x = v->left)) { Darkvater@5124: DrawOverlappedWindow(wz, left, top, x, bottom); Darkvater@5124: DrawOverlappedWindow(wz, x, top, right, bottom); truelight@0: return; truelight@0: } truelight@0: rubidium@6491: if (right > (x = v->left + v->width)) { Darkvater@5124: DrawOverlappedWindow(wz, left, top, x, bottom); Darkvater@5124: DrawOverlappedWindow(wz, x, top, right, bottom); truelight@0: return; truelight@0: } truelight@0: rubidium@6491: if (top < (x = v->top)) { Darkvater@5124: DrawOverlappedWindow(wz, left, top, right, x); Darkvater@5124: DrawOverlappedWindow(wz, left, x, right, bottom); truelight@0: return; truelight@0: } truelight@0: rubidium@6491: if (bottom > (x = v->top + v->height)) { Darkvater@5124: DrawOverlappedWindow(wz, left, top, right, x); Darkvater@5124: DrawOverlappedWindow(wz, left, x, right, bottom); truelight@0: return; truelight@0: } truelight@0: truelight@0: return; truelight@0: } truelight@0: } truelight@0: rubidium@8992: /* Setup blitter, and dispatch a repaint event to window *wz */ rubidium@8922: DrawPixelInfo *dp = _cur_dpi; rubidium@8922: dp->width = right - left; rubidium@8922: dp->height = bottom - top; rubidium@8922: dp->left = left - (*wz)->left; rubidium@8922: dp->top = top - (*wz)->top; rubidium@8922: dp->pitch = _screen.pitch; rubidium@8922: dp->dst_ptr = BlitterFactoryBase::GetCurrentBlitter()->MoveTo(_screen.dst_ptr, left, top); rubidium@8922: dp->zoom = ZOOM_LVL_NORMAL; rubidium@9166: (*wz)->OnPaint(); rubidium@8922: } rubidium@8922: rubidium@8922: /** rubidium@8922: * From a rectangle that needs redrawing, find the windows that intersect with the rectangle. rubidium@8922: * These windows should be re-painted. rubidium@8922: * @param left Left edge of the rectangle that should be repainted rubidium@8922: * @param top Top edge of the rectangle that should be repainted rubidium@8922: * @param right Right edge of the rectangle that should be repainted rubidium@8922: * @param bottom Bottom edge of the rectangle that should be repainted rubidium@8922: */ rubidium@8922: void DrawOverlappedWindowForAll(int left, int top, int right, int bottom) rubidium@8922: { rubidium@8922: Window* const *wz; rubidium@8922: DrawPixelInfo bk; rubidium@8922: _cur_dpi = &bk; rubidium@8922: rubidium@8922: FOR_ALL_WINDOWS(wz) { rubidium@8922: const Window *w = *wz; rubidium@8922: if (right > w->left && rubidium@8922: bottom > w->top && rubidium@8922: left < w->left + w->width && rubidium@8922: top < w->top + w->height) { rubidium@8992: /* Window w intersects with the rectangle => needs repaint */ rubidium@8922: DrawOverlappedWindow(wz, left, top, right, bottom); rubidium@8922: } truelight@0: } truelight@0: } truelight@0: rubidium@8857: /** rubidium@8857: * Mark entire window as dirty (in need of re-paint) rubidium@8857: * @param w Window to redraw rubidium@8857: * @ingroup dirty rubidium@8857: */ rubidium@9115: void Window::SetDirty() const rubidium@9115: { rubidium@9115: SetDirtyBlocks(this->left, this->top, this->left + this->width, this->top + this->height); rubidium@9115: } rubidium@9115: rubidium@9115: /** rubidium@9115: * Mark entire window as dirty (in need of re-paint) rubidium@9115: * @param w Window to redraw rubidium@9115: * @ingroup dirty rubidium@9115: */ belugas@4171: void SetWindowDirty(const Window *w) truelight@0: { rubidium@9115: if (w != NULL) w->SetDirty(); truelight@0: } truelight@0: Darkvater@5415: /** Find the Window whose parent pointer points to this window belugas@6443: * @param w parent Window to find child of belugas@6443: * @return a Window pointer that is the child of w, or NULL otherwise */ Darkvater@5415: static Window *FindChildWindow(const Window *w) Darkvater@5415: { Darkvater@5415: Window* const *wz; Darkvater@5415: Darkvater@5415: FOR_ALL_WINDOWS(wz) { Darkvater@5415: Window *v = *wz; Darkvater@5415: if (v->parent == w) return v; Darkvater@5415: } Darkvater@5415: Darkvater@5415: return NULL; Darkvater@5415: } Darkvater@5415: Darkvater@5124: /** Find the z-value of a window. A window must already be open belugas@6443: * or the behaviour is undefined but function should never fail belugas@6443: * @param w window to query Z Position rubidium@8857: * @return Pointer into the window-list at the position of \a w rubidium@8857: */ Darkvater@5124: Window **FindWindowZPosition(const Window *w) Darkvater@5124: { Darkvater@5124: Window **wz; Darkvater@5124: rubidium@8857: FOR_ALL_WINDOWS(wz) { Darkvater@5124: if (*wz == w) return wz; Darkvater@5124: } Darkvater@5429: rubidium@5587: DEBUG(misc, 3, "Window (cls %d, number %d) is not open, probably removed by recursive calls", Darkvater@5429: w->window_class, w->window_number); Darkvater@5429: return NULL; Darkvater@5124: } Darkvater@5124: rubidium@8857: /** rubidium@8992: * Remove window and all its child windows from the window stack. rubidium@8857: */ rubidium@9115: Window::~Window() truelight@0: { tron@4077: if (_thd.place_mode != VHM_NONE && rubidium@9115: _thd.window_class == this->window_class && rubidium@9115: _thd.window_number == this->window_number) { truelight@0: ResetObjectToPlace(); truelight@0: } truelight@0: rubidium@9083: /* Prevent Mouseover() from resetting mouse-over coordinates on a non-existing window */ rubidium@9115: if (_mouseover_last_w == this) _mouseover_last_w = NULL; rubidium@9083: rubidium@9083: /* Find the window in the z-array, and effectively remove it rubidium@9083: * by moving all windows after it one to the left. This must be rubidium@9083: * done before removing the child so we cannot cause recursion rubidium@9083: * between the deletion of the parent and the child. */ rubidium@9115: Window **wz = FindWindowZPosition(this); rubidium@9083: if (wz == NULL) return; rubidium@9083: memmove(wz, wz + 1, (byte*)_last_z_window - (byte*)wz); rubidium@9083: _last_z_window--; rubidium@9083: rubidium@9233: /* Delete all children a window might have in a head-recursive manner */ rubidium@9233: Window *child = FindChildWindow(this); rubidium@9233: while (child != NULL) { rubidium@9233: delete child; rubidium@9233: child = FindChildWindow(this); rubidium@9233: } truelight@0: rubidium@9166: WindowEvent e; rubidium@9166: e.event = WE_DESTROY; rubidium@9166: this->HandleWindowEvent(&e); rubidium@9115: if (this->viewport != NULL) DeleteWindowViewport(this); truelight@867: rubidium@9115: this->SetDirty(); rubidium@9115: free(this->widget); truelight@0: } truelight@0: rubidium@8857: /** rubidium@8857: * Find a window by its class and window number rubidium@8857: * @param cls Window class rubidium@8857: * @param number Number of the window within the window class rubidium@8857: * @return Pointer to the found window, or \c NULL if not available rubidium@8857: */ truelight@0: Window *FindWindowById(WindowClass cls, WindowNumber number) truelight@0: { Darkvater@5124: Window* const *wz; truelight@0: Darkvater@5124: FOR_ALL_WINDOWS(wz) { Darkvater@5124: Window *w = *wz; tron@2639: if (w->window_class == cls && w->window_number == number) return w; truelight@158: } truelight@0: truelight@0: return NULL; truelight@0: } truelight@0: rubidium@8857: /** rubidium@8857: * Delete a window by its class and window number (if it is open). rubidium@8857: * @param cls Window class rubidium@8857: * @param number Number of the window within the window class rubidium@8857: */ truelight@0: void DeleteWindowById(WindowClass cls, WindowNumber number) truelight@0: { rubidium@9115: delete FindWindowById(cls, number); truelight@158: } truelight@0: rubidium@8857: /** rubidium@8857: * Delete all windows of a given class rubidium@8857: * @param cls Window class of windows to delete rubidium@8857: */ darkvater@999: void DeleteWindowByClass(WindowClass cls) darkvater@999: { Darkvater@5124: Window* const *wz; tron@2639: Darkvater@5121: restart_search: Darkvater@5121: /* When we find the window to delete, we need to restart the search Darkvater@5124: * as deleting this window could cascade in deleting (many) others Darkvater@5124: * anywhere in the z-array */ Darkvater@5124: FOR_ALL_WINDOWS(wz) { Darkvater@5124: Window *w = *wz; darkvater@999: if (w->window_class == cls) { rubidium@9115: delete w; Darkvater@5121: goto restart_search; tron@2639: } darkvater@999: } darkvater@999: } darkvater@999: Darkvater@5120: /** Delete all windows of a player. We identify windows of a player Darkvater@5120: * by looking at the caption colour. If it is equal to the player ID Darkvater@5120: * then we say the window belongs to the player and should be deleted Darkvater@5120: * @param id PlayerID player identifier */ Darkvater@5120: void DeletePlayerWindows(PlayerID id) bjarni@5077: { Darkvater@5124: Window* const *wz; bjarni@5077: Darkvater@5121: restart_search: Darkvater@5121: /* When we find the window to delete, we need to restart the search Darkvater@5124: * as deleting this window could cascade in deleting (many) others Darkvater@5124: * anywhere in the z-array */ Darkvater@5124: FOR_ALL_WINDOWS(wz) { Darkvater@5124: Window *w = *wz; Darkvater@5120: if (w->caption_color == id) { rubidium@9115: delete w; Darkvater@5121: goto restart_search; bjarni@5077: } bjarni@5077: } bjarni@5077: Darkvater@5120: /* Also delete the player specific windows, that don't have a player-colour */ Darkvater@5120: DeleteWindowById(WC_BUY_COMPANY, id); bjarni@5077: } bjarni@5077: Darkvater@5120: /** Change the owner of all the windows one player can take over from another Darkvater@5120: * player in the case of a company merger. Do not change ownership of windows Darkvater@5120: * that need to be deleted once takeover is complete Darkvater@5120: * @param old_player PlayerID of original owner of the window Darkvater@5120: * @param new_player PlayerID of the new owner of the window */ bjarni@5077: void ChangeWindowOwner(PlayerID old_player, PlayerID new_player) bjarni@5077: { Darkvater@5124: Window* const *wz; bjarni@5077: Darkvater@5124: FOR_ALL_WINDOWS(wz) { Darkvater@5124: Window *w = *wz; Darkvater@5124: rubidium@9124: if (w->caption_color != old_player) continue; Darkvater@5120: rubidium@9124: switch (w->window_class) { rubidium@9124: case WC_PLAYER_COLOR: rubidium@9124: case WC_FINANCES: rubidium@9124: case WC_STATION_LIST: rubidium@9124: case WC_TRAINS_LIST: rubidium@9124: case WC_ROADVEH_LIST: rubidium@9124: case WC_SHIPS_LIST: rubidium@9124: case WC_AIRCRAFT_LIST: rubidium@9124: case WC_BUY_COMPANY: rubidium@9124: case WC_COMPANY: rubidium@9124: continue; rubidium@9124: rubidium@9124: default: rubidium@9124: w->caption_color = new_player; rubidium@9124: break; rubidium@9124: } bjarni@5077: } bjarni@5077: } bjarni@5077: Darkvater@5124: static void BringWindowToFront(const Window *w); tron@2817: Darkvater@5124: /** Find a window and make it the top-window on the screen. The window belugas@6443: * gets a white border for a brief period of time to visualize its "activation" belugas@6443: * @param cls WindowClass of the window to activate belugas@6443: * @param number WindowNumber of the window to activate Darkvater@5124: * @return a pointer to the window thus activated */ truelight@0: Window *BringWindowToFrontById(WindowClass cls, WindowNumber number) truelight@0: { truelight@0: Window *w = FindWindowById(cls, number); truelight@0: truelight@0: if (w != NULL) { truelight@0: w->flags4 |= WF_WHITE_BORDER_MASK; Darkvater@5124: BringWindowToFront(w); rubidium@9116: w->SetDirty(); truelight@0: } truelight@0: truelight@0: return w; truelight@0: } truelight@0: darkvater@1648: static inline bool IsVitalWindow(const Window *w) darkvater@1648: { rubidium@9124: switch (w->window_class) { rubidium@9124: case WC_MAIN_TOOLBAR: rubidium@9124: case WC_STATUS_BAR: rubidium@9124: case WC_NEWS_WINDOW: rubidium@9124: case WC_SEND_NETWORK_MSG: rubidium@9124: return true; rubidium@9124: rubidium@9124: default: rubidium@9124: return false; rubidium@9124: } darkvater@1648: } darkvater@1648: darkvater@1648: /** On clicking on a window, make it the frontmost window of all. However darkvater@1648: * there are certain windows that always need to be on-top; these include darkvater@1648: * - Toolbar, Statusbar (always on) darkvater@1648: * - New window, Chatbar (only if open) Darkvater@5120: * The window is marked dirty for a repaint if the window is actually moved darkvater@1648: * @param w window that is put into the foreground Darkvater@5124: * @return pointer to the window, the same as the input pointer darkvater@1648: */ Darkvater@5124: static void BringWindowToFront(const Window *w) truelight@0: { Darkvater@5124: Window **wz = FindWindowZPosition(w); Darkvater@5124: Window **vz = _last_z_window; truelight@0: Darkvater@5124: /* Bring the window just below the vital windows */ truelight@0: do { Darkvater@5124: if (--vz < _z_windows) return; Darkvater@5124: } while (IsVitalWindow(*vz)); truelight@0: Darkvater@5124: if (wz == vz) return; // window is already in the right position Darkvater@5124: assert(wz < vz); truelight@0: rubidium@9124: Window *tempz = *wz; Darkvater@5124: memmove(wz, wz + 1, (byte*)vz - (byte*)wz); Darkvater@5124: *vz = tempz; truelight@0: rubidium@9116: w->SetDirty(); truelight@0: } truelight@0: darkvater@1648: /** We have run out of windows, so find a suitable candidate for replacement. darkvater@1648: * Keep all important windows intact. These are darkvater@1648: * - Main window (gamefield), Toolbar, Statusbar (always on) darkvater@1648: * - News window, Chatbar (when on) darkvater@1648: * - Any sticked windows since we wanted to keep these darkvater@1648: * @return w pointer to the window that is going to be deleted darkvater@1648: */ rubidium@6247: static Window *FindDeletableWindow() darkvater@763: { Darkvater@5124: Window* const *wz; tron@2639: Darkvater@5124: FOR_ALL_WINDOWS(wz) { Darkvater@5124: Window *w = *wz; tron@2639: if (w->window_class != WC_MAIN_WINDOW && !IsVitalWindow(w) && !(w->flags4 & WF_STICKY)) { tron@2639: return w; tron@2639: } darkvater@763: } darkvater@763: return NULL; darkvater@763: } darkvater@763: darkvater@1648: /** A window must be freed, and all are marked as important windows. Ease the darkvater@1648: * restriction a bit by allowing to delete sticky windows. Keep important/vital darkvater@1648: * windows intact (Main window, Toolbar, Statusbar, News Window, Chatbar) Darkvater@5124: * Start finding an appropiate candidate from the lowest z-values (bottom) darkvater@1648: * @see FindDeletableWindow() darkvater@1648: * @return w Pointer to the window that is being deleted darkvater@1648: */ rubidium@6247: static Window *ForceFindDeletableWindow() darkvater@763: { Darkvater@5124: Window* const *wz; tron@2639: rubidium@8995: FOR_ALL_WINDOWS(wz) { Darkvater@5124: Window *w = *wz; tron@2639: if (w->window_class != WC_MAIN_WINDOW && !IsVitalWindow(w)) return w; darkvater@763: } rubidium@8995: NOT_REACHED(); darkvater@763: } darkvater@763: rubidium@9167: /** rubidium@9167: * Assign widgets to a new window by initialising its widget pointers, and by rubidium@9167: * copying the widget array \a widget to \c w->widget to allow for resizable rubidium@9167: * windows. belugas@6443: * @param w Window on which to attach the widget array rubidium@9167: * @param widget pointer of widget array to fill the window with rubidium@9167: * rubidium@9167: * @post \c w->widget points to allocated memory and contains the copied widget array except for the terminating widget, rubidium@9167: * \c w->widget_count contains number of widgets in the allocated memory. rubidium@9167: */ rubidium@9168: static void AssignWidgetToWindow(Window *w, const Widget *widget) truelight@867: { truelight@867: if (widget != NULL) { truelight@867: uint index = 1; truelight@867: rubidium@9124: for (const Widget *wi = widget; wi->type != WWT_LAST; wi++) index++; tron@2639: rubidium@9167: w->widget = MallocT(index); tron@2639: memcpy(w->widget, widget, sizeof(*w->widget) * index); rubidium@5232: w->widget_count = index - 1; tron@2639: } else { truelight@867: w->widget = NULL; rubidium@5232: w->widget_count = 0; tron@2639: } truelight@867: } truelight@867: rubidium@9142: /** rubidium@9142: * Initializes a new Window. rubidium@9142: * This function is called the constructors. bjarni@4520: * See descriptions for those functions for usage bjarni@4520: * Only addition here is window_number, which is the window_number being assigned to the new window belugas@6443: * @param x offset in pixels from the left of the screen belugas@6443: * @param y offset in pixels from the top of the screen rubidium@7341: * @param min_width minimum width in pixels of the window rubidium@7341: * @param min_height minimum height in pixels of the window belugas@6443: * @param *proc see WindowProc function to call when any messages/updates happen to the window belugas@6443: * @param cls see WindowClass class of the window, used for identification and grouping belugas@6443: * @param *widget see Widget pointer to the window layout and various elements belugas@6443: * @param window_number number being assigned to the new window rubidium@9203: * @return Window pointer of the newly created window rubidium@9203: */ rubidium@9178: void Window::Initialize(int x, int y, int min_width, int min_height, rubidium@9203: WindowProc *proc, WindowClass cls, const Widget *widget, int window_number) truelight@0: { Darkvater@5124: /* We have run out of windows, close one and use that as the place for our new one */ rubidium@8925: if (_last_z_window == endof(_z_windows)) { rubidium@9142: Window *w = FindDeletableWindow(); Darkvater@5124: if (w == NULL) w = ForceFindDeletableWindow(); rubidium@9115: delete w; truelight@0: } truelight@0: belugas@6432: /* Set up window properties */ rubidium@9142: this->window_class = cls; rubidium@9142: this->flags4 = WF_WHITE_BORDER_MASK; // just opened windows have a white border rubidium@9142: this->caption_color = 0xFF; rubidium@9142: this->left = x; rubidium@9142: this->top = y; rubidium@9142: this->width = min_width; rubidium@9142: this->height = min_height; rubidium@9142: this->wndproc = proc; rubidium@9142: AssignWidgetToWindow(this, widget); rubidium@9142: this->resize.width = min_width; rubidium@9142: this->resize.height = min_height; rubidium@9142: this->resize.step_width = 1; rubidium@9142: this->resize.step_height = 1; rubidium@9142: this->window_number = window_number; Darkvater@5124: rubidium@9142: /* Hacky way of specifying always-on-top windows. These windows are rubidium@9142: * always above other windows because they are moved below them. rubidium@9142: * status-bar is above news-window because it has been created earlier. rubidium@9142: * Also, as the chat-window is excluded from this, it will always be rubidium@9142: * the last window, thus always on top. rubidium@9142: * XXX - Yes, ugly, probably needs something like w->always_on_top flag rubidium@9142: * to implement correctly, but even then you need some kind of distinction rubidium@9142: * between on-top of chat/news and status windows, because these conflict */ rubidium@9142: Window **wz = _last_z_window; rubidium@9142: if (wz != _z_windows && this->window_class != WC_SEND_NETWORK_MSG && this->window_class != WC_HIGHSCORE && this->window_class != WC_ENDSCREEN) { rubidium@9142: if (FindWindowById(WC_MAIN_TOOLBAR, 0) != NULL) wz--; rubidium@9142: if (FindWindowById(WC_STATUS_BAR, 0) != NULL) wz--; rubidium@9142: if (FindWindowById(WC_NEWS_WINDOW, 0) != NULL) wz--; rubidium@9142: if (FindWindowById(WC_SEND_NETWORK_MSG, 0) != NULL) wz--; Darkvater@5124: rubidium@9142: assert(wz >= _z_windows); rubidium@9142: if (wz != _last_z_window) memmove(wz + 1, wz, (byte*)_last_z_window - (byte*)wz); rubidium@9142: } Darkvater@5124: rubidium@9142: *wz = this; rubidium@9142: _last_z_window++; truelight@0: rubidium@7367: WindowEvent e; rubidium@7367: e.event = WE_CREATE; rubidium@9142: this->HandleWindowEvent(&e); rubidium@9178: } rubidium@7341: rubidium@9178: /** rubidium@9178: * Find a nice spot for this window and resize it towards the default size. rubidium@9178: * @param def_width default width in pixels of the window rubidium@9178: * @param def_height default height in pixels of the window rubidium@9178: */ rubidium@9178: void Window::FindWindowPlacementAndResize(int def_width, int def_height) rubidium@9178: { rubidium@7353: /* Try to make windows smaller when our window is too small. rubidium@7353: * w->(width|height) is normally the same as min_(width|height), rubidium@7353: * but this way the GUIs can be made a little more dynamic; rubidium@7353: * one can use the same spec for multiple windows and those rubidium@7353: * can then determine the real minimum size of the window. */ rubidium@9142: if (this->width != def_width || this->height != def_height) { rubidium@7344: /* Think about the overlapping toolbars when determining the minimum window size */ rubidium@7344: int free_height = _screen.height; rubidium@7344: const Window *wt = FindWindowById(WC_STATUS_BAR, 0); rubidium@7344: if (wt != NULL) free_height -= wt->height; rubidium@7344: wt = FindWindowById(WC_MAIN_TOOLBAR, 0); rubidium@7344: if (wt != NULL) free_height -= wt->height; rubidium@7344: rubidium@9142: int enlarge_x = max(min(def_width - this->width, _screen.width - this->width), 0); rubidium@9142: int enlarge_y = max(min(def_height - this->height, free_height - this->height), 0); rubidium@7341: rubidium@7341: /* X and Y has to go by step.. calculate it. rubidium@7341: * The cast to int is necessary else x/y are implicitly casted to rubidium@7341: * unsigned int, which won't work. */ rubidium@9142: if (this->resize.step_width > 1) enlarge_x -= enlarge_x % (int)this->resize.step_width; rubidium@9142: if (this->resize.step_height > 1) enlarge_y -= enlarge_y % (int)this->resize.step_height; rubidium@7341: rubidium@9142: ResizeWindow(this, enlarge_x, enlarge_y); rubidium@7342: rubidium@9166: Point size; rubidium@9166: Point diff; rubidium@9166: size.x = this->width; rubidium@9166: size.y = this->height; rubidium@9166: diff.x = enlarge_x; rubidium@9166: diff.y = enlarge_y; rubidium@9166: this->OnResize(size, diff); rubidium@7344: } rubidium@7342: rubidium@9142: int nx = this->left; rubidium@9142: int ny = this->top; truelight@7464: rubidium@9142: if (nx + this->width > _screen.width) nx -= (nx + this->width - _screen.width); rubidium@7364: rubidium@7344: const Window *wt = FindWindowById(WC_MAIN_TOOLBAR, 0); rubidium@9178: ny = max(ny, (wt == NULL || this == wt || this->top == 0) ? 0 : wt->height); truelight@7464: nx = max(nx, 0); truelight@7464: rubidium@9142: if (this->viewport != NULL) { rubidium@9142: this->viewport->left += nx - this->left; rubidium@9142: this->viewport->top += ny - this->top; truelight@7464: } rubidium@9142: this->left = nx; rubidium@9142: this->top = ny; rubidium@7341: rubidium@9142: this->SetDirty(); truelight@0: } truelight@0: rubidium@9178: void Window::FindWindowPlacementAndResize(const WindowDesc *desc) rubidium@9178: { rubidium@9178: this->FindWindowPlacementAndResize(desc->default_width, desc->default_height); rubidium@9178: } rubidium@9178: bjarni@4520: /** bjarni@4520: * Open a new window. If there is no space for a new window, close an open bjarni@4520: * window. Try to avoid stickied windows, but if there is no else, close one of bjarni@4520: * those as well. Then make sure all created windows are below some always-on-top bjarni@4520: * ones. Finally set all variables and call the WE_CREATE event bjarni@4520: * @param x offset in pixels from the left of the screen bjarni@4520: * @param y offset in pixels from the top of the screen bjarni@4520: * @param width width in pixels of the window bjarni@4520: * @param height height in pixels of the window belugas@6443: * @param *proc see WindowProc function to call when any messages/updates happen to the window belugas@6443: * @param cls see WindowClass class of the window, used for identification and grouping belugas@6443: * @param *widget see Widget pointer to the window layout and various elements rubidium@8857: * @return Window pointer of the newly created window rubidium@8857: */ rubidium@9203: Window::Window(int x, int y, int width, int height, WindowProc *proc, WindowClass cls, const Widget *widget) bjarni@4520: { rubidium@9203: this->Initialize(x, y, width, height, proc, cls, widget, 0); rubidium@9178: rubidium@9178: if (proc != NULL) this->FindWindowPlacementAndResize(width, height); bjarni@4520: } truelight@0: truelight@0: peter1138@6532: static bool IsGoodAutoPlace1(int left, int top, int width, int height, Point &pos) truelight@0: { Darkvater@5124: Window* const *wz; truelight@0: peter1138@6532: int right = width + left; peter1138@6532: int bottom = height + top; truelight@0: rubidium@9124: if (left < 0 || top < 22 || right > _screen.width || bottom > _screen.height) return false; truelight@0: belugas@6432: /* Make sure it is not obscured by any window. */ Darkvater@5124: FOR_ALL_WINDOWS(wz) { Darkvater@5124: const Window *w = *wz; tron@2639: if (w->window_class == WC_MAIN_WINDOW) continue; truelight@0: truelight@158: if (right > w->left && tron@2639: w->left + w->width > left && truelight@0: bottom > w->top && tron@2639: w->top + w->height > top) { tron@2639: return false; tron@2639: } truelight@158: } truelight@0: peter1138@6532: pos.x = left; peter1138@6532: pos.y = top; truelight@0: return true; truelight@0: } truelight@0: peter1138@6532: static bool IsGoodAutoPlace2(int left, int top, int width, int height, Point &pos) truelight@0: { Darkvater@5124: Window* const *wz; truelight@0: Darkvater@5120: if (left < -(width>>2) || left > _screen.width - (width>>1)) return false; Darkvater@5120: if (top < 22 || top > _screen.height - (height>>2)) return false; truelight@0: belugas@6432: /* Make sure it is not obscured by any window. */ Darkvater@5124: FOR_ALL_WINDOWS(wz) { Darkvater@5124: const Window *w = *wz; tron@2639: if (w->window_class == WC_MAIN_WINDOW) continue; truelight@0: truelight@158: if (left + width > w->left && tron@2639: w->left + w->width > left && truelight@0: top + height > w->top && tron@2639: w->top + w->height > top) { tron@2639: return false; tron@2639: } truelight@158: } truelight@0: peter1138@6532: pos.x = left; peter1138@6532: pos.y = top; truelight@0: return true; truelight@0: } truelight@0: tron@1095: static Point GetAutoPlacePosition(int width, int height) tron@1095: { Darkvater@5124: Window* const *wz; truelight@0: Point pt; truelight@0: peter1138@6532: if (IsGoodAutoPlace1(0, 24, width, height, pt)) return pt; truelight@0: Darkvater@5124: FOR_ALL_WINDOWS(wz) { Darkvater@5124: const Window *w = *wz; tron@2639: if (w->window_class == WC_MAIN_WINDOW) continue; truelight@0: peter1138@6532: if (IsGoodAutoPlace1(w->left + w->width + 2, w->top, width, height, pt)) return pt; peter1138@6532: if (IsGoodAutoPlace1(w->left - width - 2, w->top, width, height, pt)) return pt; peter1138@6532: if (IsGoodAutoPlace1(w->left, w->top + w->height + 2, width, height, pt)) return pt; peter1138@6532: if (IsGoodAutoPlace1(w->left, w->top - height - 2, width, height, pt)) return pt; peter1138@6532: if (IsGoodAutoPlace1(w->left + w->width + 2, w->top + w->height - height, width, height, pt)) return pt; peter1138@6532: if (IsGoodAutoPlace1(w->left - width - 2, w->top + w->height - height, width, height, pt)) return pt; peter1138@6532: if (IsGoodAutoPlace1(w->left + w->width - width, w->top + w->height + 2, width, height, pt)) return pt; peter1138@6532: if (IsGoodAutoPlace1(w->left + w->width - width, w->top - height - 2, width, height, pt)) return pt; truelight@158: } truelight@158: Darkvater@5124: FOR_ALL_WINDOWS(wz) { Darkvater@5124: const Window *w = *wz; tron@2639: if (w->window_class == WC_MAIN_WINDOW) continue; truelight@0: peter1138@6532: if (IsGoodAutoPlace2(w->left + w->width + 2, w->top, width, height, pt)) return pt; peter1138@6532: if (IsGoodAutoPlace2(w->left - width - 2, w->top, width, height, pt)) return pt; peter1138@6532: if (IsGoodAutoPlace2(w->left, w->top + w->height + 2, width, height, pt)) return pt; peter1138@6532: if (IsGoodAutoPlace2(w->left, w->top - height - 2, width, height, pt)) return pt; truelight@0: } truelight@0: truelight@0: { peter1138@6532: int left = 0, top = 24; truelight@158: peter1138@6532: restart: Darkvater@5124: FOR_ALL_WINDOWS(wz) { Darkvater@5124: const Window *w = *wz; Darkvater@5124: truelight@0: if (w->left == left && w->top == top) { truelight@0: left += 5; truelight@0: top += 5; truelight@0: goto restart; truelight@0: } truelight@0: } truelight@158: truelight@0: pt.x = left; truelight@0: pt.y = top; truelight@0: return pt; truelight@0: } truelight@0: } truelight@0: belugas@7721: /** rubidium@9078: * Compute the position of the top-left corner of a new window that is opened. belugas@7721: * rubidium@9079: * By default position a child window at an offset of 10/10 of its parent. rubidium@9079: * With the exception of WC_BUILD_TOOLBAR (build railway/roads/ship docks/airports) rubidium@9079: * and WC_SCEN_LAND_GEN (landscaping). Whose child window has an offset of 0/36 of rubidium@9079: * its parent. So it's exactly under the parent toolbar and no buttons will be covered. rubidium@9079: * However if it falls too extremely outside window positions, reposition rubidium@9079: * it to an automatic place. rubidium@9079: * belugas@7721: * @param *desc The pointer to the WindowDesc to be created belugas@7721: * @param window_number the window number of the new window belugas@7721: * rubidium@9078: * @return Coordinate of the top-left corner of the new window belugas@7721: */ rubidium@9078: static Point LocalGetWindowPlacement(const WindowDesc *desc, int window_number) truelight@0: { truelight@0: Point pt; truelight@0: Window *w; truelight@0: Darkvater@5071: if (desc->parent_cls != 0 /* WC_MAIN_WINDOW */ && Darkvater@5071: (w = FindWindowById(desc->parent_cls, window_number)) != NULL && Darkvater@5071: w->left < _screen.width - 20 && w->left > -60 && w->top < _screen.height - 20) { Darkvater@5071: belugas@7721: pt.x = w->left + ((desc->parent_cls == WC_BUILD_TOOLBAR || desc->parent_cls == WC_SCEN_LAND_GEN) ? 0 : 10); rubidium@7341: if (pt.x > _screen.width + 10 - desc->default_width) { rubidium@7341: pt.x = (_screen.width + 10 - desc->default_width) - 20; Darkvater@5071: } belugas@7721: pt.y = w->top + ((desc->parent_cls == WC_BUILD_TOOLBAR || desc->parent_cls == WC_SCEN_LAND_GEN) ? 36 : 10); truelight@0: } else { Darkvater@5072: switch (desc->left) { rubidium@9079: case WDP_ALIGN_TBR: // Align the right side with the top toolbar Darkvater@5072: w = FindWindowById(WC_MAIN_TOOLBAR, 0); rubidium@7341: pt.x = (w->left + w->width) - desc->default_width; rubidium@9079: break; rubidium@9079: rubidium@9079: case WDP_ALIGN_TBL: // Align the left side with the top toolbar Darkvater@5072: pt.x = FindWindowById(WC_MAIN_TOOLBAR, 0)->left; Darkvater@5072: break; rubidium@9079: rubidium@9079: case WDP_AUTO: // Find a good automatic position for the window rubidium@9078: return GetAutoPlacePosition(desc->default_width, desc->default_height); rubidium@9079: rubidium@9079: case WDP_CENTER: // Centre the window horizontally rubidium@7341: pt.x = (_screen.width - desc->default_width) / 2; Darkvater@5072: break; rubidium@9079: Darkvater@5072: default: Darkvater@5072: pt.x = desc->left; Darkvater@5072: if (pt.x < 0) pt.x += _screen.width; // negative is from right of the screen Darkvater@5072: } Darkvater@5072: Darkvater@5072: switch (desc->top) { rubidium@9079: case WDP_CENTER: // Centre the window vertically rubidium@7341: pt.y = (_screen.height - desc->default_height) / 2; Darkvater@5072: break; rubidium@9079: Darkvater@5072: /* WDP_AUTO sets the position at once and is controlled by desc->left. Darkvater@5072: * Both left and top must be set to WDP_AUTO */ Darkvater@5072: case WDP_AUTO: Darkvater@5072: NOT_REACHED(); Darkvater@5072: assert(desc->left == WDP_AUTO && desc->top != WDP_AUTO); Darkvater@5072: /* fallthrough */ rubidium@9079: Darkvater@5072: default: Darkvater@5072: pt.y = desc->top; Darkvater@5072: if (pt.y < 0) pt.y += _screen.height; // negative is from bottom of the screen Darkvater@5072: break; truelight@0: } truelight@0: } truelight@0: rubidium@9078: return pt; rubidium@9078: } rubidium@9078: rubidium@9078: /** rubidium@9078: * Set the positions of a new window from a WindowDesc and open it. rubidium@9078: * rubidium@9078: * @param *desc The pointer to the WindowDesc to be created rubidium@9078: * @param window_number the window number of the new window rubidium@9078: * rubidium@9078: * @return Window pointer of the newly created window rubidium@9078: */ rubidium@9203: Window::Window(const WindowDesc *desc, WindowNumber window_number) rubidium@9078: { rubidium@9078: Point pt = LocalGetWindowPlacement(desc, window_number); rubidium@9203: this->Initialize(pt.x, pt.y, desc->minimum_width, desc->minimum_height, desc->proc, desc->cls, desc->widgets, window_number); rubidium@9142: this->desc_flags = desc->flags; rubidium@9178: rubidium@9178: if (desc->proc != NULL) this->FindWindowPlacementAndResize(desc->default_width, desc->default_height); bjarni@4520: } bjarni@4520: Darkvater@5120: /** Do a search for a window at specific coordinates. For this we start Darkvater@5120: * at the topmost window, obviously and work our way down to the bottom belugas@6443: * @param x position x to query belugas@6443: * @param y position y to query Darkvater@5120: * @return a pointer to the found window if any, NULL otherwise */ truelight@0: Window *FindWindowFromPt(int x, int y) truelight@0: { rubidium@8995: for (Window * const *wz = _last_z_window; wz != _z_windows;) { Darkvater@5124: Window *w = *--wz; skidd13@7954: if (IsInsideBS(x, w->left, w->width) && IsInsideBS(y, w->top, w->height)) { tron@2639: return w; tron@2639: } truelight@0: } truelight@0: truelight@0: return NULL; truelight@0: } truelight@0: rubidium@8923: /** rubidium@8923: * (re)initialize the windowing system rubidium@8923: */ rubidium@6247: void InitWindowSystem() darkvater@152: { dominik@136: IConsoleClose(); Darkvater@1474: Darkvater@5124: _last_z_window = _z_windows; rubidium@8995: _mouseover_last_w = NULL; Darkvater@1397: _no_scroll = 0; truelight@0: } truelight@0: rubidium@8923: /** rubidium@8923: * Close down the windowing system rubidium@8923: */ rubidium@6247: void UnInitWindowSystem() Darkvater@1474: { rubidium@9124: while (_last_z_window != _z_windows) delete _z_windows[0]; Darkvater@1474: } Darkvater@1474: rubidium@8923: /** rubidium@8923: * Reset the windowing system, by means of shutting it down followed by re-initialization rubidium@8923: */ rubidium@6247: void ResetWindowSystem() Darkvater@1474: { Darkvater@1474: UnInitWindowSystem(); Darkvater@1474: InitWindowSystem(); Darkvater@1744: _thd.pos.x = 0; Darkvater@1744: _thd.pos.y = 0; Darkvater@2877: _thd.new_pos.x = 0; Darkvater@2877: _thd.new_pos.y = 0; Darkvater@1474: } Darkvater@1474: rubidium@6247: static void DecreaseWindowCounters() truelight@0: { Darkvater@5124: Window* const *wz; truelight@0: Darkvater@5124: for (wz = _last_z_window; wz != _z_windows;) { rubidium@9124: Window *w = *--wz; belugas@6432: /* Unclick scrollbar buttons if they are pressed. */ truelight@0: if (w->flags4 & (WF_SCROLL_DOWN | WF_SCROLL_UP)) { truelight@0: w->flags4 &= ~(WF_SCROLL_DOWN | WF_SCROLL_UP); rubidium@9116: w->SetDirty(); truelight@0: } rubidium@9166: w->OnMouseLoop(); truelight@0: } truelight@0: Darkvater@5124: for (wz = _last_z_window; wz != _z_windows;) { rubidium@9124: Window *w = *--wz; truelight@158: rubidium@9124: if (w->flags4 & WF_TIMEOUT_MASK && !(--w->flags4 & WF_TIMEOUT_MASK)) { rubidium@9166: w->OnTimeout(); belugas@8032: if (w->desc_flags & WDF_UNCLICK_BUTTONS) w->RaiseButtons(); truelight@0: } truelight@0: } truelight@0: } truelight@0: rubidium@6247: Window *GetCallbackWnd() truelight@0: { truelight@0: return FindWindowById(_thd.window_class, _thd.window_number); truelight@0: } truelight@0: rubidium@6247: static void HandlePlacePresize() truelight@0: { tron@2639: if (_special_mouse_mode != WSM_PRESIZE) return; truelight@0: rubidium@9124: Window *w = GetCallbackWnd(); tron@2639: if (w == NULL) return; truelight@0: rubidium@9166: Point pt = GetTileBelowCursor(); rubidium@9166: if (pt.x == -1) { truelight@0: _thd.selend.x = -1; truelight@0: return; truelight@0: } rubidium@9166: rubidium@9166: w->OnPlacePresize(pt, TileVirtXY(pt.x, pt.y)); truelight@0: } truelight@0: rubidium@6247: static bool HandleDragDrop() truelight@0: { tron@2639: if (_special_mouse_mode != WSM_DRAGDROP) return true; tron@2639: if (_left_button_down) return false; truelight@158: rubidium@9124: Window *w = GetCallbackWnd(); truelight@0: tron@2639: if (w != NULL) { belugas@6432: /* send an event in client coordinates. */ rubidium@9166: Point pt; rubidium@9166: pt.x = _cursor.pos.x - w->left; rubidium@9166: pt.y = _cursor.pos.y - w->top; rubidium@9166: w->OnDragDrop(pt, GetWidgetFromPos(w, pt.x, pt.y)); truelight@0: } smatz@8585: smatz@8585: ResetObjectToPlace(); smatz@8585: truelight@0: return false; truelight@0: } truelight@0: rubidium@6247: static bool HandleMouseOver() truelight@543: { rubidium@8924: Window *w = FindWindowFromPt(_cursor.pos.x, _cursor.pos.y); truelight@543: belugas@6432: /* We changed window, put a MOUSEOVER event to the last window */ rubidium@8924: if (_mouseover_last_w != NULL && _mouseover_last_w != w) { rubidium@8924: /* Reset mouse-over coordinates of previous window */ rubidium@9166: Point pt = { -1, -1 }; rubidium@9166: _mouseover_last_w->OnMouseOver(pt, 0); truelight@543: } rubidium@8924: rubidium@8924: /* _mouseover_last_w will get reset when the window is deleted, see DeleteWindow() */ rubidium@8924: _mouseover_last_w = w; truelight@543: tron@2639: if (w != NULL) { belugas@6432: /* send an event in client coordinates. */ rubidium@9166: Point pt = { _cursor.pos.x - w->left, _cursor.pos.y - w->top }; rubidium@9166: int widget = 0; truelight@543: if (w->widget != NULL) { rubidium@9166: widget = GetWidgetFromPos(w, pt.x, pt.y); truelight@543: } rubidium@9166: w->OnMouseOver(pt, widget); truelight@543: } truelight@543: belugas@6432: /* Mouseover never stops execution */ truelight@543: return true; truelight@543: } truelight@543: rubidium@8857: /** rubidium@8857: * Resize the window. rubidium@8857: * Update all the widgets of a window based on their resize flags Darkvater@5268: * Both the areas of the old window and the new sized window are set dirty Darkvater@5268: * ensuring proper redrawal. Darkvater@5268: * @param w Window to resize belugas@6481: * @param x delta x-size of changed window (positive if larger, etc.) rubidium@8857: * @param y delta y-size of changed window rubidium@8857: */ Darkvater@5268: void ResizeWindow(Window *w, int x, int y) Darkvater@5268: { Darkvater@5268: bool resize_height = false; Darkvater@5268: bool resize_width = false; Darkvater@5268: Darkvater@5268: if (x == 0 && y == 0) return; Darkvater@5268: rubidium@9116: w->SetDirty(); rubidium@9124: for (Widget *wi = w->widget; wi->type != WWT_LAST; wi++) { Darkvater@5268: /* Isolate the resizing flags */ Darkvater@5268: byte rsizeflag = GB(wi->display_flags, 0, 4); Darkvater@5268: Darkvater@5268: if (rsizeflag == RESIZE_NONE) continue; Darkvater@5268: Darkvater@5268: /* Resize the widget based on its resize-flag */ Darkvater@5268: if (rsizeflag & RESIZE_LEFT) { Darkvater@5268: wi->left += x; Darkvater@5268: resize_width = true; Darkvater@5268: } Darkvater@5268: Darkvater@5268: if (rsizeflag & RESIZE_RIGHT) { Darkvater@5268: wi->right += x; Darkvater@5268: resize_width = true; Darkvater@5268: } Darkvater@5268: Darkvater@5268: if (rsizeflag & RESIZE_TOP) { Darkvater@5268: wi->top += y; Darkvater@5268: resize_height = true; Darkvater@5268: } Darkvater@5268: Darkvater@5268: if (rsizeflag & RESIZE_BOTTOM) { Darkvater@5268: wi->bottom += y; Darkvater@5268: resize_height = true; Darkvater@5268: } Darkvater@5268: } Darkvater@5268: Darkvater@5268: /* We resized at least 1 widget, so let's resize the window totally */ Darkvater@5268: if (resize_width) w->width += x; Darkvater@5268: if (resize_height) w->height += y; Darkvater@5268: rubidium@9116: w->SetDirty(); Darkvater@5268: } tron@2596: tron@2596: static bool _dragging_window; tron@2596: rubidium@6247: static bool HandleWindowDragging() truelight@0: { Darkvater@5124: Window* const *wz; belugas@6432: /* Get out immediately if no window is being dragged at all. */ tron@2639: if (!_dragging_window) return true; truelight@0: belugas@6432: /* Otherwise find the window... */ Darkvater@5124: FOR_ALL_WINDOWS(wz) { Darkvater@5124: Window *w = *wz; Darkvater@5124: tron@350: if (w->flags4 & WF_DRAGGING) { tron@370: const Widget *t = &w->widget[1]; // the title bar ... ugh truelight@158: belugas@6432: /* Stop the dragging if the left mouse button was released */ truelight@0: if (!_left_button_down) { tron@350: w->flags4 &= ~WF_DRAGGING; truelight@0: break; truelight@0: } truelight@0: rubidium@9116: w->SetDirty(); truelight@0: rubidium@9124: int x = _cursor.pos.x + _drag_delta.x; rubidium@9124: int y = _cursor.pos.y + _drag_delta.y; rubidium@9124: int nx = x; rubidium@9124: int ny = y; tron@350: tron@350: if (_patches.window_snap_radius != 0) { Darkvater@5137: Window* const *vz; Darkvater@5124: tron@353: int hsnap = _patches.window_snap_radius; tron@353: int vsnap = _patches.window_snap_radius; tron@353: int delta; tron@350: Darkvater@5124: FOR_ALL_WINDOWS(vz) { Darkvater@5124: const Window *v = *vz; Darkvater@5124: tron@350: if (v == w) continue; // Don't snap at yourself tron@350: tron@350: if (y + w->height > v->top && y < v->top + v->height) { belugas@6432: /* Your left border <-> other right border */ tron@350: delta = abs(v->left + v->width - x); tron@350: if (delta <= hsnap) { tron@350: nx = v->left + v->width; tron@350: hsnap = delta; tron@350: } tron@350: belugas@6432: /* Your right border <-> other left border */ tron@350: delta = abs(v->left - x - w->width); tron@350: if (delta <= hsnap) { tron@350: nx = v->left - w->width; tron@350: hsnap = delta; tron@350: } tron@350: } tron@350: tron@353: if (w->top + w->height >= v->top && w->top <= v->top + v->height) { belugas@6432: /* Your left border <-> other left border */ tron@353: delta = abs(v->left - x); tron@353: if (delta <= hsnap) { tron@353: nx = v->left; tron@353: hsnap = delta; tron@353: } tron@353: belugas@6432: /* Your right border <-> other right border */ tron@353: delta = abs(v->left + v->width - x - w->width); tron@353: if (delta <= hsnap) { tron@353: nx = v->left + v->width - w->width; tron@353: hsnap = delta; tron@353: } tron@353: } tron@353: tron@350: if (x + w->width > v->left && x < v->left + v->width) { belugas@6432: /* Your top border <-> other bottom border */ tron@350: delta = abs(v->top + v->height - y); tron@350: if (delta <= vsnap) { tron@350: ny = v->top + v->height; tron@350: vsnap = delta; tron@350: } tron@350: belugas@6432: /* Your bottom border <-> other top border */ tron@350: delta = abs(v->top - y - w->height); tron@350: if (delta <= vsnap) { tron@350: ny = v->top - w->height; tron@350: vsnap = delta; tron@350: } tron@350: } tron@353: tron@353: if (w->left + w->width >= v->left && w->left <= v->left + v->width) { belugas@6432: /* Your top border <-> other top border */ tron@353: delta = abs(v->top - y); tron@353: if (delta <= vsnap) { tron@353: ny = v->top; tron@353: vsnap = delta; tron@353: } tron@353: belugas@6432: /* Your bottom border <-> other bottom border */ tron@353: delta = abs(v->top + v->height - y - w->height); tron@353: if (delta <= vsnap) { tron@353: ny = v->top + v->height - w->height; tron@353: vsnap = delta; tron@353: } tron@353: } truelight@0: } truelight@0: } truelight@158: belugas@6432: /* Make sure the window doesn't leave the screen belugas@6432: * 13 is the height of the title bar */ skidd13@7922: nx = Clamp(nx, 13 - t->right, _screen.width - 13 - t->left); skidd13@7922: ny = Clamp(ny, 0, _screen.height - 13); tron@350: belugas@6432: /* Make sure the title bar isn't hidden by behind the main tool bar */ rubidium@9124: Window *v = FindWindowById(WC_MAIN_TOOLBAR, 0); tron@370: if (v != NULL) { tron@370: int v_bottom = v->top + v->height; tron@370: int v_right = v->left + v->width; tron@370: if (ny + t->top >= v->top && ny + t->top < v_bottom) { tron@371: if ((v->left < 13 && nx + t->left < v->left) || tron@371: (v_right > _screen.width - 13 && nx + t->right > v_right)) { tron@370: ny = v_bottom; tron@370: } else { tron@370: if (nx + t->left > v->left - 13 && tron@370: nx + t->right < v_right + 13) { tron@2639: if (w->top >= v_bottom) { tron@370: ny = v_bottom; tron@2639: } else if (w->left < nx) { tron@370: nx = v->left - 13 - t->left; tron@2639: } else { tron@370: nx = v_right + 13 - t->right; tron@2639: } tron@370: } tron@370: } tron@370: } tron@370: } tron@370: tron@350: if (w->viewport != NULL) { tron@350: w->viewport->left += nx - w->left; tron@350: w->viewport->top += ny - w->top; tron@350: } tron@350: w->left = nx; tron@350: w->top = ny; tron@350: rubidium@9116: w->SetDirty(); truelight@0: return false; truelight@867: } else if (w->flags4 & WF_SIZING) { truelight@867: int x, y; truelight@867: truelight@867: /* Stop the sizing if the left mouse button was released */ truelight@867: if (!_left_button_down) { truelight@867: w->flags4 &= ~WF_SIZING; rubidium@9116: w->SetDirty(); truelight@867: break; truelight@867: } truelight@867: truelight@867: x = _cursor.pos.x - _drag_delta.x; truelight@867: y = _cursor.pos.y - _drag_delta.y; truelight@867: peter1138@2675: /* X and Y has to go by step.. calculate it. peter1138@2675: * The cast to int is necessary else x/y are implicitly casted to peter1138@2675: * unsigned int, which won't work. */ peter1138@2675: if (w->resize.step_width > 1) x -= x % (int)w->resize.step_width; truelight@867: peter1138@2675: if (w->resize.step_height > 1) y -= y % (int)w->resize.step_height; truelight@867: truelight@867: /* Check if we don't go below the minimum set size */ truelight@867: if ((int)w->width + x < (int)w->resize.width) truelight@867: x = w->resize.width - w->width; truelight@867: if ((int)w->height + y < (int)w->resize.height) truelight@867: y = w->resize.height - w->height; truelight@867: truelight@867: /* Window already on size */ tron@2639: if (x == 0 && y == 0) return false; truelight@867: truelight@867: /* Now find the new cursor pos.. this is NOT _cursor, because truelight@867: we move in steps. */ truelight@867: _drag_delta.x += x; truelight@867: _drag_delta.y += y; truelight@867: Darkvater@5268: /* ResizeWindow sets both pre- and after-size to dirty for redrawal */ Darkvater@5268: ResizeWindow(w, x, y); truelight@867: rubidium@9166: Point size; rubidium@9166: Point diff; rubidium@9166: size.x = x + w->width; rubidium@9166: size.y = y + w->height; rubidium@9166: diff.x = x; rubidium@9166: diff.y = y; rubidium@9166: w->OnResize(size, diff); truelight@867: return false; truelight@0: } truelight@0: } truelight@0: truelight@0: _dragging_window = false; truelight@0: return false; truelight@0: } truelight@0: rubidium@8857: /** rubidium@8857: * Start window dragging rubidium@8857: * @param w Window to start dragging rubidium@8857: */ Darkvater@5124: static void StartWindowDrag(Window *w) truelight@0: { truelight@0: w->flags4 |= WF_DRAGGING; truelight@0: _dragging_window = true; truelight@867: tron@350: _drag_delta.x = w->left - _cursor.pos.x; tron@350: _drag_delta.y = w->top - _cursor.pos.y; truelight@867: Darkvater@5124: BringWindowToFront(w); truelight@0: DeleteWindowById(WC_DROPDOWN_MENU, 0); truelight@0: } truelight@0: rubidium@8857: /** rubidium@8857: * Start resizing a window rubidium@8857: * @param w Window to start resizing rubidium@8857: */ Darkvater@5124: static void StartWindowSizing(Window *w) truelight@0: { truelight@0: w->flags4 |= WF_SIZING; truelight@0: _dragging_window = true; truelight@867: truelight@867: _drag_delta.x = _cursor.pos.x; truelight@867: _drag_delta.y = _cursor.pos.y; truelight@867: Darkvater@5124: BringWindowToFront(w); truelight@0: DeleteWindowById(WC_DROPDOWN_MENU, 0); truelight@0: } truelight@0: truelight@0: rubidium@6247: static bool HandleScrollbarScrolling() truelight@0: { Darkvater@5124: Window* const *wz; truelight@0: belugas@6432: /* Get out quickly if no item is being scrolled */ tron@2639: if (!_scrolling_scrollbar) return true; truelight@0: belugas@6432: /* Find the scrolling window */ Darkvater@5124: FOR_ALL_WINDOWS(wz) { Darkvater@5124: Window *w = *wz; Darkvater@5124: truelight@0: if (w->flags4 & WF_SCROLL_MIDDLE) { belugas@6432: /* Abort if no button is clicked any more. */ truelight@0: if (!_left_button_down) { truelight@0: w->flags4 &= ~WF_SCROLL_MIDDLE; rubidium@9116: w->SetDirty(); truelight@0: break; truelight@158: } truelight@0: rubidium@9124: int i; rubidium@9124: Scrollbar *sb; rubidium@9124: truelight@0: if (w->flags4 & WF_HSCROLL) { truelight@0: sb = &w->hscroll; truelight@0: i = _cursor.pos.x - _cursorpos_drag_start.x; bjarni@842: } else if (w->flags4 & WF_SCROLL2){ bjarni@842: sb = &w->vscroll2; bjarni@842: i = _cursor.pos.y - _cursorpos_drag_start.y; truelight@0: } else { truelight@0: sb = &w->vscroll; truelight@0: i = _cursor.pos.y - _cursorpos_drag_start.y; truelight@0: } truelight@0: belugas@6432: /* Find the item we want to move to and make sure it's inside bounds. */ rubidium@9124: int pos = min(max(0, i + _scrollbar_start_pos) * sb->count / _scrollbar_size, max(0, sb->count - sb->cap)); truelight@0: if (pos != sb->pos) { truelight@0: sb->pos = pos; rubidium@9116: w->SetDirty(); truelight@0: } truelight@0: return false; truelight@158: } truelight@0: } truelight@158: truelight@0: _scrolling_scrollbar = false; truelight@0: return false; truelight@0: } truelight@0: rubidium@6247: static bool HandleViewportScroll() truelight@0: { bjarni@6289: bool scrollwheel_scrolling = _patches.scrollwheel_scrolling == 1 && (_cursor.v_wheel != 0 || _cursor.h_wheel != 0); bjarni@6289: tron@2639: if (!_scrolling_viewport) return true; truelight@0: rubidium@9124: Window *w = FindWindowFromPt(_cursor.pos.x, _cursor.pos.y); truelight@4335: truelight@7855: if (!(_right_button_down || scrollwheel_scrolling) || w == NULL) { truelight@7855: _cursor.fix_at = false; truelight@7855: _scrolling_viewport = false; truelight@7855: return true; truelight@7855: } truelight@7855: glx@9184: if (w == FindWindowById(WC_MAIN_WINDOW, 0) && w->viewport->follow_vehicle != INVALID_VEHICLE) { belugas@7759: /* If the main window is following a vehicle, then first let go of it! */ glx@9184: const Vehicle *veh = GetVehicle(w->viewport->follow_vehicle); belugas@7759: ScrollMainWindowTo(veh->x_pos, veh->y_pos, true); /* This also resets follow_vehicle */ belugas@7759: return true; belugas@7759: } belugas@7759: rubidium@9166: Point delta; tron@2680: if (_patches.reverse_scroll) { rubidium@9166: delta.x = -_cursor.delta.x; rubidium@9166: delta.y = -_cursor.delta.y; tron@2680: } else { rubidium@9166: delta.x = _cursor.delta.x; rubidium@9166: delta.y = _cursor.delta.y; tron@2680: } tron@2680: bjarni@6289: if (scrollwheel_scrolling) { bjarni@6289: /* We are using scrollwheels for scrolling */ rubidium@9166: delta.x = _cursor.h_wheel; rubidium@9166: delta.y = _cursor.v_wheel; bjarni@6289: _cursor.v_wheel = 0; bjarni@6289: _cursor.h_wheel = 0; bjarni@6289: } bjarni@6289: truelight@4335: /* Create a scroll-event and send it to the window */ rubidium@9166: w->OnScroll(delta); truelight@0: tron@2989: _cursor.delta.x = 0; tron@2989: _cursor.delta.y = 0; tron@2989: return false; truelight@0: } truelight@0: Darkvater@5416: /** Check if a window can be made top-most window, and if so do Darkvater@5416: * it. If a window does not obscure any other windows, it will not Darkvater@5416: * be brought to the foreground. Also if the only obscuring windows Darkvater@5416: * are so-called system-windows, the window will not be moved. Darkvater@5416: * The function will return false when a child window of this window is a Darkvater@5416: * modal-popup; function returns a false and child window gets a white border Darkvater@5416: * @param w Window to bring on-top Darkvater@5416: * @return false if the window has an active modal child, true otherwise */ Darkvater@5416: static bool MaybeBringWindowToFront(const Window *w) truelight@0: { Darkvater@5416: bool bring_to_front = false; truelight@0: tron@2639: if (w->window_class == WC_MAIN_WINDOW || tron@2639: IsVitalWindow(w) || tron@2639: w->window_class == WC_TOOLTIPS || tron@2639: w->window_class == WC_DROPDOWN_MENU) { Darkvater@5416: return true; tron@2639: } truelight@0: rubidium@9124: Window * const *wz = FindWindowZPosition(w); rubidium@8995: for (Window * const *uz = wz; ++uz != _last_z_window;) { Darkvater@5416: Window *u = *uz; Darkvater@5416: Darkvater@5416: /* A modal child will prevent the activation of the parent window */ Darkvater@5416: if (u->parent == w && (u->desc_flags & WDF_MODAL)) { Darkvater@5416: u->flags4 |= WF_WHITE_BORDER_MASK; rubidium@9116: u->SetDirty(); Darkvater@5416: return false; Darkvater@5416: } Darkvater@5124: tron@2639: if (u->window_class == WC_MAIN_WINDOW || tron@2639: IsVitalWindow(u) || tron@2639: u->window_class == WC_TOOLTIPS || tron@2639: u->window_class == WC_DROPDOWN_MENU) { tron@2639: continue; tron@2639: } truelight@0: Darkvater@5416: /* Window sizes don't interfere, leave z-order alone */ truelight@0: if (w->left + w->width <= u->left || truelight@0: u->left + u->width <= w->left || truelight@0: w->top + w->height <= u->top || tron@2639: u->top + u->height <= w->top) { tron@2639: continue; tron@2639: } truelight@158: Darkvater@5416: bring_to_front = true; truelight@0: } Darkvater@5416: Darkvater@5416: if (bring_to_front) BringWindowToFront(w); Darkvater@5416: return true; truelight@0: } truelight@0: Darkvater@5086: /** Handle keyboard input. rubidium@9166: * @param raw_key Lower 8 bits contain the ASCII character, the higher 16 bits the keycode rubidium@8857: */ rubidium@9166: void HandleKeypress(uint32 raw_key) truelight@0: { belugas@8019: /* Stores if a window with a textfield for typing is open belugas@8019: * If this is the case, keypress events are only passed to windows with text fields and belugas@8019: * to thein this main toolbar. */ belugas@8019: bool query_open = false; truelight@158: Darkvater@5086: /* Darkvater@5086: * During the generation of the world, there might be Darkvater@5086: * another thread that is currently building for example Darkvater@5086: * a road. To not interfere with those tasks, we should Darkvater@5086: * NOT change the _current_player here. Darkvater@5086: * Darkvater@5086: * This is not necessary either, as the only events that Darkvater@5086: * can be handled are the 'close application' events Darkvater@5086: */ Darkvater@5086: if (!IsGeneratingWorld()) _current_player = _local_player; Darkvater@5086: belugas@6432: /* Setup event */ rubidium@9166: uint16 key = GB(raw_key, 0, 16); rubidium@9166: uint16 keycode = GB(raw_key, 16, 16); truelight@0: egladil@8177: /* egladil@8177: * The Unicode standard defines an area called the private use area. Code points in this egladil@8177: * area are reserved for private use and thus not portable between systems. For instance, egladil@8177: * Apple defines code points for the arrow keys in this area, but these are only printable egladil@8177: * on a system running OS X. We don't want these keys to show up in text fields and such, egladil@8177: * and thus we have to clear the unicode character when we encounter such a key. egladil@8177: */ rubidium@9166: if (key >= 0xE000 && key <= 0xF8FF) key = 0; egladil@8177: egladil@8177: /* egladil@8177: * If both key and keycode is zero, we don't bother to process the event. egladil@8177: */ rubidium@9166: if (key == 0 && keycode == 0) return; egladil@8177: belugas@8019: /* check if we have a query string window open before allowing hotkeys */ belugas@8019: if (FindWindowById(WC_QUERY_STRING, 0) != NULL || belugas@8019: FindWindowById(WC_SEND_NETWORK_MSG, 0) != NULL || belugas@8019: FindWindowById(WC_GENERATE_LANDSCAPE, 0) != NULL || belugas@8019: FindWindowById(WC_CONSOLE, 0) != NULL || belugas@8019: FindWindowById(WC_SAVELOAD, 0) != NULL || belugas@8019: FindWindowById(WC_COMPANY_PASSWORD_WINDOW, 0) != NULL) { belugas@8019: query_open = true; belugas@8019: } belugas@8019: belugas@6432: /* Call the event, start with the uppermost window. */ rubidium@8857: for (Window* const *wz = _last_z_window; wz != _z_windows;) { Darkvater@5124: Window *w = *--wz; Darkvater@5124: belugas@8019: /* if a query window is open, only call the event for certain window types */ belugas@8019: if (query_open && belugas@8019: w->window_class != WC_QUERY_STRING && belugas@8019: w->window_class != WC_SEND_NETWORK_MSG && belugas@8019: w->window_class != WC_GENERATE_LANDSCAPE && belugas@8019: w->window_class != WC_CONSOLE && belugas@8019: w->window_class != WC_SAVELOAD && belugas@8019: w->window_class != WC_COMPANY_PASSWORD_WINDOW) { dominik@651: continue; tron@2639: } rubidium@9285: if (w->OnKeyPress(key, keycode) == Window::ES_HANDLED) return; truelight@0: } Darkvater@1637: rubidium@9166: Window *w = FindWindowById(WC_MAIN_TOOLBAR, 0); rubidium@9166: /* When there is no toolbar w is null, check for that */ rubidium@9166: if (w != NULL) w->OnKeyPress(key, keycode); truelight@0: } truelight@0: rubidium@8857: /** rubidium@8857: * State of CONTROL key has changed rubidium@8857: */ smatz@8586: void HandleCtrlChanged() smatz@8586: { smatz@8586: /* Call the event, start with the uppermost window. */ smatz@8586: for (Window* const *wz = _last_z_window; wz != _z_windows;) { smatz@8586: Window *w = *--wz; rubidium@9285: if (w->OnCTRLStateChange() == Window::ES_HANDLED) return; smatz@8586: } smatz@8586: } smatz@8586: rubidium@8857: /** rubidium@8857: * Local counter that is incremented each time an mouse input event is detected. rubidium@8857: * The counter is used to stop auto-scrolling. rubidium@8857: * @see HandleAutoscroll() rubidium@8857: * @see HandleMouseEvents() rubidium@8857: */ Darkvater@5090: static int _input_events_this_tick = 0; Darkvater@5090: rubidium@8857: /** rubidium@8857: * If needed and switched on, perform auto scrolling (automatically rubidium@8857: * moving window contents when mouse is near edge of the window). rubidium@8857: */ rubidium@6247: static void HandleAutoscroll() Darkvater@5090: { Darkvater@5090: if (_input_events_this_tick != 0) { Darkvater@5090: /* HandleAutoscroll is called only once per GameLoop() - so we can clear the counter here */ Darkvater@5090: _input_events_this_tick = 0; Darkvater@5090: /* there were some inputs this tick, don't scroll ??? */ Darkvater@5090: return; Darkvater@5090: } Darkvater@5090: Darkvater@5090: if (_patches.autoscroll && _game_mode != GM_MENU && !IsGeneratingWorld()) { rubidium@9124: int x = _cursor.pos.x; rubidium@9124: int y = _cursor.pos.y; rubidium@9124: Window *w = FindWindowFromPt(x, y); Darkvater@5090: if (w == NULL || w->flags4 & WF_DISABLE_VP_SCROLL) return; rubidium@9124: ViewPort *vp = IsPtInWindowViewport(w, x, y); Darkvater@5090: if (vp != NULL) { Darkvater@5090: x -= vp->left; Darkvater@5090: y -= vp->top; rubidium@9124: belugas@6432: /* here allows scrolling in both x and y axis */ Darkvater@5090: #define scrollspeed 3 Darkvater@5090: if (x - 15 < 0) { glx@9184: w->viewport->dest_scrollpos_x += ScaleByZoom((x - 15) * scrollspeed, vp->zoom); Darkvater@5090: } else if (15 - (vp->width - x) > 0) { glx@9184: w->viewport->dest_scrollpos_x += ScaleByZoom((15 - (vp->width - x)) * scrollspeed, vp->zoom); Darkvater@5090: } Darkvater@5090: if (y - 15 < 0) { glx@9184: w->viewport->dest_scrollpos_y += ScaleByZoom((y - 15) * scrollspeed, vp->zoom); Darkvater@5090: } else if (15 - (vp->height - y) > 0) { glx@9184: w->viewport->dest_scrollpos_y += ScaleByZoom((15 - (vp->height - y)) * scrollspeed, vp->zoom); Darkvater@5090: } Darkvater@5090: #undef scrollspeed Darkvater@5090: } Darkvater@5090: } Darkvater@5090: } Darkvater@5090: truelight@7009: enum MouseClick { truelight@7009: MC_NONE = 0, truelight@7009: MC_LEFT, truelight@7009: MC_RIGHT, truelight@7009: MC_DOUBLE_LEFT, truelight@7009: truelight@7018: MAX_OFFSET_DOUBLE_CLICK = 5, ///< How much the mouse is allowed to move to call it a double click truelight@7018: TIME_BETWEEN_DOUBLE_CLICK = 500, ///< Time between 2 left clicks before it becoming a double click, in ms truelight@7009: }; truelight@7009: rubidium@8995: extern void UpdateTileSelection(); rubidium@8995: extern bool VpHandlePlaceSizingDrag(); rubidium@8995: truelight@7009: void MouseLoop(MouseClick click, int mousewheel) truelight@0: { truelight@0: DecreaseWindowCounters(); truelight@0: HandlePlacePresize(); truelight@0: UpdateTileSelection(); tron@2639: if (!VpHandlePlaceSizingDrag()) return; tron@2639: if (!HandleDragDrop()) return; tron@2639: if (!HandleWindowDragging()) return; tron@2639: if (!HandleScrollbarScrolling()) return; tron@2639: if (!HandleViewportScroll()) return; tron@2639: if (!HandleMouseOver()) return; truelight@543: rubidium@9124: bool scrollwheel_scrolling = _patches.scrollwheel_scrolling == 1 && (_cursor.v_wheel != 0 || _cursor.h_wheel != 0); truelight@7009: if (click == MC_NONE && mousewheel == 0 && !scrollwheel_scrolling) return; truelight@0: rubidium@9124: int x = _cursor.pos.x; rubidium@9124: int y = _cursor.pos.y; rubidium@9124: Window *w = FindWindowFromPt(x, y); tron@2639: if (w == NULL) return; rubidium@9124: Darkvater@5416: if (!MaybeBringWindowToFront(w)) return; rubidium@9124: ViewPort *vp = IsPtInWindowViewport(w, x, y); truelight@0: truelight@4337: /* Don't allow any action in a viewport if either in menu of in generating world */ truelight@4337: if (vp != NULL && (_game_mode == GM_MENU || IsGeneratingWorld())) return; truelight@158: truelight@4337: if (mousewheel != 0) { bjarni@6296: if (_patches.scrollwheel_scrolling == 0) { rubidium@9264: /* Send mousewheel event to window */ rubidium@9166: w->OnMouseWheel(mousewheel); bjarni@6296: } truelight@4337: truelight@4337: /* Dispatch a MouseWheelEvent for widgets if it is not a viewport */ truelight@4337: if (vp == NULL) DispatchMouseWheelEvent(w, GetWidgetFromPos(w, x - w->left, y - w->top), mousewheel); truelight@4337: } truelight@4337: truelight@4337: if (vp != NULL) { truelight@7009: if (scrollwheel_scrolling) click = MC_RIGHT; // we are using the scrollwheel in a viewport, so we emulate right mouse button truelight@4337: switch (click) { truelight@7009: case MC_DOUBLE_LEFT: truelight@7009: case MC_LEFT: Darkvater@5380: DEBUG(misc, 2, "Cursor: 0x%X (%d)", _cursor.sprite, _cursor.sprite); smatz@7918: if (_thd.place_mode != VHM_NONE && belugas@6432: /* query button and place sign button work in pause mode */ truelight@4337: _cursor.sprite != SPR_CURSOR_QUERY && truelight@4337: _cursor.sprite != SPR_CURSOR_SIGN && truelight@6231: _pause_game != 0 && truelight@4337: !_cheats.build_in_pause.value) { truelight@4337: return; truelight@4337: } truelight@4337: smatz@7918: if (_thd.place_mode == VHM_NONE) { truelight@4337: HandleViewportClicked(vp, x, y); truelight@4337: } else { truelight@4337: PlaceObject(); truelight@4337: } truelight@4337: break; truelight@4337: truelight@7009: case MC_RIGHT: truelight@4337: if (!(w->flags4 & WF_DISABLE_VP_SCROLL)) { truelight@4337: _scrolling_viewport = true; truelight@4337: _cursor.fix_at = true; truelight@4337: } truelight@4337: break; truelight@7009: truelight@7009: default: truelight@7009: break; truelight@0: } truelight@0: } else { tron@2631: switch (click) { rubidium@9138: case MC_DOUBLE_LEFT: rubidium@9138: DispatchLeftClickEvent(w, x - w->left, y - w->top, true); rubidium@9138: if (_mouseover_last_w == NULL) break; // The window got removed. rubidium@9138: /* fallthough, and also give a single-click for backwards compatibility */ rubidium@9138: case MC_LEFT: rubidium@9138: DispatchLeftClickEvent(w, x - w->left, y - w->top, false); rubidium@9138: break; rubidium@9138: bjarni@6290: default: bjarni@6290: if (!scrollwheel_scrolling || w == NULL || w->window_class != WC_SMALLMAP) break; bjarni@6290: /* We try to use the scrollwheel to scroll since we didn't touch any of the buttons. bjarni@6290: * Simulate a right button click so we can get started. */ bjarni@6290: /* fallthough */ truelight@7009: case MC_RIGHT: DispatchRightClickEvent(w, x - w->left, y - w->top); break; tron@2631: } truelight@0: } truelight@0: } truelight@0: rubidium@8857: /** rubidium@8857: * Handle a mouse event from the video driver rubidium@8857: */ rubidium@6247: void HandleMouseEvents() pasky@1570: { truelight@7009: static int double_click_time = 0; truelight@7009: static int double_click_x = 0; truelight@7009: static int double_click_y = 0; pasky@1570: truelight@4300: /* truelight@4300: * During the generation of the world, there might be truelight@4300: * another thread that is currently building for example truelight@4300: * a road. To not interfere with those tasks, we should truelight@4300: * NOT change the _current_player here. truelight@4300: * truelight@4300: * This is not necessary either, as the only events that truelight@4300: * can be handled are the 'close application' events truelight@4300: */ truelight@4300: if (!IsGeneratingWorld()) _current_player = _local_player; pasky@1570: belugas@6432: /* Mouse event? */ rubidium@9124: MouseClick click = MC_NONE; pasky@1570: if (_left_button_down && !_left_button_clicked) { truelight@7009: click = MC_LEFT; truelight@7018: if (double_click_time != 0 && _realtime_tick - double_click_time < TIME_BETWEEN_DOUBLE_CLICK && truelight@7009: double_click_x != 0 && abs(_cursor.pos.x - double_click_x) < MAX_OFFSET_DOUBLE_CLICK && truelight@7009: double_click_y != 0 && abs(_cursor.pos.y - double_click_y) < MAX_OFFSET_DOUBLE_CLICK) { truelight@7009: click = MC_DOUBLE_LEFT; truelight@7009: } truelight@7018: double_click_time = _realtime_tick; truelight@7009: double_click_x = _cursor.pos.x; truelight@7009: double_click_y = _cursor.pos.y; pasky@1570: _left_button_clicked = true; Darkvater@5090: _input_events_this_tick++; pasky@1570: } else if (_right_button_clicked) { pasky@1570: _right_button_clicked = false; truelight@7009: click = MC_RIGHT; Darkvater@5090: _input_events_this_tick++; pasky@1570: } pasky@1570: rubidium@9124: int mousewheel = 0; pasky@1570: if (_cursor.wheel) { pasky@1570: mousewheel = _cursor.wheel; pasky@1570: _cursor.wheel = 0; Darkvater@5090: _input_events_this_tick++; pasky@1570: } pasky@1570: pasky@1570: MouseLoop(click, mousewheel); pasky@1570: } pasky@1570: rubidium@8857: /** rubidium@8857: * Regular call from the global game loop rubidium@8857: */ rubidium@6247: void InputLoop() Darkvater@5090: { Darkvater@5090: HandleMouseEvents(); Darkvater@5090: HandleAutoscroll(); Darkvater@5090: } Darkvater@5090: rubidium@8857: /** rubidium@8857: * Update the continuously changing contents of the windows, such as the viewports rubidium@8857: */ rubidium@6247: void UpdateWindows() truelight@0: { Darkvater@5124: Window* const *wz; Darkvater@5089: static int we4_timer = 0; Darkvater@5089: int t = we4_timer + 1; truelight@0: tron@2639: if (t >= 100) { Darkvater@5124: for (wz = _last_z_window; wz != _z_windows;) { rubidium@9166: (*--wz)->OnHundredthTick(); truelight@0: } truelight@0: t = 0; truelight@0: } Darkvater@5089: we4_timer = t; truelight@0: Darkvater@5124: for (wz = _last_z_window; wz != _z_windows;) { Darkvater@5124: Window *w = *--wz; truelight@0: if (w->flags4 & WF_WHITE_BORDER_MASK) { truelight@0: w->flags4 -= WF_WHITE_BORDER_ONE; Darkvater@5120: rubidium@9116: if (!(w->flags4 & WF_WHITE_BORDER_MASK)) w->SetDirty(); truelight@0: } truelight@0: } truelight@0: truelight@0: DrawDirtyBlocks(); truelight@0: Darkvater@5124: FOR_ALL_WINDOWS(wz) { Darkvater@5124: if ((*wz)->viewport != NULL) UpdateViewportPosition(*wz); truelight@0: } rubidium@7454: DrawChatMessage(); belugas@6432: /* Redraw mouse cursor in case it was hidden */ truelight@0: DrawMouseCursor(); truelight@158: } truelight@0: rubidium@8857: /** rubidium@8992: * Mark window as dirty (in need of repainting) rubidium@8992: * @param cls Window class rubidium@8992: * @param number Window number in that class rubidium@8857: */ tron@2788: void InvalidateWindow(WindowClass cls, WindowNumber number) truelight@0: { Darkvater@5137: Window* const *wz; truelight@0: Darkvater@5124: FOR_ALL_WINDOWS(wz) { Darkvater@5124: const Window *w = *wz; rubidium@9116: if (w->window_class == cls && w->window_number == number) w->SetDirty(); truelight@0: } truelight@0: } truelight@0: rubidium@8992: /** rubidium@8857: * Mark a particular widget in a particular window as dirty (in need of repainting) rubidium@8857: * @param cls Window class rubidium@8857: * @param number Window number in that class rubidium@8857: * @param widget_index Index number of the widget that needs repainting rubidium@8857: */ tron@2788: void InvalidateWindowWidget(WindowClass cls, WindowNumber number, byte widget_index) truelight@0: { Darkvater@5137: Window* const *wz; truelight@0: Darkvater@5124: FOR_ALL_WINDOWS(wz) { Darkvater@5124: const Window *w = *wz; tron@2639: if (w->window_class == cls && w->window_number == number) { glx@8028: w->InvalidateWidget(widget_index); truelight@0: } truelight@0: } truelight@0: } truelight@0: rubidium@8992: /** rubidium@8857: * Mark all windows of a particular class as dirty (in need of repainting) rubidium@8857: * @param cls Window class rubidium@8857: */ tron@2788: void InvalidateWindowClasses(WindowClass cls) truelight@0: { Darkvater@5137: Window* const *wz; tron@2639: Darkvater@5124: FOR_ALL_WINDOWS(wz) { rubidium@9116: if ((*wz)->window_class == cls) (*wz)->SetDirty(); truelight@0: } truelight@0: } truelight@0: rubidium@8857: /** rubidium@8857: * Mark window data as invalid (in need of re-computing) rubidium@8857: * @param w Window with invalid data rubidium@8857: */ rubidium@9165: void InvalidateThisWindowData(Window *w, int data) bjarni@4766: { rubidium@9166: w->OnInvalidateData(data); rubidium@9116: w->SetDirty(); bjarni@4766: } bjarni@4766: rubidium@8857: /** rubidium@8992: * Mark window data of the window of a given class and specific window number as invalid (in need of re-computing) rubidium@8857: * @param cls Window class rubidium@8857: * @param number Window number within the class rubidium@8857: */ rubidium@9165: void InvalidateWindowData(WindowClass cls, WindowNumber number, int data) bjarni@4739: { Darkvater@5124: Window* const *wz; bjarni@4739: Darkvater@5124: FOR_ALL_WINDOWS(wz) { Darkvater@5124: Window *w = *wz; rubidium@9165: if (w->window_class == cls && w->window_number == number) InvalidateThisWindowData(w, data); bjarni@4766: } bjarni@4766: } bjarni@4766: rubidium@8857: /** rubidium@8857: * Mark window data of all windows of a given class as invalid (in need of re-computing) rubidium@8857: * @param cls Window class rubidium@8857: */ rubidium@9165: void InvalidateWindowClassesData(WindowClass cls, int data) bjarni@4766: { Darkvater@5124: Window* const *wz; bjarni@4766: Darkvater@5124: FOR_ALL_WINDOWS(wz) { rubidium@9165: if ((*wz)->window_class == cls) InvalidateThisWindowData(*wz, data); bjarni@4739: } bjarni@4739: } truelight@0: rubidium@8857: /** rubidium@8857: * Dispatch WE_TICK event over all windows rubidium@8857: */ rubidium@6247: void CallWindowTickEvent() truelight@0: { rubidium@8995: for (Window * const *wz = _last_z_window; wz != _z_windows;) { rubidium@9166: (*--wz)->OnTick(); truelight@0: } truelight@0: } truelight@0: rubidium@8995: /** rubidium@8995: * Try to delete a non-vital window. rubidium@8995: * Non-vital windows are windows other than the game selection, main toolbar, rubidium@8995: * status bar, toolbar menu, and tooltip windows. Stickied windows are also rubidium@8995: * considered vital. rubidium@8995: */ rubidium@6247: void DeleteNonVitalWindows() truelight@0: { Darkvater@5124: Window* const *wz; tron@2639: Darkvater@5121: restart_search: Darkvater@5121: /* When we find the window to delete, we need to restart the search Darkvater@5124: * as deleting this window could cascade in deleting (many) others Darkvater@5124: * anywhere in the z-array */ Darkvater@5124: FOR_ALL_WINDOWS(wz) { Darkvater@5124: Window *w = *wz; truelight@0: if (w->window_class != WC_MAIN_WINDOW && truelight@0: w->window_class != WC_SELECT_GAME && truelight@0: w->window_class != WC_MAIN_TOOLBAR && truelight@0: w->window_class != WC_STATUS_BAR && truelight@0: w->window_class != WC_TOOLBAR_MENU && darkvater@682: w->window_class != WC_TOOLTIPS && darkvater@682: (w->flags4 & WF_STICKY) == 0) { // do not delete windows which are 'pinned' Darkvater@5124: rubidium@9115: delete w; Darkvater@5121: goto restart_search; truelight@0: } truelight@0: } truelight@0: } truelight@0: belugas@6443: /** It is possible that a stickied window gets to a position where the darkvater@763: * 'close' button is outside the gaming area. You cannot close it then; except darkvater@763: * with this function. It closes all windows calling the standard function, darkvater@763: * then, does a little hacked loop of closing all stickied windows. Note darkvater@763: * that standard windows (status bar, etc.) are not stickied, so these aren't affected */ rubidium@6247: void DeleteAllNonVitalWindows() darkvater@763: { Darkvater@5124: Window* const *wz; tron@2639: Darkvater@5121: /* Delete every window except for stickied ones, then sticky ones as well */ darkvater@763: DeleteNonVitalWindows(); Darkvater@5124: Darkvater@5121: restart_search: Darkvater@5121: /* When we find the window to delete, we need to restart the search Darkvater@5124: * as deleting this window could cascade in deleting (many) others Darkvater@5124: * anywhere in the z-array */ Darkvater@5124: FOR_ALL_WINDOWS(wz) { Darkvater@5124: if ((*wz)->flags4 & WF_STICKY) { rubidium@9115: delete *wz; Darkvater@5121: goto restart_search; tron@4077: } darkvater@763: } darkvater@763: } darkvater@763: belugas@6443: /** Delete all always on-top windows to get an empty screen */ rubidium@6247: void HideVitalWindows() darkvater@983: { rubidium@5907: DeleteWindowById(WC_TOOLBAR_MENU, 0); darkvater@983: DeleteWindowById(WC_MAIN_TOOLBAR, 0); darkvater@983: DeleteWindowById(WC_STATUS_BAR, 0); darkvater@983: } darkvater@983: rubidium@8857: /** rubidium@8857: * (Re)position main toolbar window at the screen rubidium@8857: * @param w Window structure of the main toolbar window, may also be \c NULL rubidium@8857: * @return X coordinate of left edge of the repositioned toolbar window rubidium@8857: */ truelight@158: int PositionMainToolbar(Window *w) darkvater@68: { Darkvater@5380: DEBUG(misc, 5, "Repositioning Main Toolbar..."); darkvater@68: tron@4077: if (w == NULL || w->window_class != WC_MAIN_TOOLBAR) { darkvater@68: w = FindWindowById(WC_MAIN_TOOLBAR, 0); tron@4077: } darkvater@68: darkvater@68: switch (_patches.toolbar_pos) { Darkvater@5071: case 1: w->left = (_screen.width - w->width) / 2; break; tron@2026: case 2: w->left = _screen.width - w->width; break; tron@2026: default: w->left = 0; darkvater@68: } darkvater@68: SetDirtyBlocks(0, 0, _screen.width, w->height); // invalidate the whole top part darkvater@68: return w->left; darkvater@68: } darkvater@68: rubidium@8857: /** rubidium@8857: * Relocate all windows to fit the new size of the game application screen rubidium@8857: * @param neww New width of the game application screen rubidium@8857: * @param newh New height of the game appliction screen rubidium@8857: */ truelight@0: void RelocateAllWindows(int neww, int newh) truelight@0: { Darkvater@5124: Window* const *wz; truelight@0: Darkvater@5124: FOR_ALL_WINDOWS(wz) { Darkvater@5124: Window *w = *wz; truelight@0: int left, top; truelight@158: truelight@0: if (w->window_class == WC_MAIN_WINDOW) { truelight@0: ViewPort *vp = w->viewport; truelight@0: vp->width = w->width = neww; truelight@0: vp->height = w->height = newh; truelight@6626: vp->virtual_width = ScaleByZoom(neww, vp->zoom); truelight@6626: vp->virtual_height = ScaleByZoom(newh, vp->zoom); truelight@0: continue; // don't modify top,left darkvater@152: } darkvater@152: Darkvater@5126: /* XXX - this probably needs something more sane. For example specying Darkvater@5126: * in a 'backup'-desc that the window should always be centred. */ tron@2989: switch (w->window_class) { tron@2989: case WC_MAIN_TOOLBAR: rubidium@7362: if (neww - w->width != 0) { rubidium@7362: ResizeWindow(w, min(neww, 640) - w->width, 0); rubidium@7362: rubidium@9166: Point size; rubidium@9166: Point delta; rubidium@9166: size.x = w->width; rubidium@9166: size.y = w->height; rubidium@9166: delta.x = neww - w->width; rubidium@9166: delta.y = 0; rubidium@9166: w->OnResize(size, delta); rubidium@7362: } rubidium@7362: tron@2989: top = w->top; tron@2989: left = PositionMainToolbar(w); // changes toolbar orientation tron@2989: break; tron@2989: tron@2989: case WC_SELECT_GAME: tron@2989: case WC_GAME_OPTIONS: tron@2989: case WC_NETWORK_WINDOW: tron@2989: top = (newh - w->height) >> 1; tron@2989: left = (neww - w->width) >> 1; tron@2989: break; tron@2989: tron@2989: case WC_NEWS_WINDOW: tron@2989: top = newh - w->height; tron@2989: left = (neww - w->width) >> 1; tron@2989: break; tron@2989: tron@2989: case WC_STATUS_BAR: skidd13@7922: ResizeWindow(w, Clamp(neww, 320, 640) - w->width, 0); tron@2989: top = newh - w->height; tron@2989: left = (neww - w->width) >> 1; tron@2989: break; tron@2989: tron@2989: case WC_SEND_NETWORK_MSG: skidd13@7922: ResizeWindow(w, Clamp(neww, 320, 640) - w->width, 0); tron@2989: top = (newh - 26); // 26 = height of status bar + height of chat bar tron@2989: left = (neww - w->width) >> 1; tron@2989: break; tron@2989: Darkvater@5126: case WC_CONSOLE: Darkvater@5143: IConsoleResize(w); Darkvater@5137: continue; Darkvater@5126: smatz@8698: default: { tron@2989: left = w->left; tron@2989: if (left + (w->width >> 1) >= neww) left = neww - w->width; rubidium@8023: if (left < 0) left = 0; rubidium@8023: tron@2989: top = w->top; tron@2989: if (top + (w->height >> 1) >= newh) top = newh - w->height; smatz@8698: smatz@8698: const Window *wt = FindWindowById(WC_MAIN_TOOLBAR, 0); smatz@8698: if (wt != NULL) { rubidium@8940: if (top < wt->height && wt->left < (w->left + w->width) && (wt->left + wt->width) > w->left) top = wt->height; smatz@8698: if (top >= newh) top = newh - 1; smatz@8698: } else { smatz@8698: if (top < 0) top = 0; smatz@8698: } smatz@8698: } break; truelight@0: } truelight@0: tron@2639: if (w->viewport != NULL) { truelight@0: w->viewport->left += left - w->left; truelight@0: w->viewport->top += top - w->top; truelight@0: } truelight@0: truelight@0: w->left = left; truelight@0: w->top = top; truelight@0: } truelight@0: } belugas@9267: belugas@9267: /** Destructor of the base class PickerWindowBase belugas@9267: * Main utility is to stop the base Window destructor from triggering belugas@9267: * a free while the child will already be free, in this case by the ResetObjectToPlace(). belugas@9267: */ belugas@9267: PickerWindowBase::~PickerWindowBase() belugas@9267: { belugas@9267: this->window_class = WC_INVALID; // stop the ancestor from freeing the already (to be) child belugas@9267: ResetObjectToPlace(); belugas@9267: }