ui.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2020 Ian McInerney <Ian.S.McInerney at ieee.org>
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef KIPLATFORM_UI_H_
#define KIPLATFORM_UI_H_
 
#include <wx/cursor.h>
 
class wxChoice;
class wxDataViewCtrl;
class wxDialog;
class wxNonOwnedWindow;
class wxTopLevelWindow;
class wxWindow;
 
namespace KIPLATFORM
{
    namespace UI
    {
        bool IsDarkTheme();
 
        wxColour GetDialogBGColour();

        void ForceFocus( wxWindow* aWindow );

        bool IsWindowActive( wxWindow* aWindow );

        void ReparentModal( wxNonOwnedWindow* aWindow );
 
        void ReparentWindow( wxNonOwnedWindow* aWindow, wxTopLevelWindow* aParent );
 
        /*
         * An ugly hack to fix an issue on OSX: cmd+c closes the dialog instead of copying the
         * text if a button with wxID_CANCEL is used in a wxStdDialogButtonSizer created by
         * wxFormBuilder: the label is &Cancel, and this accelerator key has priority over the
         * standard copy accelerator.
         * Note: problem also exists in other languages; for instance cmd+a closes dialogs in
         * German because the button is &Abbrechen.
         */
        void FixupCancelButtonCmdKeyCollision( wxWindow* aWindow );

        bool IsStockCursorOk( wxStockCursor aCursor );

        void LargeChoiceBoxHack( wxChoice* aChoice );

        void EllipsizeChoiceBox( wxChoice* aChoice );

        double GetPixelScaleFactor( const wxWindow* aWindow );

        double GetContentScaleFactor( const wxWindow* aWindow );

        double GetDisplayRefreshRate( const wxWindow* aWindow );

        void GetInfoBarColours( wxColour& aFGColour, wxColour& aBGColour );

        wxWindow* CreateCanvasOverlay( wxWindow* aCanvas );

        wxSize GetUnobscuredSize( const wxWindow* aWindow );

        void SetOverlayScrolling( const wxWindow* aWindow, bool overlay );

        bool AllowIconsInMenus();

        bool SupportsKeyState();

        wxPoint GetMousePosition();

        bool WarpPointer( wxWindow* aWindow, int aX, int aY );

        void ImmControl( wxWindow* aWindow, bool aEnable );

        void ImeNotifyCancelComposition( wxWindow* aWindow );

        bool InfiniteDragPrepareWindow( wxWindow* aWindow );

        void InfiniteDragReleaseWindow();

        void EnsureVisible( wxWindow* aWindow );

        void StabilizeWindowPosition( wxWindow* aWindow );

        void SetFloatLevel( wxWindow* aWindow );

        void ReleaseChildWindow( wxNonOwnedWindow* aWindow );

        void AllowNetworkFileSystems( wxDialog* aDialog );

        enum NATIVE_DISPLAY_TYPE
        {
            DISPLAY_UNKNOWN  = 0,
            DISPLAY_X11      = 1,
            DISPLAY_WAYLAND  = 2,
            DISPLAY_WIN32    = 3,
            DISPLAY_COCOA    = 4,
        };

        void CancelPendingScroll( wxDataViewCtrl* aCtrl );

        void SetWMClass( wxWindow* aWindow, const wxString& aClass );

        void GetNativeWindowHandles( wxWindow* aWindow, void** aHandle, void** aDisplay,
                                     int* aDisplayType = nullptr );

        void PrepareForExternalRendering( wxWindow* aWindow );

        void KeepAboveExternalRendering( wxWindow* aChild );
    }
}
 
#endif // KIPLATFORM_UI_H_