wxmsw/ui.cpp

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/>.
 */
 
#include <windows.h>
 
#include <kiplatform/ui.h>
 
#include <wx/cursor.h>
#include <wx/dialog.h>
#include <wx/display.h>
#include <wx/nonownedwnd.h>
#include <wx/window.h>
#include <wx/msw/registry.h>
 
 
bool KIPLATFORM::UI::IsDarkTheme()
{
#if wxCHECK_VERSION( 3, 3, 0 )
    wxSystemAppearance appearance = wxSystemSettings::GetAppearance();
    return appearance.IsDark();
#else
    wxColour bg = wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOW );
 
    // Weighted W3C formula
    double brightness = ( bg.Red() / 255.0 ) * 0.299 +
        ( bg.Green() / 255.0 ) * 0.587 +
        ( bg.Blue() / 255.0 ) * 0.117;
 
    return brightness < 0.5;
#endif
}
 
 
wxColour KIPLATFORM::UI::GetDialogBGColour()
{
    return wxSystemSettings::GetColour( wxSYS_COLOUR_BTNFACE );
}
 
 
void KIPLATFORM::UI::GetInfoBarColours( wxColour& aFGColour, wxColour& aBGColour )
{
    aBGColour = wxSystemSettings::GetColour( wxSYS_COLOUR_INFOBK );
    aFGColour = wxSystemSettings::GetColour( wxSYS_COLOUR_INFOTEXT );
}
 
 
wxWindow* KIPLATFORM::UI::CreateCanvasOverlay( wxWindow* aCanvas )
{
    return nullptr;
}
 
 
void KIPLATFORM::UI::ForceFocus( wxWindow* aWindow )
{
    aWindow->SetFocus();
}
 
 
bool KIPLATFORM::UI::IsWindowActive( wxWindow* aWindow )
{
    if(! aWindow )
    {
        return false;
    }
 
    return ( aWindow->GetHWND() == GetForegroundWindow() );
}
 
 
void KIPLATFORM::UI::EnsureVisible( wxWindow* aWindow )
{
    // Not needed on this platform
}
 
 
void KIPLATFORM::UI::StabilizeWindowPosition( wxWindow* aWindow )
{
    // Not needed on this platform
}
 
 
void KIPLATFORM::UI::ReparentModal( wxNonOwnedWindow* aWindow )
{
    // Not needed on this platform
}
 
 
void KIPLATFORM::UI::ReparentWindow( wxNonOwnedWindow* aWindow, wxTopLevelWindow* aParent )
{
    // Not needed on this platform (used only on macOS for child window ordering)
}
 
 
void KIPLATFORM::UI::FixupCancelButtonCmdKeyCollision( wxWindow *aWindow )
{
    // Not needed on this platform
}
 
 
bool KIPLATFORM::UI::IsStockCursorOk( wxStockCursor aCursor )
{
    switch( aCursor )
    {
    case wxCURSOR_BULLSEYE:
    case wxCURSOR_HAND:
    case wxCURSOR_ARROW:
        return true;
    default:
        return false;
    }
}
 
 
void KIPLATFORM::UI::LargeChoiceBoxHack( wxChoice* aChoice )
{
    // Not implemented
}
 
 
void KIPLATFORM::UI::EllipsizeChoiceBox( wxChoice* aChoice )
{
    // Not implemented
}
 
 
double KIPLATFORM::UI::GetPixelScaleFactor( const wxWindow* aWindow )
{
    return aWindow->GetContentScaleFactor();
}
 
 
double KIPLATFORM::UI::GetContentScaleFactor( const wxWindow* aWindow )
{
    return aWindow->GetDPIScaleFactor();
}
 
 
double KIPLATFORM::UI::GetDisplayRefreshRate( const wxWindow* aWindow )
{
    // wx reports the hardware's default rate as 0
    return wxDisplay( aWindow ).GetCurrentMode().refresh;
}
 
 
wxSize KIPLATFORM::UI::GetUnobscuredSize( const wxWindow* aWindow )
{
    return aWindow->GetClientSize();
}
 
 
void KIPLATFORM::UI::SetOverlayScrolling( const wxWindow* aWindow, bool overlay )
{
    // Not implemented
}
 
 
bool KIPLATFORM::UI::AllowIconsInMenus()
{
    return true;
}
 
 
bool KIPLATFORM::UI::SupportsKeyState()
{
    return true;
}
 
 
wxPoint KIPLATFORM::UI::GetMousePosition()
{
    return wxGetMousePosition();
}
 
 
bool KIPLATFORM::UI::WarpPointer( wxWindow* aWindow, int aX, int aY )
{
    aWindow->WarpPointer( aX, aY );
    return true;
}
 
 
void KIPLATFORM::UI::ImmControl( wxWindow* aWindow, bool aEnable )
{
    if ( !aEnable )
    {
        ImmAssociateContext( aWindow->GetHWND(), NULL );
    }
    else
    {
        ImmAssociateContextEx( aWindow->GetHWND(), 0, IACE_DEFAULT );
    }
}
 
 
void KIPLATFORM::UI::ImeNotifyCancelComposition( wxWindow* aWindow )
{
    const HIMC himc = ImmGetContext( aWindow->GetHWND() );
    ImmNotifyIME( himc, NI_COMPOSITIONSTR, CPS_CANCEL, 0 );
    ImmReleaseContext( aWindow->GetHWND(), himc );
}
 
 
bool KIPLATFORM::UI::InfiniteDragPrepareWindow( wxWindow* aWindow )
{
    return true;
}
 
 
void KIPLATFORM::UI::InfiniteDragReleaseWindow()
{
    // Not needed on this platform
}
 
 
void KIPLATFORM::UI::SetFloatLevel( wxWindow* aWindow )
{
}
 
void KIPLATFORM::UI::ReleaseChildWindow( wxNonOwnedWindow* aWindow )
{
    // Not needed on this platform
}
 
 
void KIPLATFORM::UI::AllowNetworkFileSystems( wxDialog* aDialog )
{
    // Not needed on Windows - file dialogs show network filesystems by default
}
 
 
void KIPLATFORM::UI::CancelPendingScroll( wxDataViewCtrl* aCtrl )
{
    // Not needed on this platform; the native control does not race on model resets.
}
 
 
void KIPLATFORM::UI::SetWMClass( wxWindow* aWindow, const wxString& aClass )
{
    // WM_CLASS is an X11/Wayland concept; taskbar identity on Windows is driven by the
    // AppUserModelID (see KIPLATFORM::ENV::SetAppDetailsForWindow).
}
 
 
void KIPLATFORM::UI::GetNativeWindowHandles( wxWindow* aWindow, void** aHandle, void** aDisplay,
                                              int* aDisplayType )
{
    *aHandle = nullptr;
    *aDisplay = nullptr;
 
    if( aDisplayType )
        *aDisplayType = NATIVE_DISPLAY_TYPE::DISPLAY_WIN32;
 
    if( aWindow )
        *aHandle = static_cast<void*>( aWindow->GetHWND() );
}
 
 
void KIPLATFORM::UI::PrepareForExternalRendering( wxWindow* aWindow )
{
    // The GPU API owns Win32 surfaces natively
}
 
 
void KIPLATFORM::UI::KeepAboveExternalRendering( wxWindow* aChild )
{
    // Child windows are native and clip their parent's surface
}