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 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 wxTopLevelWindow;
29class wxWindow;
30
31namespace KIPLATFORM
32{
33 namespace UI
34 {
40 bool IsDarkTheme();
41
42 wxColour GetDialogBGColour();
43
51 void ForceFocus( wxWindow* aWindow );
52
59 bool IsWindowActive( wxWindow* aWindow );
60
73 void ReparentModal( wxNonOwnedWindow* aWindow );
74
75 void ReparentWindow( wxNonOwnedWindow* aWindow, wxTopLevelWindow* aParent );
76
77 /*
78 * An ugly hack to fix an issue on OSX: cmd+c closes the dialog instead of copying the
79 * text if a button with wxID_CANCEL is used in a wxStdDialogButtonSizer created by
80 * wxFormBuilder: the label is &Cancel, and this accelerator key has priority over the
81 * standard copy accelerator.
82 * Note: problem also exists in other languages; for instance cmd+a closes dialogs in
83 * German because the button is &Abbrechen.
84 */
85 void FixupCancelButtonCmdKeyCollision( wxWindow* aWindow );
86
92 bool IsStockCursorOk( wxStockCursor aCursor );
93
100 void LargeChoiceBoxHack( wxChoice* aChoice );
101
108 void EllipsizeChoiceBox( wxChoice* aChoice );
109
116 double GetPixelScaleFactor( const wxWindow* aWindow );
117
123 double GetContentScaleFactor( const wxWindow* aWindow );
124
128 void GetInfoBarColours( wxColour& aFGColour, wxColour& aBGColour );
129
136 wxSize GetUnobscuredSize( const wxWindow* aWindow );
137
142 void SetOverlayScrolling( const wxWindow* aWindow, bool overlay );
143
147 bool AllowIconsInMenus();
148
153 wxPoint GetMousePosition();
154
162 bool WarpPointer( wxWindow* aWindow, int aX, int aY );
163
167 void ImmControl( wxWindow* aWindow, bool aEnable );
168
172 void ImeNotifyCancelComposition( wxWindow* aWindow );
173
182 bool InfiniteDragPrepareWindow( wxWindow* aWindow );
183
188
195 void EnsureVisible( wxWindow* aWindow );
196
200 void SetFloatLevel( wxWindow* aWindow );
201 }
202}
203
204#endif // KIPLATFORM_UI_H_
bool AllowIconsInMenus()
If the user has disabled icons system-wide, we check that here.
Definition wxgtk/ui.cpp:278
void SetFloatLevel(wxWindow *aWindow)
Intended to set the floating window level in macOS on a window.
Definition wxgtk/ui.cpp:407
void GetInfoBarColours(wxColour &aFGColour, wxColour &aBGColour)
Return the background and foreground colors for info bars in the current scheme.
Definition wxgtk/ui.cpp:67
void ReparentWindow(wxNonOwnedWindow *aWindow, wxTopLevelWindow *aParent)
Definition wxgtk/ui.cpp:157
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:223
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition wxgtk/ui.cpp:163
void SetOverlayScrolling(const wxWindow *aWindow, bool overlay)
Used to set overlay/non-overlay scrolling mode in a window.
Definition wxgtk/ui.cpp:271
wxPoint GetMousePosition()
Returns the mouse position in screen coordinates.
Definition wxgtk/ui.cpp:689
void ImmControl(wxWindow *aWindow, bool aEnable)
Configures the IME mode of a given control handle.
Definition wxgtk/ui.cpp:388
double GetPixelScaleFactor(const wxWindow *aWindow)
Tries to determine the pixel scaling factor currently in use for the window.
Definition wxgtk/ui.cpp:244
void InfiniteDragReleaseWindow()
On Wayland, allows the cursor to freely move again after a drag (see InfiniteDragPrepareWindow).
Definition wxgtk/ui.cpp:683
void EnsureVisible(wxWindow *aWindow)
Ensure that a window is visible on the screen.
Definition wxgtk/ui.cpp:145
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:169
double GetContentScaleFactor(const wxWindow *aWindow)
Tries to determine the content scaling factor currently in use for the window.
Definition wxgtk/ui.cpp:257
void ImeNotifyCancelComposition(wxWindow *aWindow)
Asks the IME to cancel.
Definition wxgtk/ui.cpp:393
void LargeChoiceBoxHack(wxChoice *aChoice)
Configure a wxChoice control to support a lot of entries by disabling functionality that makes adding...
Definition wxgtk/ui.cpp:205
bool WarpPointer(wxWindow *aWindow, int aX, int aY)
Move the mouse cursor to a specific position relative to the window.
Definition wxgtk/ui.cpp:322
wxColour GetDialogBGColour()
Definition wxgtk/ui.cpp:61
bool IsWindowActive(wxWindow *aWindow)
Check to see if the given window is the currently active window (e.g.
Definition wxgtk/ui.cpp:130
wxSize GetUnobscuredSize(const wxWindow *aWindow)
Tries to determine the size of the viewport of a scrollable widget (wxDataViewCtrl,...
Definition wxgtk/ui.cpp:264
void ForceFocus(wxWindow *aWindow)
Pass the current focus to the window.
Definition wxgtk/ui.cpp:124
bool InfiniteDragPrepareWindow(wxWindow *aWindow)
On Wayland, restricts the pointer movement to a rectangle slightly bigger than the given wxWindow.
Definition wxgtk/ui.cpp:676
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:151
bool IsDarkTheme()
Determine if the desktop interface is currently using a dark theme or a light theme.
Definition wxgtk/ui.cpp:48
std::shared_ptr< PNS_LOG_VIEWER_OVERLAY > overlay