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
48 void ForceFocus( wxWindow* aWindow );
49
56 bool IsWindowActive( wxWindow* aWindow );
57
70 void ReparentQuasiModal( wxNonOwnedWindow* aWindow );
71
72 /*
73 * An ugly hack to fix an issue on OSX: cmd+c closes the dialog instead of copying the
74 * text if a button with wxID_CANCEL is used in a wxStdDialogButtonSizer created by
75 * wxFormBuilder: the label is &Cancel, and this accelerator key has priority over the
76 * standard copy accelerator.
77 * Note: problem also exists in other languages; for instance cmd+a closes dialogs in
78 * German because the button is &Abbrechen.
79 */
80 void FixupCancelButtonCmdKeyCollision( wxWindow* aWindow );
81
87 bool IsStockCursorOk( wxStockCursor aCursor );
88
95 void LargeChoiceBoxHack( wxChoice* aChoice );
96
103 void EllipsizeChoiceBox( wxChoice* aChoice );
104
111 double GetPixelScaleFactor( const wxWindow* aWindow );
112
118 double GetContentScaleFactor( const wxWindow* aWindow );
119
126 wxSize GetUnobscuredSize( const wxWindow* aWindow );
127
132 void SetOverlayScrolling( const wxWindow* aWindow, bool overlay );
133
137 bool AllowIconsInMenus();
138
145 void WarpPointer( wxWindow* aWindow, int aX, int aY );
146
150 void ImmControl( wxWindow* aWindow, bool aEnable );
151 }
152}
153
154#endif // KIPLATFORM_UI_H_
bool AllowIconsInMenus()
If the user has disabled icons system-wide, we check that here.
Definition: gtk/ui.cpp:186
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:131
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition: gtk/ui.cpp:71
void SetOverlayScrolling(const wxWindow *aWindow, bool overlay)
Used to set overlay/non-overlay scrolling mode in a window.
Definition: gtk/ui.cpp:179
void ImmControl(wxWindow *aWindow, bool aEnable)
Configures the IME mode of a given control handle.
Definition: gtk/ui.cpp:221
double GetPixelScaleFactor(const wxWindow *aWindow)
Tries to determine the pixel scaling factor currently in use for the window.
Definition: gtk/ui.cpp:152
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:77
double GetContentScaleFactor(const wxWindow *aWindow)
Tries to determine the content scaling factor currently in use for the window.
Definition: gtk/ui.cpp:165
void WarpPointer(wxWindow *aWindow, int aX, int aY)
Move the mouse cursor to a specific position relative to the window.
Definition: gtk/ui.cpp:196
void LargeChoiceBoxHack(wxChoice *aChoice)
Configure a wxChoice control to support a lot of entries by disabling functionality that makes adding...
Definition: gtk/ui.cpp:113
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:65
bool IsWindowActive(wxWindow *aWindow)
Check to see if the given window is the currently active window (e.g.
Definition: gtk/ui.cpp:50
wxSize GetUnobscuredSize(const wxWindow *aWindow)
Tries to determine the size of the viewport of a scrollable widget (wxDataViewCtrl,...
Definition: gtk/ui.cpp:172
void ForceFocus(wxWindow *aWindow)
Pass the current focus to the window.
Definition: gtk/ui.cpp:44
bool IsDarkTheme()
Determine if the desktop interface is currently using a dark theme or a light theme.
Definition: gtk/ui.cpp:31
Definition: app.h:28
std::shared_ptr< PNS_LOG_VIEWER_OVERLAY > overlay
Definition: playground.cpp:36