pcb_textbox.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2004 Jean-Pierre Charras, [email protected]
 * Copyright (C) 1992-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 PCB_TEXTBOX_H
#define PCB_TEXTBOX_H
 
#include <eda_text.h>
#include <pcb_shape.h>
 
 
class LINE_READER;
class MSG_PANEL_ITEM;
 
 
class PCB_TEXTBOX : public PCB_SHAPE, public EDA_TEXT
{
public:
 PCB_TEXTBOX( BOARD_ITEM* aParent, KICAD_T aType = PCB_TEXTBOX_T );
 
 // Do not create a copy constructor & operator=.
 // The ones generated by the compiler are adequate.
 
 ~PCB_TEXTBOX();
 
 static inline bool ClassOf( const EDA_ITEM* aItem )
 {
 return aItem && PCB_TEXTBOX_T == aItem->Type();
 }
 
 bool IsType( const std::vector<KICAD_T>& aScanTypes ) const override
 {
 if( BOARD_ITEM::IsType( aScanTypes ) )
 return true;
 
 for( KICAD_T scanType : aScanTypes )
 {
 if( scanType == PCB_LOCATE_TEXT_T )
 return true;
 }
 
 return false;
 }
 
 wxString GetFriendlyName() const override { return _( "Text Box" ); }
 
 VECTOR2I GetTopLeft() const override;
 VECTOR2I GetBotRight() const override;
 
 void SetTop( int aVal ) override;
 void SetLeft( int aVal ) override;
 void SetRight( int aVal ) override;
 void SetBottom( int aVal ) override;
 
 void StyleFromSettings( const BOARD_DESIGN_SETTINGS& settings ) override;
 
 int GetLegacyTextMargin() const;
 
 void SetMarginLeft( int aLeft ) { m_marginLeft = aLeft; }
 void SetMarginTop( int aTop ) { m_marginTop = aTop; }
 void SetMarginRight( int aRight ) { m_marginRight = aRight; }
 void SetMarginBottom( int aBottom ) { m_marginBottom = aBottom; }
 
 int GetMarginLeft() const { return m_marginLeft; }
 int GetMarginTop() const { return m_marginTop; }
 int GetMarginRight() const { return m_marginRight; }
 int GetMarginBottom() const { return m_marginBottom; }
 
 VECTOR2I GetDrawPos() const override;
 
 void SetTextAngle( const EDA_ANGLE& aAngle ) override;
 
 wxString GetShownText( bool aAllowExtraText, int aDepth = 0 ) const override;
 
 void SetVisible( bool aVisible ) override { /* do nothing */}
 bool IsVisible() const override { return true; }
 
 bool Matches( const EDA_SEARCH_DATA& aSearchData, void* aAuxData ) const override;
 
 std::vector<VECTOR2I> GetAnchorAndOppositeCorner() const;
 
 void Move( const VECTOR2I& aMoveVector ) override;
 
 void Rotate( const VECTOR2I& aRotCentre, const EDA_ANGLE& aAngle ) override;
 
 void Mirror( const VECTOR2I& aCentre, bool aMirrorAroundXAxis ) override;
 
 void Flip( const VECTOR2I& aCentre, bool aFlipLeftRight ) override;
 
 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
 
 bool HitTest( const VECTOR2I& aPosition, int aAccuracy ) const override;
 
 bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override;
 
 wxString GetClass() const override
 {
 return wxT( "PCB_TEXTBOX" );
 }
 
 void TransformTextToPolySet( SHAPE_POLY_SET& aBuffer, int aClearance, int aMaxError,
 ERROR_LOC aErrorLoc ) const;
 
 void TransformShapeToPolygon( SHAPE_POLY_SET& aBuffer, PCB_LAYER_ID aLayer, int aClearance,
 int aMaxError, ERROR_LOC aErrorLoc,
 bool aIgnoreLineWidth = false ) const override;
 
 // @copydoc BOARD_ITEM::GetEffectiveShape
 std::shared_ptr<SHAPE> GetEffectiveShape( PCB_LAYER_ID aLayer = UNDEFINED_LAYER,
 FLASHING aFlash = FLASHING::DEFAULT ) const override;
 
 wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override;
 
 BITMAPS GetMenuImage() const override;
 
 double ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;
 
 void ViewGetLayers( int aLayers[], int& aCount ) const override;
 
 EDA_ITEM* Clone() const override;
 
 bool IsBorderEnabled() const;
 
 void SetBorderEnabled( bool enabled );
 
 void SetBorderWidth( const int aSize );
 int GetBorderWidth() const { return m_stroke.GetWidth(); }
 
 double Similarity( const BOARD_ITEM& aBoardItem ) const override;
 
 bool operator==( const BOARD_ITEM& aBoardItem ) const override;
 
protected:
 bool m_borderEnabled; 
 
 virtual void swapData( BOARD_ITEM* aImage ) override;
 
 const KIFONT::METRICS& getFontMetrics() const override { return GetFontMetrics(); }
 
private:
 int m_marginLeft;
 int m_marginTop;
 int m_marginRight;
 int m_marginBottom;
};
 
#endif // #define PCB_TEXTBOX_H