sch_field.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2022 CERN
 * Copyright (C) 2004-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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
#ifndef CLASS_SCH_FIELD_H
#define CLASS_SCH_FIELD_H
 
 
#include <eda_text.h>
#include <sch_item.h>
#include <template_fieldnames.h>
#include <general.h>
#include "scintilla_tricks.h"
 
class SCH_EDIT_FRAME;
 
 
class SCH_FIELD : public SCH_ITEM, public EDA_TEXT
{
public:
 SCH_FIELD( const VECTOR2I& aPos, int aFieldId, SCH_ITEM* aParent,
 const wxString& aName = wxEmptyString );
 
 SCH_FIELD( SCH_ITEM* aParent, int aFieldId = INVALID_FIELD,
 const wxString& aName = wxEmptyString );
 
 SCH_FIELD( const SCH_FIELD& aText );
 
 ~SCH_FIELD() override
 { }
 
 SCH_FIELD& operator=( const SCH_FIELD& aField );
 
 static bool ClassOf( const EDA_ITEM* aItem )
 {
 return aItem && SCH_FIELD_T == aItem->Type();
 }
 
 wxString GetClass() const override
 {
 return wxT( "SCH_FIELD" );
 }
 
 bool IsType( const std::vector<KICAD_T>& aScanTypes ) const override
 {
 if( SCH_ITEM::IsType( aScanTypes ) )
 return true;
 
 for( KICAD_T scanType : aScanTypes )
 {
 if( scanType == SCH_FIELD_LOCATE_REFERENCE_T && m_id == REFERENCE_FIELD )
 return true;
 else if ( scanType == SCH_FIELD_LOCATE_VALUE_T && m_id == VALUE_FIELD )
 return true;
 else if ( scanType == SCH_FIELD_LOCATE_FOOTPRINT_T && m_id == FOOTPRINT_FIELD )
 return true;
 else if ( scanType == SCH_FIELD_LOCATE_DATASHEET_T && m_id == DATASHEET_FIELD )
 return true;
 }
 
 return false;
 }
 
 wxString GetFriendlyName() const override
 {
 return _( "Field" );
 }
 
 bool IsHypertext() const override
 {
 return GetCanonicalName() == wxT( "Intersheetrefs" );
 }
 
 void DoHypertextAction( EDA_DRAW_FRAME* aFrame ) const override;
 
 wxString GetName( bool aUseDefaultName = true ) const;
 
 wxString GetCanonicalName() const;
 
 void SetName( const wxString& aName );
 
 void SetText( const wxString& aText ) override;
 
 const wxString& GetInternalName() { return m_name; }
 
 int GetId() const { return m_id; }
 
 void SetId( int aId );
 
 wxString GetShownName() const;
 wxString GetShownText( const SCH_SHEET_PATH* aPath, bool aAllowExtraText,
 int aDepth = 0 ) const;
 
 wxString GetShownText( bool aAllowExtraText, int aDepth = 0 ) const override;
 
 wxString GetFullText( int unit = 1 ) const;
 
 bool IsEmpty()
 {
 wxString name( m_name );
 wxString value( GetText() );
 
 return name.Trim().empty() && value.Trim().empty();
 }
 
 int GetSchTextSize() const { return GetTextWidth(); }
 void SetSchTextSize( int aSize ) { SetTextSize( VECTOR2I( aSize, aSize ) ); }
 
 COLOR4D GetFieldColor() const;
 
 void SetLastResolvedState( const SCH_ITEM* aItem ) override
 {
 const SCH_FIELD* aField = dynamic_cast<const SCH_FIELD*>( aItem );
 
 if( aField )
 m_lastResolvedColor = aField->m_lastResolvedColor;
 }
 
 void ViewGetLayers( int aLayers[], int& aCount ) const override;
 
 SCH_LAYER_ID GetDefaultLayer() const;
 
 EDA_ANGLE GetDrawRotation() const override;
 
 const BOX2I GetBoundingBox() const override;
 
 bool IsHorizJustifyFlipped() const;
 bool IsVertJustifyFlipped() const;
 
 GR_TEXT_H_ALIGN_T GetEffectiveHorizJustify() const;
 GR_TEXT_V_ALIGN_T GetEffectiveVertJustify() const;
 
 bool IsNameShown() const { return m_showName; }
 void SetNameShown( bool aShown = true ) { m_showName = aShown; }
 
 bool IsNamedVariable() const { return m_isNamedVariable; }
 
 bool CanAutoplace() const { return m_allowAutoPlace; }
 void SetCanAutoplace( bool aCanPlace ) { m_allowAutoPlace = aCanPlace; }
 
 void SwapData( SCH_ITEM* aItem ) override;
 
 int GetPenWidth() const override;
 
 bool IsAutoAdded() const { return m_autoAdded; }
 void SetAutoAdded( bool aAutoAdded ) { m_autoAdded = aAutoAdded; }
 
 bool ShowInChooser() const { return m_showInChooser; }
 void SetShowInChooser( bool aShow = true ) { m_showInChooser = aShow; }
 
 void ClearCaches() override;
 void ClearRenderCache() override;
 
 std::vector<std::unique_ptr<KIFONT::GLYPH>>*
 GetRenderCache( const wxString& forResolvedText, const VECTOR2I& forPosition,
 TEXT_ATTRIBUTES& aAttrs ) const;
 
 void Move( const VECTOR2I& aMoveVector ) override
 {
 Offset( aMoveVector );
 }
 
 void Rotate( const VECTOR2I& aCenter, bool aRotateCCW ) override;
 
 void MirrorVertically( int aCenter ) override;
 void MirrorHorizontally( int aCenter ) override;
 
 void BeginEdit( const VECTOR2I& aStartPoint ) override;
 void CalcEdit( const VECTOR2I& aPosition ) override;
 
 void OnScintillaCharAdded( SCINTILLA_TRICKS* aScintillaTricks, wxStyledTextEvent &aEvent ) const;
 
 bool Matches( const EDA_SEARCH_DATA& aSearchData, void* aAuxData ) const override;
 
 bool Replace( const EDA_SEARCH_DATA& aSearchData, void* aAuxData = nullptr ) 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;
 
 bool IsReplaceable() const override;
 
 VECTOR2I GetLibPosition() const { return EDA_TEXT::GetTextPos(); }
 
 VECTOR2I GetPosition() const override;
 void SetPosition( const VECTOR2I& aPosition ) override;
 
 VECTOR2I GetParentPosition() const;
 
 bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override;
 bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override;
 
 void Print( const SCH_RENDER_SETTINGS* aSettings, int aUnit, int aBodyStyle,
 const VECTOR2I& aOffset, bool aForceNoFill, bool aDimmed ) override;
 
 void Plot( PLOTTER* aPlotter, bool aBackground, const SCH_PLOT_OPTS& aPlotOpts,
 int aUnit, int aBodyStyle, const VECTOR2I& aOffset, bool aDimmed ) override;
 
 EDA_ITEM* Clone() const override;
 
 void ImportValues( const SCH_FIELD& aSource );
 
 void Copy( SCH_FIELD* aTarget ) const;
 
 bool IsMandatory() const;
 
 bool operator <( const SCH_ITEM& aItem ) const override;
 
 double Similarity( const SCH_ITEM& aItem ) const override;
 
 bool operator==( const SCH_ITEM& aItem ) const override;
 bool operator==( const SCH_FIELD& aItem ) const;
 
#if defined(DEBUG)
 void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
#endif
 
protected:
 KIFONT::FONT* getDrawFont() const override;
 
 const KIFONT::METRICS& getFontMetrics() const override { return GetFontMetrics(); }
 
 int compare( const SCH_ITEM& aOther, int aCompareFlags = 0 ) const override;
 
private:
 int m_id; 
 
 wxString m_name;
 
 bool m_showName; 
 bool m_allowAutoPlace; 
 bool m_isNamedVariable; 
 
 bool m_autoAdded; 
 bool m_showInChooser; 
 
 mutable bool m_renderCacheValid;
 mutable VECTOR2I m_renderCachePos;
 mutable std::vector<std::unique_ptr<KIFONT::GLYPH>> m_renderCache;
 
 mutable COLOR4D m_lastResolvedColor;
};
 
 
#endif /* CLASS_SCH_FIELD_H */