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 (C) 2020 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 along
18 * with this program. If not, see <http://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 wxNonOwnedWindow;
28class wxWindow;
29
30namespace KIPLATFORM
31{
32 namespace UI
33 {
39 bool IsDarkTheme();
40
41 wxColour GetDialogBGColour();
42
50 void ForceFocus( wxWindow* aWindow );
51
58 bool IsWindowActive( wxWindow* aWindow );
59
72 void ReparentQuasiModal( wxNonOwnedWindow* aWindow );
73
74 /*
75 * An ugly hack to fix an issue on OSX: cmd+c closes the dialog instead of copying the
76 * text if a button with wxID_CANCEL is used in a wxStdDialogButtonSizer created by
77 * wxFormBuilder: the label is &Cancel, and this accelerator key has priority over the
78 * standard copy accelerator.
79 * Note: problem also exists in other languages; for instance cmd+a closes dialogs in
80 * German because the button is &Abbrechen.
81 */
82 void FixupCancelButtonCmdKeyCollision( wxWindow* aWindow );
83
89 bool IsStockCursorOk( wxStockCursor aCursor );
90
97 void LargeChoiceBoxHack( wxChoice* aChoice );
98
105 void EllipsizeChoiceBox( wxChoice* aChoice );
106
113 double GetPixelScaleFactor( const wxWindow* aWindow );
114
120 double GetContentScaleFactor( const wxWindow* aWindow );
121
128 wxSize GetUnobscuredSize( const wxWindow* aWindow );
129
134 void SetOverlayScrolling( const wxWindow* aWindow, bool overlay );
135
139 bool AllowIconsInMenus();
140
145 wxPoint GetMousePosition();
146
154 bool WarpPointer( wxWindow* aWindow, int aX, int aY );
155
159 void ImmControl( wxWindow* aWindow, bool aEnable );
160
169 bool InfiniteDragPrepareWindow( wxWindow* aWindow );
170
175
179 void SetFloatLevel( wxWindow* aWindow );
180 }
181}
182
183#endif // KIPLATFORM_UI_H_
bool AllowIconsInMenus()
If the user has disabled icons system-wide, we check that here.
Definition: gtk/ui.cpp:209
void SetFloatLevel(wxWindow *aWindow)
Intended to set the floating window level in macOS on a window.
Definition: gtk/ui.cpp:324
void EllipsizeChoiceBox(wxChoice *aChoice)
Configure a wxChoice control to ellipsize the shown text in the button with the ellipses placed at th...
Definition: gtk/ui.cpp:154
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition: gtk/ui.cpp:94
void SetOverlayScrolling(const wxWindow *aWindow, bool overlay)
Used to set overlay/non-overlay scrolling mode in a window.
Definition: gtk/ui.cpp:202
wxPoint GetMousePosition()
Returns the mouse position in screen coordinates.
Definition: gtk/ui.cpp:606
void ImmControl(wxWindow *aWindow, bool aEnable)
Configures the IME mode of a given control handle.
Definition: gtk/ui.cpp:319
double GetPixelScaleFactor(const wxWindow *aWindow)
Tries to determine the pixel scaling factor currently in use for the window.
Definition: gtk/ui.cpp:175
void InfiniteDragReleaseWindow()
On Wayland, allows the cursor to freely move again after a drag (see InfiniteDragPrepareWindow).
Definition: gtk/ui.cpp:600
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: gtk/ui.cpp:100
double GetContentScaleFactor(const wxWindow *aWindow)
Tries to determine the content scaling factor currently in use for the window.
Definition: gtk/ui.cpp:188
void LargeChoiceBoxHack(wxChoice *aChoice)
Configure a wxChoice control to support a lot of entries by disabling functionality that makes adding...
Definition: gtk/ui.cpp:136
bool WarpPointer(wxWindow *aWindow, int aX, int aY)
Move the mouse cursor to a specific position relative to the window.
Definition: gtk/ui.cpp:253
void ReparentQuasiModal(wxNonOwnedWindow *aWindow)
Move a window's parent to be the top-level window and force the window to be on top.
Definition: gtk/ui.cpp:88
wxColour GetDialogBGColour()
Definition: gtk/ui.cpp:61
bool IsWindowActive(wxWindow *aWindow)
Check to see if the given window is the currently active window (e.g.
Definition: gtk/ui.cpp:73
wxSize GetUnobscuredSize(const wxWindow *aWindow)
Tries to determine the size of the viewport of a scrollable widget (wxDataViewCtrl,...
Definition: gtk/ui.cpp:195
void ForceFocus(wxWindow *aWindow)
Pass the current focus to the window.
Definition: gtk/ui.cpp:67
bool InfiniteDragPrepareWindow(wxWindow *aWindow)
On Wayland, restricts the pointer movement to a rectangle slightly bigger than the given wxWindow.
Definition: gtk/ui.cpp:593
bool IsDarkTheme()
Determine if the desktop interface is currently using a dark theme or a light theme.
Definition: gtk/ui.cpp:48
std::shared_ptr< PNS_LOG_VIEWER_OVERLAY > overlay
Definition: playground.cpp:38