KiCad PCB EDA Suite
Loading...
Searching...
No Matches
ui.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2020 Ian McInerney <Ian.S.McInerney at ieee.org>
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software: you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation, either version 3 of the License, or (at your
10 * option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
19 */
20
21#ifndef KIPLATFORM_UI_H_
22#define KIPLATFORM_UI_H_
23
24#include <wx/cursor.h>
25
26class wxChoice;
27class wxDataViewColumn;
28class wxDataViewCtrl;
29class wxDialog;
30class wxKeyEvent;
31class wxNonOwnedWindow;
32class wxTopLevelWindow;
33class wxWindow;
34
35namespace KIPLATFORM
36{
37 namespace UI
38 {
44 bool IsDarkTheme();
45
46 wxColour GetDialogBGColour();
47
55 void ForceFocus( wxWindow* aWindow );
56
63 bool IsWindowActive( wxWindow* aWindow );
64
77 void ReparentModal( wxNonOwnedWindow* aWindow );
78
79 void ReparentWindow( wxNonOwnedWindow* aWindow, wxTopLevelWindow* aParent );
80
81 /*
82 * An ugly hack to fix an issue on OSX: cmd+c closes the dialog instead of copying the
83 * text if a button with wxID_CANCEL is used in a wxStdDialogButtonSizer created by
84 * wxFormBuilder: the label is &Cancel, and this accelerator key has priority over the
85 * standard copy accelerator.
86 * Note: problem also exists in other languages; for instance cmd+a closes dialogs in
87 * German because the button is &Abbrechen.
88 */
89 void FixupCancelButtonCmdKeyCollision( wxWindow* aWindow );
90
96 bool IsStockCursorOk( wxStockCursor aCursor );
97
104 void LargeChoiceBoxHack( wxChoice* aChoice );
105
112 void EllipsizeChoiceBox( wxChoice* aChoice );
113
120 double GetPixelScaleFactor( const wxWindow* aWindow );
121
127 double GetContentScaleFactor( const wxWindow* aWindow );
128
132 double GetDisplayRefreshRate( const wxWindow* aWindow );
133
137 void GetInfoBarColours( wxColour& aFGColour, wxColour& aBGColour );
138
149 wxWindow* CreateCanvasOverlay( wxWindow* aCanvas );
150
157 wxSize GetUnobscuredSize( const wxWindow* aWindow );
158
163 void SetOverlayScrolling( const wxWindow* aWindow, bool overlay );
164
168 bool AllowIconsInMenus();
169
174 bool SupportsKeyState();
175
176 wxKeyEvent GetNativePopupDismissalEvent();
177
178 bool PrepareChoicePopup( wxWindow* aControl );
179
184 wxPoint GetMousePosition();
185
193 bool WarpPointer( wxWindow* aWindow, int aX, int aY );
194
198 void ImmControl( wxWindow* aWindow, bool aEnable );
199
203 void ImeNotifyCancelComposition( wxWindow* aWindow );
204
213 bool InfiniteDragPrepareWindow( wxWindow* aWindow );
214
219
230 void StabilizeWindowPosition( wxWindow* aWindow );
231
242 wxPoint GetRestorablePosition( wxWindow* aWindow );
243
247 void SetFloatLevel( wxWindow* aWindow );
248
259 void ReleaseChildWindow( wxNonOwnedWindow* aWindow );
260
276 void AllowNetworkFileSystems( wxDialog* aDialog );
277
289
302 void CancelPendingScroll( wxDataViewCtrl* aCtrl );
303
311 int GetColumnWidth( const wxDataViewColumn* aColumn );
312
330 void SetWMClass( wxWindow* aWindow, const wxString& aClass );
331
339 void GetNativeWindowHandles( wxWindow* aWindow, void** aHandle, void** aDisplay,
340 int* aDisplayType = nullptr );
341
348 void PrepareForExternalRendering( wxWindow* aWindow );
349
356 void KeepAboveExternalRendering( wxWindow* aChild );
357 }
358}
359
360#endif // KIPLATFORM_UI_H_
wxPoint GetRestorablePosition(wxWindow *aWindow)
Return the point that wxWindow::Move() needs to put a stabilized window back where it is.
Definition wxgtk/ui.cpp:260
double GetDisplayRefreshRate(const wxWindow *aWindow)
Return the refresh rate in Hz of the display showing most of the window, or 0 if unknown.
Definition wxgtk/ui.cpp:477
wxWindow * CreateCanvasOverlay(wxWindow *aCanvas)
Create a window for widgets that are shown over a canvas without taking space from it.
Definition wxgtk/ui.cpp:200
bool AllowIconsInMenus()
If the user has disabled icons system-wide, we check that here.
Definition wxgtk/ui.cpp:510
void GetNativeWindowHandles(wxWindow *aWindow, void **aHandle, void **aDisplay, int *aDisplayType=nullptr)
Get the native handles needed to create a GPU surface for aWindow.
void SetFloatLevel(wxWindow *aWindow)
Intended to set the floating window level in macOS on a window.
Definition wxgtk/ui.cpp:730
void GetInfoBarColours(wxColour &aFGColour, wxColour &aBGColour)
Return the background and foreground colors for info bars in the current scheme.
Definition wxgtk/ui.cpp:76
void ReparentWindow(wxNonOwnedWindow *aWindow, wxTopLevelWindow *aParent)
Definition wxgtk/ui.cpp:370
void ReleaseChildWindow(wxNonOwnedWindow *aWindow)
Release a modal window's parent-child relationship with its parent window.
Definition wxgtk/ui.cpp:735
void EllipsizeChoiceBox(wxChoice *aChoice)
Configure a wxChoice control to ellipsize the shown text in the button with the ellipses placed at th...
Definition wxgtk/ui.cpp:436
void PrepareForExternalRendering(wxWindow *aWindow)
Prepare a realized widget for Vulkan or Metal rendering, before its first present.
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition wxgtk/ui.cpp:376
void SetOverlayScrolling(const wxWindow *aWindow, bool overlay)
Used to set overlay/non-overlay scrolling mode in a window.
Definition wxgtk/ui.cpp:503
wxPoint GetMousePosition()
Returns the mouse position in screen coordinates.
void ImmControl(wxWindow *aWindow, bool aEnable)
Configures the IME mode of a given control handle.
Definition wxgtk/ui.cpp:711
void StabilizeWindowPosition(wxWindow *aWindow)
Prepare a top-level window for reliable position round-tripping.
Definition wxgtk/ui.cpp:248
double GetPixelScaleFactor(const wxWindow *aWindow)
Tries to determine the pixel scaling factor currently in use for the window.
Definition wxgtk/ui.cpp:457
NATIVE_DISPLAY_TYPE
Display server types reported by GetNativeWindowHandles().
Definition ui.h:282
@ DISPLAY_UNKNOWN
Definition ui.h:283
@ DISPLAY_X11
Definition ui.h:284
@ DISPLAY_WIN32
Definition ui.h:286
@ DISPLAY_WAYLAND
Definition ui.h:285
@ DISPLAY_COCOA
Definition ui.h:287
bool PrepareChoicePopup(wxWindow *aControl)
Definition wxgtk/ui.cpp:558
void InfiniteDragReleaseWindow()
On Wayland, allows the cursor to freely move again after a drag (see InfiniteDragPrepareWindow).
int GetColumnWidth(const wxDataViewColumn *aColumn)
The width last asked of aColumn, by SetWidth or by the user dragging its border.
Definition wxgtk/ui.cpp:750
bool IsStockCursorOk(wxStockCursor aCursor)
Checks if we designated a stock cursor for this OS as "OK" or else we may need to load a custom one.
Definition wxgtk/ui.cpp:382
bool SupportsKeyState()
Return whether wxGetKeyState() can query ordinary keys, beyond modifiers and lock keys.
Definition wxgtk/ui.cpp:520
wxKeyEvent GetNativePopupDismissalEvent()
Definition wxgtk/ui.cpp:573
void KeepAboveExternalRendering(wxWindow *aChild)
Keep a child visible on top of a parent prepared with PrepareForExternalRendering().
double GetContentScaleFactor(const wxWindow *aWindow)
Tries to determine the content scaling factor currently in use for the window.
Definition wxgtk/ui.cpp:470
void ImeNotifyCancelComposition(wxWindow *aWindow)
Asks the IME to cancel.
Definition wxgtk/ui.cpp:716
void LargeChoiceBoxHack(wxChoice *aChoice)
Configure a wxChoice control to support a lot of entries by disabling functionality that makes adding...
Definition wxgtk/ui.cpp:418
bool WarpPointer(wxWindow *aWindow, int aX, int aY)
Move the mouse cursor to a specific position relative to the window.
Definition wxgtk/ui.cpp:638
wxColour GetDialogBGColour()
Definition wxgtk/ui.cpp:70
bool IsWindowActive(wxWindow *aWindow)
Check to see if the given window is the currently active window (e.g.
Definition wxgtk/ui.cpp:233
wxSize GetUnobscuredSize(const wxWindow *aWindow)
Tries to determine the size of the viewport of a scrollable widget (wxDataViewCtrl,...
Definition wxgtk/ui.cpp:496
void ForceFocus(wxWindow *aWindow)
Pass the current focus to the window.
Definition wxgtk/ui.cpp:211
bool InfiniteDragPrepareWindow(wxWindow *aWindow)
On Wayland, restricts the pointer movement to a rectangle slightly bigger than the given wxWindow.
void SetWMClass(wxWindow *aWindow, const wxString &aClass)
Tag a top-level window with the freedesktop application id of its installed launcher,...
Definition wxgtk/ui.cpp:336
void ReparentModal(wxNonOwnedWindow *aWindow)
Move a window's parent to be the top-level window and force the window to be on top.
Definition wxgtk/ui.cpp:364
void CancelPendingScroll(wxDataViewCtrl *aCtrl)
Cancel any pending scroll-to-item request on aCtrl.
Definition wxgtk/ui.cpp:759
bool IsDarkTheme()
Determine if the desktop interface is currently using a dark theme or a light theme.
Definition wxgtk/ui.cpp:57
void AllowNetworkFileSystems(wxDialog *aDialog)
Configure a file dialog to show network and virtual file systems.
Definition wxgtk/ui.cpp:741
std::shared_ptr< PNS_LOG_VIEWER_OVERLAY > overlay