lib_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) 2019 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2022 CERN
 * Copyright (C) 2004-2022 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_LIBENTRY_FIELDS_H
#define CLASS_LIBENTRY_FIELDS_H
 
#include <eda_text.h>
#include <lib_item.h>
 
 
class SCH_LEGACY_PLUGIN_CACHE;
 
 
class LIB_FIELD : public LIB_ITEM, public EDA_TEXT
{
public:
 LIB_FIELD( int aId = 2 );
 
 LIB_FIELD( int aId, const wxString& aName );
 
 LIB_FIELD( LIB_SYMBOL* aParent, int aId = 2, const wxString& aName = wxEmptyString );
 
 // Do not create a copy constructor. The one generated by the compiler is adequate.
 
 wxString GetClass() const override
 {
 return wxT( "LIB_FIELD" );
 }
 
 static inline bool ClassOf( const EDA_ITEM* aItem )
 {
 return aItem && aItem->Type() == LIB_FIELD_T;
 }
 
 wxString GetTypeName() const override
 {
 return _( "Field" );
 }
 
 void Init( int aId );
 
 wxString GetName( bool aUseDefaultName = true ) const;
 
 wxString GetCanonicalName() const;
 
 void SetName( const wxString& aName );
 
 int GetId() const { return m_id; }
 void SetId( int aId );
 
 int GetPenWidth() const override;
 
 KIFONT::FONT* getDrawFont() const override;
 
 void Copy( LIB_FIELD* aTarget ) const;
 
 void ViewGetLayers( int aLayers[], int& aCount ) const override;
 
 const BOX2I GetBoundingBox() const override;
 
 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
 
 bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override;
 
 LIB_FIELD& operator=( const LIB_FIELD& field );
 
 wxString GetFullText( int unit = 1 ) const;
 
 wxString GetShownText( bool aAllowExtraText, int aDepth = 0 ) const override;
 
 SCH_LAYER_ID GetDefaultLayer() const;
 
 void BeginEdit( const VECTOR2I& aStartPoint ) override;
 
 void Offset( const VECTOR2I& aOffset ) override;
 
 void MoveTo( const VECTOR2I& aPosition ) override;
 
 VECTOR2I GetPosition() const override { return EDA_TEXT::GetTextPos(); }
 
 void MirrorHorizontal( const VECTOR2I& aCenter ) override;
 void MirrorVertical( const VECTOR2I& aCenter ) override;
 void Rotate( const VECTOR2I& aCenter, bool aRotateCCW = true ) override;
 
 void Plot( PLOTTER* aPlotter, bool aBackground, const VECTOR2I& aOffset,
 const TRANSFORM& aTransform, bool aDimmed ) const override;
 
 wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override;
 
 BITMAPS GetMenuImage() const override;
 
 EDA_ITEM* Clone() const override;
 
 bool IsMandatory() const;
 
 bool IsAutoAdded() const { return m_autoAdded; }
 void SetAutoAdded( bool aAutoAdded ) { m_autoAdded = aAutoAdded; }
 
 bool IsNameShown() const { return m_showName; }
 void SetNameShown( bool aShown = true ) { m_showName = aShown; }
 
 bool CanAutoplace() const { return m_allowAutoPlace; }
 void SetCanAutoplace( bool aCanPlace ) { m_allowAutoPlace = aCanPlace; }
 
 bool ShowInChooser() const { return m_showInChooser; }
 void SetShowInChooser( bool aShow = true ) { m_showInChooser = aShow; }
 
private:
 
 int compare( const LIB_ITEM& aOther, int aCompareFlags = 0 ) const override;
 
 void print( const RENDER_SETTINGS* aSettings, const VECTOR2I& aOffset, void* aData,
 const TRANSFORM& aTransform, bool aDimmed ) override;
 
 void CalcEdit( const VECTOR2I& aPosition ) override;
 
 friend class SCH_LEGACY_PLUGIN_CACHE; // Required to access m_name.
 
 int m_id; 
 wxString m_name; 
 bool m_autoAdded; 
 bool m_showName; 
 bool m_allowAutoPlace; 
 bool m_showInChooser; 
};
 
#endif // CLASS_LIBENTRY_FIELDS_H