gtk/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 (C) 2020-2021 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 <http://www.gnu.org/licenses/>.
 */
 
#include <kiplatform/ui.h>
 
#include <wx/choice.h>
#include <wx/nonownedwnd.h>
#include <wx/settings.h>
#include <wx/window.h>
 
#include <gtk/gtk.h>
#include <gdk/gdk.h>
 
bool KIPLATFORM::UI::IsDarkTheme()
{
 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;
}
 
 
void KIPLATFORM::UI::ForceFocus( wxWindow* aWindow )
{
 aWindow->SetFocus();
}
 
 
bool KIPLATFORM::UI::IsWindowActive( wxWindow* aWindow )
{
 if( !aWindow )
 return false;
 
 GtkWindow* window = GTK_WINDOW( aWindow->GetHandle() );
 
 if( window )
 return gtk_window_is_active( window );
 
 // We shouldn't really ever reach this point
 return false;
}
 
 
void KIPLATFORM::UI::ReparentQuasiModal( wxNonOwnedWindow* aWindow )
{
 // Not needed on this platform
}
 
 
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:
 case wxCURSOR_BLANK:
 return true;
 default:
 return false;
 }
}
 
 
static void disable_area_apply_attributes_cb( GtkWidget* pItem, gpointer userdata )
{
 // GTK needs this enormous chain to get the actual type of item that we want
 GtkMenuItem* pMenuItem = GTK_MENU_ITEM( pItem );
 GtkWidget* child = gtk_bin_get_child( GTK_BIN( pMenuItem ) );
 GtkCellView* pCellView = GTK_CELL_VIEW( child );
 GtkCellLayout* pCellLayout = GTK_CELL_LAYOUT( pCellView );
 GtkCellArea* pCellArea = gtk_cell_layout_get_area( pCellLayout );
 
 g_signal_handlers_block_matched( pCellArea, G_SIGNAL_MATCH_DATA, 0, 0, NULL, NULL, userdata );
}
 
 
void KIPLATFORM::UI::LargeChoiceBoxHack( wxChoice* aChoice )
{
 AtkObject* atkObj = gtk_combo_box_get_popup_accessible( GTK_COMBO_BOX( aChoice->m_widget ) );
 
 if( !atkObj || !GTK_IS_ACCESSIBLE( atkObj ) )
 return;
 
 GtkWidget* widget = gtk_accessible_get_widget( GTK_ACCESSIBLE( atkObj ) );
 
 if( !widget || !GTK_IS_MENU( widget ) )
 return;
 
 GtkMenu* menu = GTK_MENU( widget );
 
 gtk_container_foreach( GTK_CONTAINER( menu ), disable_area_apply_attributes_cb, menu );
}
 
 
void KIPLATFORM::UI::EllipsizeChoiceBox( wxChoice* aChoice )
{
 // This function is based on the code inside the function post_process_ui in
 // gtkfilechooserwidget.c
 GList* cells = gtk_cell_layout_get_cells( GTK_CELL_LAYOUT( aChoice->m_widget ) );
 
 if( !cells )
 return;
 
 GtkCellRenderer* cell = (GtkCellRenderer*) cells->data;
 
 if( !cell )
 return;
 
 g_object_set( G_OBJECT( cell ), "ellipsize", PANGO_ELLIPSIZE_END, nullptr );
 
 // Only the list of cells must be freed, the renderer isn't ours to free
 g_list_free( cells );
}
 
 
double KIPLATFORM::UI::GetPixelScaleFactor( const wxWindow* aWindow )
{
 double val = 1.0;
 
 GtkWidget* widget = static_cast<GtkWidget*>( aWindow->GetHandle() );
 
 if( widget && gtk_check_version( 3, 10, 0 ) == nullptr )
 val = gtk_widget_get_scale_factor( widget );
 
 return val;
}
 
 
double KIPLATFORM::UI::GetContentScaleFactor( const wxWindow* aWindow )
{
 // TODO: Do we need something different here?
 return GetPixelScaleFactor( aWindow );
}
 
 
wxSize KIPLATFORM::UI::GetUnobscuredSize( const wxWindow* aWindow )
{
 return wxSize( aWindow->GetSize().GetX() - wxSystemSettings::GetMetric( wxSYS_VSCROLL_X ),
 aWindow->GetSize().GetY() - wxSystemSettings::GetMetric( wxSYS_HSCROLL_Y ) );
}
 
 
void KIPLATFORM::UI::SetOverlayScrolling( const wxWindow* aWindow, bool overlay )
{
 gtk_scrolled_window_set_overlay_scrolling( GTK_SCROLLED_WINDOW( aWindow->GetHandle() ),
 overlay );
}
 
 
bool KIPLATFORM::UI::AllowIconsInMenus()
{
 gboolean allowed = 1;
 
 g_object_get( gtk_settings_get_default(), "gtk-menu-images", &allowed, NULL );
 
 return !!allowed;
}
 
 
void KIPLATFORM::UI::WarpPointer( wxWindow* aWindow, int aX, int aY )
{
 if( !wxGetEnv( wxT( "WAYLAND_DISPLAY" ), nullptr ) )
 {
 aWindow->WarpPointer( aX, aY );
 }
 else
 {
 GdkDisplay* disp = gtk_widget_get_display( static_cast<GtkWidget*>( aWindow->GetHandle() ) );
 GdkSeat* seat = gdk_display_get_default_seat( disp );
 GdkDevice* dev = gdk_seat_get_pointer( seat );
 GdkWindow* win = gdk_device_get_window_at_position( dev, nullptr, nullptr );
 GdkCursor* blank_cursor = gdk_cursor_new_for_display( disp, GDK_BLANK_CURSOR );
 GdkCursor* cur_cursor = gdk_window_get_cursor( win );
 
 if( cur_cursor )
 g_object_ref( cur_cursor );
 
 gdk_window_set_cursor( win, blank_cursor );
 aWindow->WarpPointer( aX, aY );
 gdk_window_set_cursor( win, cur_cursor );
 }
}
 
 
void KIPLATFORM::UI::ImmControl( wxWindow* aWindow, bool aEnable )
{
}