From c530bdb5a16f82d90fdde2ce27eb73265f7d4651 Mon Sep 17 00:00:00 2001 From: Jon Evans Date: Wed, 11 Jan 2023 22:27:44 -0500 Subject: [PATCH] Rename GetSelectMenuText to GetItemDescription This descriptive text is used for many more things than just the select menu these days. --- common/drawing_sheet/ds_draw_item.cpp | 12 +++++----- common/eda_item.cpp | 6 ++--- common/rc_item.cpp | 14 +++++------ common/tool/selection_tool.cpp | 6 ++--- eeschema/connection_graph.cpp | 4 ++-- eeschema/lib_field.cpp | 2 +- eeschema/lib_field.h | 2 +- eeschema/lib_pin.cpp | 2 +- eeschema/lib_pin.h | 2 +- eeschema/lib_shape.cpp | 2 +- eeschema/lib_shape.h | 2 +- eeschema/lib_text.cpp | 2 +- eeschema/lib_text.h | 2 +- eeschema/lib_textbox.cpp | 2 +- eeschema/lib_textbox.h | 2 +- eeschema/sch_bitmap.h | 2 +- eeschema/sch_bus_entry.cpp | 4 ++-- eeschema/sch_bus_entry.h | 4 ++-- eeschema/sch_connection.cpp | 2 +- eeschema/sch_field.cpp | 2 +- eeschema/sch_field.h | 2 +- eeschema/sch_junction.h | 2 +- eeschema/sch_label.cpp | 8 +++---- eeschema/sch_label.h | 8 +++---- eeschema/sch_line.cpp | 2 +- eeschema/sch_line.h | 2 +- eeschema/sch_marker.h | 2 +- eeschema/sch_no_connect.h | 2 +- eeschema/sch_pin.cpp | 4 ++-- eeschema/sch_pin.h | 2 +- eeschema/sch_shape.cpp | 2 +- eeschema/sch_shape.h | 2 +- eeschema/sch_sheet.cpp | 2 +- eeschema/sch_sheet.h | 2 +- eeschema/sch_sheet_path.cpp | 2 +- eeschema/sch_sheet_pin.cpp | 2 +- eeschema/sch_sheet_pin.h | 2 +- eeschema/sch_symbol.cpp | 2 +- eeschema/sch_symbol.h | 2 +- eeschema/sch_text.cpp | 2 +- eeschema/sch_text.h | 2 +- eeschema/sch_textbox.cpp | 2 +- eeschema/sch_textbox.h | 2 +- gerbview/gerber_draw_item.cpp | 2 +- gerbview/gerber_draw_item.h | 4 ++-- include/board_item.h | 2 +- include/drawing_sheet/ds_draw_item.h | 12 +++++----- include/eda_item.h | 6 ++--- include/pcb_group.h | 4 ++-- pcbnew/board.cpp | 2 +- pcbnew/board.h | 2 +- pcbnew/dialogs/dialog_group_properties.cpp | 4 ++-- pcbnew/dialogs/dialog_position_relative.cpp | 2 +- pcbnew/drc/drc_engine.cpp | 26 ++++++++++----------- pcbnew/footprint.cpp | 2 +- pcbnew/footprint.h | 2 +- pcbnew/fp_shape.cpp | 2 +- pcbnew/fp_shape.h | 2 +- pcbnew/fp_text.cpp | 2 +- pcbnew/fp_text.h | 2 +- pcbnew/fp_textbox.cpp | 2 +- pcbnew/fp_textbox.h | 2 +- pcbnew/pad.cpp | 2 +- pcbnew/pad.h | 2 +- pcbnew/pcb_bitmap.h | 2 +- pcbnew/pcb_dimension.cpp | 2 +- pcbnew/pcb_dimension.h | 2 +- pcbnew/pcb_group.cpp | 2 +- pcbnew/pcb_marker.cpp | 6 ++--- pcbnew/pcb_marker.h | 2 +- pcbnew/pcb_shape.cpp | 2 +- pcbnew/pcb_shape.h | 2 +- pcbnew/pcb_target.cpp | 2 +- pcbnew/pcb_target.h | 2 +- pcbnew/pcb_text.cpp | 2 +- pcbnew/pcb_text.h | 2 +- pcbnew/pcb_textbox.cpp | 2 +- pcbnew/pcb_textbox.h | 2 +- pcbnew/pcb_track.cpp | 4 ++-- pcbnew/pcb_track.h | 4 ++-- pcbnew/router/pns_kicad_iface.cpp | 2 +- pcbnew/tools/board_inspection_tool.cpp | 2 +- pcbnew/tools/pcb_control.cpp | 4 ++-- pcbnew/zone.cpp | 2 +- pcbnew/zone.h | 2 +- 85 files changed, 137 insertions(+), 137 deletions(-) diff --git a/common/drawing_sheet/ds_draw_item.cpp b/common/drawing_sheet/ds_draw_item.cpp index a068268da9..98b542e141 100644 --- a/common/drawing_sheet/ds_draw_item.cpp +++ b/common/drawing_sheet/ds_draw_item.cpp @@ -188,7 +188,7 @@ bool DS_DRAW_ITEM_TEXT::HitTest( const BOX2I& aRect, bool aContains, int aAccura } -wxString DS_DRAW_ITEM_TEXT::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString DS_DRAW_ITEM_TEXT::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { return wxString::Format( _( "Text '%s'" ), GetShownText() ); } @@ -283,7 +283,7 @@ bool DS_DRAW_ITEM_POLYPOLYGONS::HitTest( const BOX2I& aRect, bool aContained, in } -wxString DS_DRAW_ITEM_POLYPOLYGONS::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString DS_DRAW_ITEM_POLYPOLYGONS::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { return _( "Imported Shape" ); } @@ -379,7 +379,7 @@ bool DS_DRAW_ITEM_RECT::HitTest( const BOX2I& aRect, bool aContained, int aAccur } -wxString DS_DRAW_ITEM_RECT::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString DS_DRAW_ITEM_RECT::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { return wxString::Format( _( "Rectangle, width %s height %s" ), aUnitsProvider->MessageTextFromValue( std::abs( GetStart().x - GetEnd().x ) ), @@ -412,7 +412,7 @@ bool DS_DRAW_ITEM_LINE::HitTest( const VECTOR2I& aPosition, int aAccuracy ) cons } -wxString DS_DRAW_ITEM_LINE::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString DS_DRAW_ITEM_LINE::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { return wxString::Format( _( "Line, length %s" ), aUnitsProvider->MessageTextFromValue( EuclideanNorm( GetStart() - GetEnd() ) ) ); @@ -460,13 +460,13 @@ bool DS_DRAW_ITEM_BITMAP::HitTest( const BOX2I& aRect, bool aContains, int aAccu } -wxString DS_DRAW_ITEM_BITMAP::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString DS_DRAW_ITEM_BITMAP::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { return _( "Image" ); } -wxString DS_DRAW_ITEM_PAGE::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString DS_DRAW_ITEM_PAGE::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { return _( "Page Limits" ); } diff --git a/common/eda_item.cpp b/common/eda_item.cpp index 11c35b1a76..c4cfda098a 100644 --- a/common/eda_item.cpp +++ b/common/eda_item.cpp @@ -105,12 +105,12 @@ INSPECT_RESULT EDA_ITEM::Visit( INSPECTOR inspector, void* testData, } -wxString EDA_ITEM::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString EDA_ITEM::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { - wxFAIL_MSG( wxT( "GetSelectMenuText() was not overridden for schematic item type " ) + + wxFAIL_MSG( wxT( "GetItemDescription() was not overridden for schematic item type " ) + GetClass() ); - return wxString( wxT( "Undefined menu text for " ) + GetClass() ); + return wxString( wxT( "Undefined item description for " ) + GetClass() ); } diff --git a/common/rc_item.cpp b/common/rc_item.cpp index cd4b11fe98..2a96a64d66 100644 --- a/common/rc_item.cpp +++ b/common/rc_item.cpp @@ -121,9 +121,9 @@ wxString RC_ITEM::ShowReport( UNITS_PROVIDER* aUnitsProvider, SEVERITY aSeverity GetViolatingRuleDesc(), severity, showCoord( aUnitsProvider, mainItem->GetPosition()), - mainItem->GetSelectMenuText( aUnitsProvider ), + mainItem->GetItemDescription( aUnitsProvider ), showCoord( aUnitsProvider, auxItem->GetPosition()), - auxItem->GetSelectMenuText( aUnitsProvider ) ); + auxItem->GetItemDescription( aUnitsProvider ) ); } else if( mainItem ) { @@ -133,7 +133,7 @@ wxString RC_ITEM::ShowReport( UNITS_PROVIDER* aUnitsProvider, SEVERITY aSeverity GetViolatingRuleDesc(), severity, showCoord( aUnitsProvider, mainItem->GetPosition()), - mainItem->GetSelectMenuText( aUnitsProvider ) ); + mainItem->GetItemDescription( aUnitsProvider ) ); } else { @@ -374,7 +374,7 @@ void RC_TREE_MODEL::GetValue( wxVariant& aVariant, else { EDA_ITEM* item = m_editFrame->GetItem( rcItem->GetMainItemID() ); - aVariant = item->GetSelectMenuText( m_editFrame ); + aVariant = item->GetItemDescription( m_editFrame ); } break; @@ -382,21 +382,21 @@ void RC_TREE_MODEL::GetValue( wxVariant& aVariant, case RC_TREE_NODE::AUX_ITEM: { EDA_ITEM* item = m_editFrame->GetItem( rcItem->GetAuxItemID() ); - aVariant = item->GetSelectMenuText( m_editFrame ); + aVariant = item->GetItemDescription( m_editFrame ); } break; case RC_TREE_NODE::AUX_ITEM2: { EDA_ITEM* item = m_editFrame->GetItem( rcItem->GetAuxItem2ID() ); - aVariant = item->GetSelectMenuText( m_editFrame ); + aVariant = item->GetItemDescription( m_editFrame ); } break; case RC_TREE_NODE::AUX_ITEM3: { EDA_ITEM* item = m_editFrame->GetItem( rcItem->GetAuxItem3ID() ); - aVariant = item->GetSelectMenuText( m_editFrame ); + aVariant = item->GetItemDescription( m_editFrame ); } break; } diff --git a/common/tool/selection_tool.cpp b/common/tool/selection_tool.cpp index 8d495b7ef7..e753373948 100644 --- a/common/tool/selection_tool.cpp +++ b/common/tool/selection_tool.cpp @@ -273,18 +273,18 @@ bool SELECTION_TOOL::doSelectionMenu( COLLECTOR* aCollector ) { #ifdef __WXMAC__ menuText = wxString::Format( "%s\t%d", - item->GetSelectMenuText( unitsProvider ), + item->GetItemDescription( unitsProvider ), i + 1 ); #else menuText = wxString::Format( "&%d %s\t%d", i + 1, - item->GetSelectMenuText( unitsProvider ), + item->GetItemDescription( unitsProvider ), i + 1 ); #endif } else { - menuText = item->GetSelectMenuText( unitsProvider ); + menuText = item->GetItemDescription( unitsProvider ); } menu.Add( menuText, i + 1, item->GetMenuImage() ); diff --git a/eeschema/connection_graph.cpp b/eeschema/connection_graph.cpp index eda89d5d13..dc426eced6 100644 --- a/eeschema/connection_graph.cpp +++ b/eeschema/connection_graph.cpp @@ -992,7 +992,7 @@ void CONNECTION_GRAPH::collectAllDriverValues() UNITS_PROVIDER unitsProvider( schIUScale, EDA_UNITS::MILLIMETRES ); wxLogTrace( ConnTrace, "Unexpected strong driver %s", - driver->GetSelectMenuText( &unitsProvider ) ); + driver->GetItemDescription( &unitsProvider ) ); break; } } @@ -1187,7 +1187,7 @@ void CONNECTION_GRAPH::processSubGraphs() wxLogTrace( ConnTrace, "%ld (%s) weakly driven by unique sheet pin %s, promoting", subgraph->m_code, name, - subgraph->m_driver->GetSelectMenuText( &unitsProvider ) ); + subgraph->m_driver->GetItemDescription( &unitsProvider ) ); subgraph->m_strong_driver = true; } diff --git a/eeschema/lib_field.cpp b/eeschema/lib_field.cpp index 47b18fd8cf..379ff5e015 100644 --- a/eeschema/lib_field.cpp +++ b/eeschema/lib_field.cpp @@ -508,7 +508,7 @@ void LIB_FIELD::SetName( const wxString& aName ) } -wxString LIB_FIELD::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString LIB_FIELD::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { return wxString::Format( "%s '%s'", GetName(), KIUI::EllipsizeMenuText( GetShownText() ) ); } diff --git a/eeschema/lib_field.h b/eeschema/lib_field.h index d952f4514e..72e75116a6 100644 --- a/eeschema/lib_field.h +++ b/eeschema/lib_field.h @@ -166,7 +166,7 @@ public: void Plot( PLOTTER* aPlotter, bool aBackground, const VECTOR2I& aOffset, const TRANSFORM& aTransform, bool aDimmed ) const override; - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; BITMAPS GetMenuImage() const override; diff --git a/eeschema/lib_pin.cpp b/eeschema/lib_pin.cpp index 969dbd6e88..cf61a93a6a 100644 --- a/eeschema/lib_pin.cpp +++ b/eeschema/lib_pin.cpp @@ -1338,7 +1338,7 @@ BITMAPS LIB_PIN::GetMenuImage() const } -wxString LIB_PIN::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString LIB_PIN::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { // This code previously checked "m_name.IsEmpty()" to choose the correct // formatting path, but that check fails if the pin is called "~" which is diff --git a/eeschema/lib_pin.h b/eeschema/lib_pin.h index effd06d4ea..993e2e636c 100644 --- a/eeschema/lib_pin.h +++ b/eeschema/lib_pin.h @@ -233,7 +233,7 @@ public: BITMAPS GetMenuImage() const override; - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; EDA_ITEM* Clone() const override; diff --git a/eeschema/lib_shape.cpp b/eeschema/lib_shape.cpp index 5b799cc033..dc5101b2ab 100644 --- a/eeschema/lib_shape.cpp +++ b/eeschema/lib_shape.cpp @@ -461,7 +461,7 @@ void LIB_SHAPE::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector& aList ) override; BITMAPS GetMenuImage() const override; diff --git a/eeschema/lib_textbox.cpp b/eeschema/lib_textbox.cpp index 222a2c18b0..ea21f48d7a 100644 --- a/eeschema/lib_textbox.cpp +++ b/eeschema/lib_textbox.cpp @@ -370,7 +370,7 @@ bool LIB_TEXTBOX::HitTest( const BOX2I& aRect, bool aContained, int aAccuracy ) } -wxString LIB_TEXTBOX::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString LIB_TEXTBOX::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { return wxString::Format( _( "Graphic Text Box" ) ); } diff --git a/eeschema/lib_textbox.h b/eeschema/lib_textbox.h index 63d288175b..83913e17ab 100644 --- a/eeschema/lib_textbox.h +++ b/eeschema/lib_textbox.h @@ -77,7 +77,7 @@ public: virtual bool IsReplaceable() const override { return true; } - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; BITMAPS GetMenuImage() const override; diff --git a/eeschema/sch_bitmap.h b/eeschema/sch_bitmap.h index b11727b8b5..3c0e5844ce 100644 --- a/eeschema/sch_bitmap.h +++ b/eeschema/sch_bitmap.h @@ -124,7 +124,7 @@ public: void MirrorVertically( int aCenter ) override; void Rotate( const VECTOR2I& aCenter ) override; - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override { return wxString( _( "Image" ) ); } diff --git a/eeschema/sch_bus_entry.cpp b/eeschema/sch_bus_entry.cpp index 80de0a2516..dc12346ad6 100644 --- a/eeschema/sch_bus_entry.cpp +++ b/eeschema/sch_bus_entry.cpp @@ -413,13 +413,13 @@ std::vector SCH_BUS_ENTRY_BASE::GetConnectionPoints() const } -wxString SCH_BUS_WIRE_ENTRY::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString SCH_BUS_WIRE_ENTRY::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { return wxString( _( "Bus to Wire Entry" ) ); } -wxString SCH_BUS_BUS_ENTRY::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString SCH_BUS_BUS_ENTRY::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { return wxString( _( "Bus to Bus Entry" ) ); } diff --git a/eeschema/sch_bus_entry.h b/eeschema/sch_bus_entry.h index 7f7ecf5e2b..9276bebe22 100644 --- a/eeschema/sch_bus_entry.h +++ b/eeschema/sch_bus_entry.h @@ -178,7 +178,7 @@ public: ( aItem->GetLayer() == LAYER_WIRE || aItem->GetLayer() == LAYER_BUS ); } - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; EDA_ITEM* Clone() const override; @@ -225,7 +225,7 @@ public: return aItem->Type() == SCH_LINE_T && aItem->GetLayer() == LAYER_BUS; } - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; EDA_ITEM* Clone() const override; diff --git a/eeschema/sch_connection.cpp b/eeschema/sch_connection.cpp index 50084cea4f..34c419c519 100644 --- a/eeschema/sch_connection.cpp +++ b/eeschema/sch_connection.cpp @@ -441,7 +441,7 @@ void SCH_CONNECTION::AppendInfoToMsgPanel( std::vector& aList ) { UNITS_PROVIDER unitsProvider( schIUScale, EDA_UNITS::MILLIMETRES ); - msg.Printf( "%s at %p", driver->GetSelectMenuText( &unitsProvider ), driver ); + msg.Printf( "%s at %p", driver->GetItemDescription( &unitsProvider ), driver ); aList.emplace_back( wxT( "Connection Source" ), msg ); } #endif diff --git a/eeschema/sch_field.cpp b/eeschema/sch_field.cpp index 76e14376bc..755c308f31 100644 --- a/eeschema/sch_field.cpp +++ b/eeschema/sch_field.cpp @@ -751,7 +751,7 @@ void SCH_FIELD::Rotate( const VECTOR2I& aCenter ) } -wxString SCH_FIELD::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString SCH_FIELD::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { return wxString::Format( "%s '%s'", GetName(), KIUI::EllipsizeMenuText( GetShownText() ) ); } diff --git a/eeschema/sch_field.h b/eeschema/sch_field.h index 60ae75fdc7..7335a4c066 100644 --- a/eeschema/sch_field.h +++ b/eeschema/sch_field.h @@ -216,7 +216,7 @@ public: bool Replace( const EDA_SEARCH_DATA& aSearchData, void* aAuxData = nullptr ) override; - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector& aList ) override; BITMAPS GetMenuImage() const override; diff --git a/eeschema/sch_junction.h b/eeschema/sch_junction.h index d1786e2518..0be491bf71 100644 --- a/eeschema/sch_junction.h +++ b/eeschema/sch_junction.h @@ -92,7 +92,7 @@ public: || aItem->Type() == SCH_SYMBOL_T ); } - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override { return wxString( _( "Junction" ) ); } diff --git a/eeschema/sch_label.cpp b/eeschema/sch_label.cpp index e48a6b8ae3..7b52eac483 100644 --- a/eeschema/sch_label.cpp +++ b/eeschema/sch_label.cpp @@ -1059,7 +1059,7 @@ const BOX2I SCH_LABEL::GetBodyBoundingBox() const } -wxString SCH_LABEL::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString SCH_LABEL::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { return wxString::Format( _( "Label '%s'" ), KIUI::EllipsizeMenuText( GetShownText() ) ); } @@ -1230,7 +1230,7 @@ void SCH_DIRECTIVE_LABEL::AutoplaceFields( SCH_SCREEN* aScreen, bool aManual ) } -wxString SCH_DIRECTIVE_LABEL::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString SCH_DIRECTIVE_LABEL::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { if( m_fields.empty() ) { @@ -1512,7 +1512,7 @@ void SCH_GLOBALLABEL::CreateGraphicShape( const RENDER_SETTINGS* aRenderSettings } -wxString SCH_GLOBALLABEL::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString SCH_GLOBALLABEL::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { return wxString::Format( _( "Global Label '%s'" ), KIUI::EllipsizeMenuText( GetShownText() ) ); } @@ -1645,7 +1645,7 @@ VECTOR2I SCH_HIERLABEL::GetSchematicTextOffset( const RENDER_SETTINGS* aSettings } -wxString SCH_HIERLABEL::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString SCH_HIERLABEL::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { return wxString::Format( _( "Hierarchical Label '%s'" ), KIUI::EllipsizeMenuText( GetShownText() ) ); diff --git a/eeschema/sch_label.h b/eeschema/sch_label.h index 56aa3407fe..8378d4d748 100644 --- a/eeschema/sch_label.h +++ b/eeschema/sch_label.h @@ -241,7 +241,7 @@ public: bool IsConnectable() const override { return true; } - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; BITMAPS GetMenuImage() const override; @@ -303,7 +303,7 @@ public: void AutoplaceFields( SCH_SCREEN* aScreen, bool aManual ) override; - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; bool IsConnectable() const override { return true; } @@ -359,7 +359,7 @@ public: void ViewGetLayers( int aLayers[], int& aCount ) const override; - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; BITMAPS GetMenuImage() const override; @@ -411,7 +411,7 @@ public: bool IsConnectable() const override { return true; } - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; BITMAPS GetMenuImage() const override; diff --git a/eeschema/sch_line.cpp b/eeschema/sch_line.cpp index 17db7770a6..36afdf56f4 100644 --- a/eeschema/sch_line.cpp +++ b/eeschema/sch_line.cpp @@ -690,7 +690,7 @@ void SCH_LINE::GetSelectedPoints( std::vector& aPoints ) const } -wxString SCH_LINE::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString SCH_LINE::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { wxString txtfmt; diff --git a/eeschema/sch_line.h b/eeschema/sch_line.h index 4f78821444..08c1f22dc6 100644 --- a/eeschema/sch_line.h +++ b/eeschema/sch_line.h @@ -253,7 +253,7 @@ public: bool CanConnect( const SCH_ITEM* aItem ) const override; - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; BITMAPS GetMenuImage() const override; diff --git a/eeschema/sch_marker.h b/eeschema/sch_marker.h index c20e3d7a05..dc78c284e8 100644 --- a/eeschema/sch_marker.h +++ b/eeschema/sch_marker.h @@ -94,7 +94,7 @@ public: void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector& aList ) override; - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override { return wxString( _( "ERC Marker" ) ); } diff --git a/eeschema/sch_no_connect.h b/eeschema/sch_no_connect.h index cbed76ee05..6ad440c994 100644 --- a/eeschema/sch_no_connect.h +++ b/eeschema/sch_no_connect.h @@ -92,7 +92,7 @@ public: std::vector GetConnectionPoints() const override; - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override { return wxString( _( "No Connect" ) ); } diff --git a/eeschema/sch_pin.cpp b/eeschema/sch_pin.cpp index 77bb3e9145..3decd1bf39 100644 --- a/eeschema/sch_pin.cpp +++ b/eeschema/sch_pin.cpp @@ -191,11 +191,11 @@ SCH_SYMBOL* SCH_PIN::GetParentSymbol() const } -wxString SCH_PIN::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString SCH_PIN::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { return wxString::Format( "Symbol %s %s", GetParentSymbol()->GetField( REFERENCE_FIELD )->GetShownText(), - m_libPin->GetSelectMenuText( aUnitsProvider ) ); + m_libPin->GetItemDescription( aUnitsProvider ) ); } diff --git a/eeschema/sch_pin.h b/eeschema/sch_pin.h index 41e150e353..1c53c6f8e6 100644 --- a/eeschema/sch_pin.h +++ b/eeschema/sch_pin.h @@ -68,7 +68,7 @@ public: void ViewGetLayers( int aLayers[], int& aCount ) const override; - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector& aList ) override; void Print( const RENDER_SETTINGS* aSettings, const VECTOR2I& aOffset ) override {} diff --git a/eeschema/sch_shape.cpp b/eeschema/sch_shape.cpp index d8551c2c17..135a6d62bb 100644 --- a/eeschema/sch_shape.cpp +++ b/eeschema/sch_shape.cpp @@ -399,7 +399,7 @@ void SCH_SHAPE::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector& aList ) override; - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; BITMAPS GetMenuImage() const override; diff --git a/eeschema/sch_sheet.cpp b/eeschema/sch_sheet.cpp index 396893ce70..a3ad3d3a54 100644 --- a/eeschema/sch_sheet.cpp +++ b/eeschema/sch_sheet.cpp @@ -1034,7 +1034,7 @@ void SCH_SHEET::RunOnChildren( const std::function& aFunction } -wxString SCH_SHEET::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString SCH_SHEET::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { return wxString::Format( _( "Hierarchical Sheet %s" ), m_fields[ SHEETNAME ].GetText() ); diff --git a/eeschema/sch_sheet.h b/eeschema/sch_sheet.h index 5a79bd28c3..7a4a06ab26 100644 --- a/eeschema/sch_sheet.h +++ b/eeschema/sch_sheet.h @@ -355,7 +355,7 @@ public: void RunOnChildren( const std::function& aFunction ) override; - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; BITMAPS GetMenuImage() const override; diff --git a/eeschema/sch_sheet_path.cpp b/eeschema/sch_sheet_path.cpp index 9a9ea6b9d1..a776729d99 100644 --- a/eeschema/sch_sheet_path.cpp +++ b/eeschema/sch_sheet_path.cpp @@ -52,7 +52,7 @@ public: SCH_ITEM( nullptr, NOT_USED ) {} - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override { return _( "(Deleted Item)" ); } diff --git a/eeschema/sch_sheet_pin.cpp b/eeschema/sch_sheet_pin.cpp index 70399f2d6b..3d0ff2f3b0 100644 --- a/eeschema/sch_sheet_pin.cpp +++ b/eeschema/sch_sheet_pin.cpp @@ -325,7 +325,7 @@ void SCH_SHEET_PIN::GetEndPoints( std::vector& aItemList ) } -wxString SCH_SHEET_PIN::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString SCH_SHEET_PIN::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { return wxString::Format( _( "Hierarchical Sheet Pin %s" ), KIUI::EllipsizeMenuText( GetShownText() ) ); diff --git a/eeschema/sch_sheet_pin.h b/eeschema/sch_sheet_pin.h index fdd0256b2b..3ae03cf5bd 100644 --- a/eeschema/sch_sheet_pin.h +++ b/eeschema/sch_sheet_pin.h @@ -182,7 +182,7 @@ public: bool IsConnectable() const override { return true; } - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; BITMAPS GetMenuImage() const override; diff --git a/eeschema/sch_symbol.cpp b/eeschema/sch_symbol.cpp index 438f859901..f89e70eb60 100644 --- a/eeschema/sch_symbol.cpp +++ b/eeschema/sch_symbol.cpp @@ -1857,7 +1857,7 @@ LIB_ITEM* SCH_SYMBOL::GetDrawItem( const VECTOR2I& aPosition, KICAD_T aType ) } -wxString SCH_SYMBOL::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString SCH_SYMBOL::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { return wxString::Format( _( "Symbol %s [%s]" ), GetField( REFERENCE_FIELD )->GetShownText(), diff --git a/eeschema/sch_symbol.h b/eeschema/sch_symbol.h index 62db3d98c1..9c5ee0b314 100644 --- a/eeschema/sch_symbol.h +++ b/eeschema/sch_symbol.h @@ -696,7 +696,7 @@ public: */ LIB_ITEM* GetDrawItem( const VECTOR2I& aPosition, KICAD_T aType = TYPE_NOT_INIT ); - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; BITMAPS GetMenuImage() const override; diff --git a/eeschema/sch_text.cpp b/eeschema/sch_text.cpp index b34d64effe..9b5f382f40 100644 --- a/eeschema/sch_text.cpp +++ b/eeschema/sch_text.cpp @@ -398,7 +398,7 @@ void SCH_TEXT::DoHypertextAction( EDA_DRAW_FRAME* aFrame ) const } -wxString SCH_TEXT::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString SCH_TEXT::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { return wxString::Format( _( "Graphic Text '%s'" ), KIUI::EllipsizeMenuText( GetShownText() ) ); } diff --git a/eeschema/sch_text.h b/eeschema/sch_text.h index e8a3d3cbf7..c7fbc8faa2 100644 --- a/eeschema/sch_text.h +++ b/eeschema/sch_text.h @@ -196,7 +196,7 @@ public: void ViewGetLayers( int aLayers[], int& aCount ) const override; - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; BITMAPS GetMenuImage() const override; diff --git a/eeschema/sch_textbox.cpp b/eeschema/sch_textbox.cpp index c2691d8937..79017eb744 100644 --- a/eeschema/sch_textbox.cpp +++ b/eeschema/sch_textbox.cpp @@ -367,7 +367,7 @@ void SCH_TEXTBOX::DoHypertextAction( EDA_DRAW_FRAME* aFrame ) const } -wxString SCH_TEXTBOX::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString SCH_TEXTBOX::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { return wxString::Format( _( "Graphic Text Box" ) ); } diff --git a/eeschema/sch_textbox.h b/eeschema/sch_textbox.h index b44e1b4dac..54651ea2be 100644 --- a/eeschema/sch_textbox.h +++ b/eeschema/sch_textbox.h @@ -98,7 +98,7 @@ public: virtual bool IsReplaceable() const override { return true; } - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; BITMAPS GetMenuImage() const override; diff --git a/gerbview/gerber_draw_item.cpp b/gerbview/gerber_draw_item.cpp index d1193230ca..1f15aed24f 100644 --- a/gerbview/gerber_draw_item.cpp +++ b/gerbview/gerber_draw_item.cpp @@ -993,7 +993,7 @@ INSPECT_RESULT GERBER_DRAW_ITEM::Visit( INSPECTOR inspector, void* testData, } -wxString GERBER_DRAW_ITEM::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString GERBER_DRAW_ITEM::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { wxString layerName = GERBER_FILE_IMAGE_LIST::GetImagesList().GetDisplayName( GetLayer(), true ); diff --git a/gerbview/gerber_draw_item.h b/gerbview/gerber_draw_item.h index be9c4dc46c..c49851a2ca 100644 --- a/gerbview/gerber_draw_item.h +++ b/gerbview/gerber_draw_item.h @@ -221,8 +221,8 @@ public: INSPECT_RESULT Visit( INSPECTOR inspector, void* testData, const std::vector& aScanTypes ) override; - ///< @copydoc EDA_ITEM::GetSelectMenuText() - virtual wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + ///< @copydoc EDA_ITEM::GetItemDescription() + virtual wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; ///< @copydoc EDA_ITEM::GetMenuImage() BITMAPS GetMenuImage() const override; diff --git a/include/board_item.h b/include/board_item.h index e75e02d240..b069715310 100644 --- a/include/board_item.h +++ b/include/board_item.h @@ -351,7 +351,7 @@ public: BOARD_ITEM( nullptr, NOT_USED ) {} - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override { return _( "(Deleted Item)" ); } diff --git a/include/drawing_sheet/ds_draw_item.h b/include/drawing_sheet/ds_draw_item.h index ea71984cc6..408b708c85 100644 --- a/include/drawing_sheet/ds_draw_item.h +++ b/include/drawing_sheet/ds_draw_item.h @@ -144,7 +144,7 @@ public: void PrintWsItem( const RENDER_SETTINGS* aSettings, const VECTOR2I& aOffset ) override; - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; #if defined(DEBUG) void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); } @@ -179,7 +179,7 @@ public: void PrintWsItem( const RENDER_SETTINGS* aSettings, const VECTOR2I& aOffset ) override; - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; #if defined(DEBUG) void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); } @@ -233,7 +233,7 @@ public: bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override; bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override; - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; #if defined(DEBUG) void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); } @@ -280,7 +280,7 @@ public: const BOX2I GetBoundingBox() const override; bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override { return false; } - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; #if defined(DEBUG) void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); } @@ -330,7 +330,7 @@ public: bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override; bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override; - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; #if defined(DEBUG) void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); } @@ -364,7 +364,7 @@ public: const BOX2I GetBoundingBox() const override; - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; #if defined(DEBUG) void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); } diff --git a/include/eda_item.h b/include/eda_item.h index 153c0ab944..10beac110d 100644 --- a/include/eda_item.h +++ b/include/eda_item.h @@ -347,8 +347,8 @@ public: wxString GetTypeDesc() const; /** - * Return the text to display to be used in the selection clarification context menu - * when multiple items are found at the current cursor position. + * Return a user-visible description string of this item. This description is used in + * disambiguation menus, the message panel, ERC/DRC reports, etc. * * The default version of this function raises an assertion in the debug mode and * returns a string to indicate that it was not overridden to provide the object @@ -356,7 +356,7 @@ public: * * @return The menu text string. */ - virtual wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const; + virtual wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const; /** * Return a pointer to an image to be used in menus. diff --git a/include/pcb_group.h b/include/pcb_group.h index 4efedd369a..d4d55ec085 100644 --- a/include/pcb_group.h +++ b/include/pcb_group.h @@ -180,8 +180,8 @@ public: ///< @copydoc BOARD_ITEM::Flip void Flip( const VECTOR2I& aCentre, bool aFlipLeftRight ) override; - ///< @copydoc EDA_ITEM::GetSelectMenuText - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + ///< @copydoc EDA_ITEM::GetItemDescription + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; ///< @copydoc EDA_ITEM::GetMenuImage BITMAPS GetMenuImage() const override; diff --git a/pcbnew/board.cpp b/pcbnew/board.cpp index 905ba2c86c..640fa25abf 100644 --- a/pcbnew/board.cpp +++ b/pcbnew/board.cpp @@ -923,7 +923,7 @@ void BOARD::Remove( BOARD_ITEM* aBoardItem, REMOVE_MODE aRemoveMode ) } -wxString BOARD::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString BOARD::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { return wxString::Format( _( "PCB" ) ); } diff --git a/pcbnew/board.h b/pcbnew/board.h index e32adfbbec..c0f29008e0 100644 --- a/pcbnew/board.h +++ b/pcbnew/board.h @@ -633,7 +633,7 @@ public: const TITLE_BLOCK& GetTitleBlock() const { return m_titles; } void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) { m_titles = aTitleBlock; } - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; /** * Extract the board outlines and build a closed polygon from lines, arcs and circle items diff --git a/pcbnew/dialogs/dialog_group_properties.cpp b/pcbnew/dialogs/dialog_group_properties.cpp index 83fcfa449c..61265b2fa4 100644 --- a/pcbnew/dialogs/dialog_group_properties.cpp +++ b/pcbnew/dialogs/dialog_group_properties.cpp @@ -49,7 +49,7 @@ DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES( PCB_BASE_EDIT_FRAME* aParent, m_locked->Show( dynamic_cast( aParent ) != nullptr ); for( BOARD_ITEM* item : m_group->GetItems() ) - m_membersList->Append( item->GetSelectMenuText( m_brdEditor ), item ); + m_membersList->Append( item->GetItemDescription( m_brdEditor ), item ); SetupStandardButtons(); @@ -157,7 +157,7 @@ void DIALOG_GROUP_PROPERTIES::DoAddMember( EDA_ITEM* aItem ) if( aItem == m_group ) return; - m_membersList->Append( aItem->GetSelectMenuText( m_brdEditor ), aItem ); + m_membersList->Append( aItem->GetItemDescription( m_brdEditor ), aItem ); } diff --git a/pcbnew/dialogs/dialog_position_relative.cpp b/pcbnew/dialogs/dialog_position_relative.cpp index 45e280a58a..fa05ecc430 100644 --- a/pcbnew/dialogs/dialog_position_relative.cpp +++ b/pcbnew/dialogs/dialog_position_relative.cpp @@ -239,7 +239,7 @@ void DIALOG_POSITION_RELATIVE::updateAnchorInfo( BOARD_ITEM* aItem ) wxString msg = _( "" ); if( aItem ) - msg = aItem->GetSelectMenuText( &unitsProvider ); + msg = aItem->GetItemDescription( &unitsProvider ); m_referenceInfo->SetLabel( wxString::Format( _( "Reference item: %s" ), msg ) ); break; diff --git a/pcbnew/drc/drc_engine.cpp b/pcbnew/drc/drc_engine.cpp index f692f682fc..1191a5971f 100644 --- a/pcbnew/drc/drc_engine.cpp +++ b/pcbnew/drc/drc_engine.cpp @@ -733,7 +733,7 @@ DRC_CONSTRAINT DRC_ENGINE::EvalRules( DRC_CONSTRAINT_T aConstraintType, const BO { REPORT( "" ) REPORT( wxString::Format( _( "Local override on %s; clearance: %s." ), - EscapeHTML( a->GetSelectMenuText( this ) ), + EscapeHTML( a->GetItemDescription( this ) ), MessageTextFromValue( overrideA ) ) ) override_val = ac->GetLocalClearanceOverrides( &msg ); @@ -743,7 +743,7 @@ DRC_CONSTRAINT DRC_ENGINE::EvalRules( DRC_CONSTRAINT_T aConstraintType, const BO { REPORT( "" ) REPORT( wxString::Format( _( "Local override on %s; clearance: %s." ), - EscapeHTML( b->GetSelectMenuText( this ) ), + EscapeHTML( b->GetItemDescription( this ) ), EscapeHTML( MessageTextFromValue( overrideB ) ) ) ) if( overrideB > override_val ) @@ -792,7 +792,7 @@ DRC_CONSTRAINT DRC_ENGINE::EvalRules( DRC_CONSTRAINT_T aConstraintType, const BO REPORT( "" ) REPORT( wxString::Format( _( "Local override on %s; zone connection: %s." ), - EscapeHTML( pad->GetSelectMenuText( this ) ), + EscapeHTML( pad->GetItemDescription( this ) ), EscapeHTML( PrintZoneConnection( override ) ) ) ) constraint.SetName( msg ); @@ -809,7 +809,7 @@ DRC_CONSTRAINT DRC_ENGINE::EvalRules( DRC_CONSTRAINT_T aConstraintType, const BO REPORT( "" ) REPORT( wxString::Format( _( "Local override on %s; thermal relief gap: %s." ), - EscapeHTML( pad->GetSelectMenuText( this ) ), + EscapeHTML( pad->GetItemDescription( this ) ), EscapeHTML( MessageTextFromValue( gap_override ) ) ) ) constraint.SetName( msg ); @@ -826,7 +826,7 @@ DRC_CONSTRAINT DRC_ENGINE::EvalRules( DRC_CONSTRAINT_T aConstraintType, const BO REPORT( "" ) REPORT( wxString::Format( _( "Local override on %s; thermal spoke width: %s." ), - EscapeHTML( pad->GetSelectMenuText( this ) ), + EscapeHTML( pad->GetItemDescription( this ) ), EscapeHTML( MessageTextFromValue( spoke_override ) ) ) ) if( zone && zone->GetMinThickness() > spoke_override ) @@ -835,7 +835,7 @@ DRC_CONSTRAINT DRC_ENGINE::EvalRules( DRC_CONSTRAINT_T aConstraintType, const BO REPORT( "" ) REPORT( wxString::Format( _( "%s min thickness: %s." ), - EscapeHTML( zone->GetSelectMenuText( this ) ), + EscapeHTML( zone->GetItemDescription( this ) ), EscapeHTML( MessageTextFromValue( spoke_override ) ) ) ) } @@ -1192,7 +1192,7 @@ DRC_CONSTRAINT DRC_ENGINE::EvalRules( DRC_CONSTRAINT_T aConstraintType, const BO const BOARD_ITEM* x = !hasDrilledHole( a ) ? a : b; REPORT( wxString::Format( _( "%s is not a drilled hole; rule ignored." ), - x->GetSelectMenuText( this ) ) ) + x->GetItemDescription( this ) ) ) } return false; @@ -1330,7 +1330,7 @@ DRC_CONSTRAINT DRC_ENGINE::EvalRules( DRC_CONSTRAINT_T aConstraintType, const BO { REPORT( "" ) REPORT( wxString::Format( _( "Local clearance on %s; clearance: %s." ), - EscapeHTML( a->GetSelectMenuText( this ) ), + EscapeHTML( a->GetItemDescription( this ) ), MessageTextFromValue( localA ) ) ) if( localA > clearance ) @@ -1347,7 +1347,7 @@ DRC_CONSTRAINT DRC_ENGINE::EvalRules( DRC_CONSTRAINT_T aConstraintType, const BO { REPORT( "" ) REPORT( wxString::Format( _( "Local clearance on %s; clearance: %s." ), - EscapeHTML( b->GetSelectMenuText( this ) ), + EscapeHTML( b->GetItemDescription( this ) ), MessageTextFromValue( localB ) ) ) if( localB > clearance ) @@ -1398,7 +1398,7 @@ DRC_CONSTRAINT DRC_ENGINE::EvalRules( DRC_CONSTRAINT_T aConstraintType, const BO { REPORT( "" ) REPORT( wxString::Format( _( "%s zone connection: %s." ), - EscapeHTML( parentFootprint->GetSelectMenuText( this ) ), + EscapeHTML( parentFootprint->GetItemDescription( this ) ), EscapeHTML( PrintZoneConnection( local ) ) ) ) constraint.SetParentRule( nullptr ); @@ -1414,7 +1414,7 @@ DRC_CONSTRAINT DRC_ENGINE::EvalRules( DRC_CONSTRAINT_T aConstraintType, const BO REPORT( "" ) REPORT( wxString::Format( _( "%s pad connection: %s." ), - EscapeHTML( zone->GetSelectMenuText( this ) ), + EscapeHTML( zone->GetItemDescription( this ) ), EscapeHTML( PrintZoneConnection( local ) ) ) ) constraint.SetParentRule( nullptr ); @@ -1431,7 +1431,7 @@ DRC_CONSTRAINT DRC_ENGINE::EvalRules( DRC_CONSTRAINT_T aConstraintType, const BO REPORT( "" ) REPORT( wxString::Format( _( "%s thermal relief gap: %s." ), - EscapeHTML( zone->GetSelectMenuText( this ) ), + EscapeHTML( zone->GetItemDescription( this ) ), EscapeHTML( MessageTextFromValue( local ) ) ) ) constraint.SetParentRule( nullptr ); @@ -1448,7 +1448,7 @@ DRC_CONSTRAINT DRC_ENGINE::EvalRules( DRC_CONSTRAINT_T aConstraintType, const BO REPORT( "" ) REPORT( wxString::Format( _( "%s thermal spoke width: %s." ), - EscapeHTML( zone->GetSelectMenuText( this ) ), + EscapeHTML( zone->GetItemDescription( this ) ), EscapeHTML( MessageTextFromValue( local ) ) ) ) constraint.SetParentRule( nullptr ); diff --git a/pcbnew/footprint.cpp b/pcbnew/footprint.cpp index c22056c6c3..a61ddcfd76 100644 --- a/pcbnew/footprint.cpp +++ b/pcbnew/footprint.cpp @@ -1346,7 +1346,7 @@ INSPECT_RESULT FOOTPRINT::Visit( INSPECTOR inspector, void* testData, } -wxString FOOTPRINT::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString FOOTPRINT::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { wxString reference = GetReference(); diff --git a/pcbnew/footprint.h b/pcbnew/footprint.h index 914876c4d6..f1068a5d7b 100644 --- a/pcbnew/footprint.h +++ b/pcbnew/footprint.h @@ -704,7 +704,7 @@ public: return wxT( "FOOTPRINT" ); } - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; BITMAPS GetMenuImage() const override; diff --git a/pcbnew/fp_shape.cpp b/pcbnew/fp_shape.cpp index 234c0257c3..d7614055e2 100644 --- a/pcbnew/fp_shape.cpp +++ b/pcbnew/fp_shape.cpp @@ -121,7 +121,7 @@ void FP_SHAPE::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector( GetParent() )->GetReference() ); diff --git a/pcbnew/fp_textbox.h b/pcbnew/fp_textbox.h index 12100d4bb3..1abf2a9239 100644 --- a/pcbnew/fp_textbox.h +++ b/pcbnew/fp_textbox.h @@ -122,7 +122,7 @@ public: return wxT( "FP_TEXTBOX" ); } - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; BITMAPS GetMenuImage() const override; diff --git a/pcbnew/pad.cpp b/pcbnew/pad.cpp index c347c49e44..abd9ffcb35 100644 --- a/pcbnew/pad.cpp +++ b/pcbnew/pad.cpp @@ -1237,7 +1237,7 @@ wxString PAD::ShowPadAttr() const } -wxString PAD::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString PAD::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { if( GetNumber().IsEmpty() ) { diff --git a/pcbnew/pad.h b/pcbnew/pad.h index 5ce61fb3e9..2d58f28bca 100644 --- a/pcbnew/pad.h +++ b/pcbnew/pad.h @@ -695,7 +695,7 @@ public: void Rotate( const VECTOR2I& aRotCentre, const EDA_ANGLE& aAngle ) override; - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; BITMAPS GetMenuImage() const override; diff --git a/pcbnew/pcb_bitmap.h b/pcbnew/pcb_bitmap.h index b83845bf0e..09efb0f324 100644 --- a/pcbnew/pcb_bitmap.h +++ b/pcbnew/pcb_bitmap.h @@ -105,7 +105,7 @@ public: void Flip( const VECTOR2I& aCentre, bool aFlipLeftRight ) override; void Rotate( const VECTOR2I& aCenter, const EDA_ANGLE& aAngle ) override; - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override { return wxString( _( "Image" ) ); } diff --git a/pcbnew/pcb_dimension.cpp b/pcbnew/pcb_dimension.cpp index 10cbc68758..3cba1101c3 100644 --- a/pcbnew/pcb_dimension.cpp +++ b/pcbnew/pcb_dimension.cpp @@ -448,7 +448,7 @@ const BOX2I PCB_DIMENSION_BASE::GetBoundingBox() const } -wxString PCB_DIMENSION_BASE::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString PCB_DIMENSION_BASE::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { return wxString::Format( _( "Dimension '%s' on %s" ), GetText(), GetLayerName() ); } diff --git a/pcbnew/pcb_dimension.h b/pcbnew/pcb_dimension.h index c5ff4b7cab..c737f1f7bb 100644 --- a/pcbnew/pcb_dimension.h +++ b/pcbnew/pcb_dimension.h @@ -245,7 +245,7 @@ public: std::shared_ptr GetEffectiveShape( PCB_LAYER_ID aLayer, FLASHING aFlash = FLASHING::DEFAULT ) const override; - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; const BOX2I ViewBBox() const override; diff --git a/pcbnew/pcb_group.cpp b/pcbnew/pcb_group.cpp index 7245844b45..620c4c418a 100644 --- a/pcbnew/pcb_group.cpp +++ b/pcbnew/pcb_group.cpp @@ -379,7 +379,7 @@ void PCB_GROUP::Flip( const VECTOR2I& aCentre, bool aFlipLeftRight ) } -wxString PCB_GROUP::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString PCB_GROUP::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { if( m_name.empty() ) return wxString::Format( _( "Unnamed Group, %zu members" ), m_items.size() ); diff --git a/pcbnew/pcb_marker.cpp b/pcbnew/pcb_marker.cpp index 36318e991b..e4a71033dc 100644 --- a/pcbnew/pcb_marker.cpp +++ b/pcbnew/pcb_marker.cpp @@ -226,10 +226,10 @@ void PCB_MARKER::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vectorGetItem( m_rcItem->GetAuxItemID() ); if( mainItem ) - mainText = mainItem->GetSelectMenuText( aFrame ); + mainText = mainItem->GetItemDescription( aFrame ); if( auxItem ) - auxText = auxItem->GetSelectMenuText( aFrame ); + auxText = auxItem->GetItemDescription( aFrame ); aList.emplace_back( mainText, auxText ); } @@ -256,7 +256,7 @@ std::shared_ptr PCB_MARKER::GetEffectiveShape( PCB_LAYER_ID aLayer, FLASH } -wxString PCB_MARKER::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString PCB_MARKER::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { // m_rcItem->GetErrorMessage() could be used instead, but is probably too long // for menu duty. diff --git a/pcbnew/pcb_marker.h b/pcbnew/pcb_marker.h index 91120e1ee5..b881bd9948 100644 --- a/pcbnew/pcb_marker.h +++ b/pcbnew/pcb_marker.h @@ -98,7 +98,7 @@ public: return BOARD_ITEM::Matches( m_rcItem->GetErrorMessage(), aSearchData ); } - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; BITMAPS GetMenuImage() const override; diff --git a/pcbnew/pcb_shape.cpp b/pcbnew/pcb_shape.cpp index 569657d0bc..a263e40708 100644 --- a/pcbnew/pcb_shape.cpp +++ b/pcbnew/pcb_shape.cpp @@ -312,7 +312,7 @@ void PCB_SHAPE::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector PCB_TARGET::GetEffectiveShape( PCB_LAYER_ID aLayer, FLASH } -wxString PCB_TARGET::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString PCB_TARGET::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { // Targets are on *every* layer by definition return _( "Target" ); diff --git a/pcbnew/pcb_target.h b/pcbnew/pcb_target.h index 72bf08785e..90bf4362b6 100644 --- a/pcbnew/pcb_target.h +++ b/pcbnew/pcb_target.h @@ -86,7 +86,7 @@ public: std::shared_ptr GetEffectiveShape( PCB_LAYER_ID aLayer, FLASHING aFlash = FLASHING::DEFAULT ) const override; - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; BITMAPS GetMenuImage() const override; diff --git a/pcbnew/pcb_text.cpp b/pcbnew/pcb_text.cpp index 6edfebc6d7..5ad79a0887 100644 --- a/pcbnew/pcb_text.cpp +++ b/pcbnew/pcb_text.cpp @@ -252,7 +252,7 @@ void PCB_TEXT::Flip( const VECTOR2I& aCentre, bool aFlipLeftRight ) } -wxString PCB_TEXT::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString PCB_TEXT::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { return wxString::Format( _( "PCB Text '%s' on %s"), KIUI::EllipsizeMenuText( GetShownText() ), diff --git a/pcbnew/pcb_text.h b/pcbnew/pcb_text.h index cde3014686..9eac7485d7 100644 --- a/pcbnew/pcb_text.h +++ b/pcbnew/pcb_text.h @@ -135,7 +135,7 @@ public: GetEffectiveShape( PCB_LAYER_ID aLayer = UNDEFINED_LAYER, FLASHING aFlash = FLASHING::DEFAULT ) const override; - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; BITMAPS GetMenuImage() const override; diff --git a/pcbnew/pcb_textbox.cpp b/pcbnew/pcb_textbox.cpp index 45e2ab4260..f9b892b581 100644 --- a/pcbnew/pcb_textbox.cpp +++ b/pcbnew/pcb_textbox.cpp @@ -413,7 +413,7 @@ bool PCB_TEXTBOX::HitTest( const BOX2I& aRect, bool aContained, int aAccuracy ) } -wxString PCB_TEXTBOX::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString PCB_TEXTBOX::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { return wxString::Format( _( "PCB Text Box on %s"), GetLayerName() ); } diff --git a/pcbnew/pcb_textbox.h b/pcbnew/pcb_textbox.h index 9f409b4fcc..f9f72dfb62 100644 --- a/pcbnew/pcb_textbox.h +++ b/pcbnew/pcb_textbox.h @@ -127,7 +127,7 @@ public: GetEffectiveShape( PCB_LAYER_ID aLayer = UNDEFINED_LAYER, FLASHING aFlash = FLASHING::DEFAULT ) const override; - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; BITMAPS GetMenuImage() const override; diff --git a/pcbnew/pcb_track.cpp b/pcbnew/pcb_track.cpp index f65a59e3d2..b92ba0ae9c 100644 --- a/pcbnew/pcb_track.cpp +++ b/pcbnew/pcb_track.cpp @@ -102,7 +102,7 @@ EDA_ITEM* PCB_VIA::Clone() const } -wxString PCB_VIA::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString PCB_VIA::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { wxString formatStr; @@ -1064,7 +1064,7 @@ bool PCB_VIA::HitTest( const BOX2I& aRect, bool aContained, int aAccuracy ) cons } -wxString PCB_TRACK::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString PCB_TRACK::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { return wxString::Format( Type() == PCB_ARC_T ? _("Track (arc) %s on %s, length %s" ) : _("Track %s on %s, length %s" ), diff --git a/pcbnew/pcb_track.h b/pcbnew/pcb_track.h index d2ee0a5583..e0ae4484d0 100644 --- a/pcbnew/pcb_track.h +++ b/pcbnew/pcb_track.h @@ -199,7 +199,7 @@ public: MINOPTMAX GetWidthConstraint( wxString* aSource ) const; - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; BITMAPS GetMenuImage() const override; @@ -449,7 +449,7 @@ public: return wxT( "PCB_VIA" ); } - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; BITMAPS GetMenuImage() const override; diff --git a/pcbnew/router/pns_kicad_iface.cpp b/pcbnew/router/pns_kicad_iface.cpp index a4ef722b2f..6074621eec 100644 --- a/pcbnew/router/pns_kicad_iface.cpp +++ b/pcbnew/router/pns_kicad_iface.cpp @@ -1226,7 +1226,7 @@ bool PNS_KICAD_IFACE_BASE::syncZone( PNS::NODE* aWorld, ZONE* aZone, SHAPE_POLY_ { UNITS_PROVIDER unitsProvider( pcbIUScale, GetUnits() ); KIDIALOG dlg( nullptr, wxString::Format( _( "%s is malformed." ), - aZone->GetSelectMenuText( &unitsProvider ) ), + aZone->GetItemDescription( &unitsProvider ) ), KIDIALOG::KD_WARNING ); dlg.ShowDetailedText( wxString::Format( _( "This zone cannot be handled by the router.\n" "Please verify it is not a self-intersecting " diff --git a/pcbnew/tools/board_inspection_tool.cpp b/pcbnew/tools/board_inspection_tool.cpp index c1bc89b33b..87253a0dcc 100644 --- a/pcbnew/tools/board_inspection_tool.cpp +++ b/pcbnew/tools/board_inspection_tool.cpp @@ -155,7 +155,7 @@ wxString BOARD_INSPECTION_TOOL::getItemDescription( BOARD_ITEM* aItem ) if( !aItem ) return wxString(); - wxString msg = aItem->GetSelectMenuText( m_frame ); + wxString msg = aItem->GetItemDescription( m_frame ); if( aItem->IsConnected() && !isNPTHPad( aItem ) ) { diff --git a/pcbnew/tools/pcb_control.cpp b/pcbnew/tools/pcb_control.cpp index 531f0a6d0c..a8ed957b07 100644 --- a/pcbnew/tools/pcb_control.cpp +++ b/pcbnew/tools/pcb_control.cpp @@ -1389,8 +1389,8 @@ int PCB_CONTROL::UpdateMessagePanel( const TOOL_EVENT& aEvent ) BOARD_ITEM* a = static_cast( selection[0] ); BOARD_ITEM* b = static_cast( selection[1] ); - msgItems.emplace_back( MSG_PANEL_ITEM( a->GetSelectMenuText( m_frame ), - b->GetSelectMenuText( m_frame ) ) ); + msgItems.emplace_back( MSG_PANEL_ITEM( a->GetItemDescription( m_frame ), + b->GetItemDescription( m_frame ) ) ); BOARD_CONNECTED_ITEM* a_conn = dyn_cast( a ); BOARD_CONNECTED_ITEM* b_conn = dyn_cast( b ); diff --git a/pcbnew/zone.cpp b/pcbnew/zone.cpp index cc84abac62..6cd2b7dc46 100644 --- a/pcbnew/zone.cpp +++ b/pcbnew/zone.cpp @@ -777,7 +777,7 @@ bool ZONE::AppendCorner( VECTOR2I aPosition, int aHoleIdx, bool aAllowDuplicatio } -wxString ZONE::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const +wxString ZONE::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { wxString layerDesc; int count = 0; diff --git a/pcbnew/zone.h b/pcbnew/zone.h index 1db627edf9..8ee4748ec9 100644 --- a/pcbnew/zone.h +++ b/pcbnew/zone.h @@ -669,7 +669,7 @@ public: void AddPolygon( const SHAPE_LINE_CHAIN& aPolygon ); - wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override; + wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; BITMAPS GetMenuImage() const override;