7
mirror of https://gitlab.com/kicad/code/kicad.git synced 2025-04-11 13:10:13 +00:00

Rename GetSelectMenuText to GetItemDescription

This descriptive text is used for many more things than
just the select menu these days.
This commit is contained in:
Jon Evans 2023-01-11 22:27:44 -05:00
parent 1ff1571849
commit c530bdb5a1
85 changed files with 137 additions and 137 deletions

View File

@ -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" );
}

View File

@ -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() );
}

View File

@ -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;
}

View File

@ -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() );

View File

@ -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;
}

View File

@ -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() ) );
}

View File

@ -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;

View File

@ -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

View File

@ -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;

View File

@ -461,7 +461,7 @@ void LIB_SHAPE::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_I
}
wxString LIB_SHAPE::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const
wxString LIB_SHAPE::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const
{
switch( GetShape() )
{

View File

@ -107,7 +107,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;

View File

@ -455,7 +455,7 @@ const BOX2I LIB_TEXT::GetBoundingBox() const
}
wxString LIB_TEXT::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const
wxString LIB_TEXT::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const
{
return wxString::Format( _( "Graphic Text '%s'" ), KIUI::EllipsizeMenuText( GetShownText() ) );
}

View File

@ -101,7 +101,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;
void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
BITMAPS GetMenuImage() const override;

View File

@ -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" ) );
}

View File

@ -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;

View File

@ -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" ) );
}

View File

@ -413,13 +413,13 @@ std::vector<VECTOR2I> 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" ) );
}

View File

@ -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;

View File

@ -441,7 +441,7 @@ void SCH_CONNECTION::AppendInfoToMsgPanel( std::vector<MSG_PANEL_ITEM>& 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

View File

@ -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() ) );
}

View File

@ -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<MSG_PANEL_ITEM>& aList ) override;
BITMAPS GetMenuImage() const override;

View File

@ -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" ) );
}

View File

@ -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() ) );

View File

@ -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;

View File

@ -690,7 +690,7 @@ void SCH_LINE::GetSelectedPoints( std::vector<VECTOR2I>& aPoints ) const
}
wxString SCH_LINE::GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const
wxString SCH_LINE::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const
{
wxString txtfmt;

Some files were not shown because too many files have changed in this diff Show More