7
mirror of https://gitlab.com/kicad/code/kicad.git synced 2024-11-22 00:05:04 +00:00
kicad/common/widgets/wx_html_report_box.cpp
Jeff Young f6031da58c ADDED: RMB-menu for Copy in inspectors.
Includes Inspect > Resolve Clearance, Inspect > Resolve
Constraints and everything else that uses WX_HTML_REPORT_BOX.

Fixes https://gitlab.com/kicad/code/kicad/-/issues/18321
2024-07-07 22:41:15 +01:00

141 lines
4.1 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2020-2024 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 2 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 <math/util.h>
#include <common.h>
#include <wx/settings.h>
#include <wx/textctrl.h>
#include <wx/menu.h>
#include <wx/clipbrd.h>
#include <wx/log.h>
#include "wx_html_report_box.h"
WX_HTML_REPORT_BOX::WX_HTML_REPORT_BOX( wxWindow* parent, wxWindowID id, const wxPoint& pos,
const wxSize& size, long style ) :
HTML_WINDOW( parent, id, pos, size, style ),
m_units( EDA_UNITS::MILLIMETRES ),
m_immediateMode( false )
{
Flush();
Bind( wxEVT_SYS_COLOUR_CHANGED,
wxSysColourChangedEventHandler( WX_HTML_REPORT_BOX::onThemeChanged ), this );
Connect( wxEVT_RIGHT_UP, wxMouseEventHandler( WX_HTML_REPORT_BOX::onRightClick ), nullptr,
this );
}
WX_HTML_REPORT_BOX::~WX_HTML_REPORT_BOX()
{
// Disconnect Events
Disconnect( wxEVT_RIGHT_UP, wxMouseEventHandler( WX_HTML_REPORT_BOX::onRightClick ), nullptr,
this );
}
void WX_HTML_REPORT_BOX::onThemeChanged( wxSysColourChangedEvent &aEvent )
{
Flush();
aEvent.Skip();
}
void WX_HTML_REPORT_BOX::onRightClick( wxMouseEvent& event )
{
wxMenu popup;
popup.Append( wxID_COPY, "Copy" );
PopupMenu( &popup );
}
void WX_HTML_REPORT_BOX::onMenuEvent( wxMenuEvent& event )
{
if( event.GetId() == wxID_COPY )
{
wxLogNull doNotLog; // disable logging of failed clipboard actions
if( wxTheClipboard->Open() )
{
bool primarySelection = wxTheClipboard->IsUsingPrimarySelection();
wxTheClipboard->UsePrimarySelection( false ); // required to use the main clipboard
wxTheClipboard->SetData( new wxTextDataObject( SelectionToText() ) );
wxTheClipboard->Flush(); // Allow data to be available after closing KiCad
wxTheClipboard->Close();
wxTheClipboard->UsePrimarySelection( primarySelection );
}
}
}
REPORTER& WX_HTML_REPORT_BOX::Report( const wxString& aText, SEVERITY aSeverity )
{
m_messages.push_back( aText );
if( m_immediateMode )
{
Flush();
int px, py, x, y;
GetScrollPixelsPerUnit( &px, &py );
GetVirtualSize( &x, &y );
Scroll( -1, y * py );
}
return *this;
}
void WX_HTML_REPORT_BOX::Flush()
{
wxString html;
for( const wxString& line : m_messages )
html += generateHtml( line );
SetPage( html );
}
wxString WX_HTML_REPORT_BOX::generateHtml( const wxString& aLine )
{
// wxWidgets default linespacing is about 110% of font-height (which is way too small),
// and the default paragraph spacing is about 200% (which is too big). The heading,
// bullet lists, etc. line spacing is fine.
//
// And of course they provide no way to set it, which leaves us with very few options.
// Fortunately we know we're dealing mostly with single lines in the reporter so we apply
// an egregious hack and enforce a minimum linespacing by inserting an invisible img
// element with appropriate height
wxFont font = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT );
int additionalLineSpacing = KiROUND( font.GetPixelSize().y * 0.6 );
return wxString::Format( wxT( "<img align=texttop height=%d width=0 src=#>%s<br>" ),
additionalLineSpacing, aLine );
}
void WX_HTML_REPORT_BOX::Clear()
{
m_messages.clear();
}