KiCad PCB EDA Suite
pcb_textbox.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2004 Jean-Pierre Charras, [email protected]
5 * Copyright (C) 1992-2022 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25#ifndef PCB_TEXTBOX_H
26#define PCB_TEXTBOX_H
27
28#include <eda_text.h>
29#include <pcb_shape.h>
30
31
32class LINE_READER;
33class MSG_PANEL_ITEM;
34
35
36class PCB_TEXTBOX : public PCB_SHAPE, public EDA_TEXT
37{
38public:
39 PCB_TEXTBOX( BOARD_ITEM* parent );
40
41 // Do not create a copy constructor & operator=.
42 // The ones generated by the compiler are adequate.
43
45
46 static inline bool ClassOf( const EDA_ITEM* aItem )
47 {
48 return aItem && PCB_TEXTBOX_T == aItem->Type();
49 }
50
51 bool IsType( const std::vector<KICAD_T>& aScanTypes ) const override
52 {
53 if( BOARD_ITEM::IsType( aScanTypes ) )
54 return true;
55
56 for( KICAD_T scanType : aScanTypes )
57 {
58 if( scanType == PCB_LOCATE_TEXT_T )
59 return true;
60 }
61
62 return false;
63 }
64
65 VECTOR2I GetTopLeft() const override;
66 VECTOR2I GetBotRight() const override;
67
68 void SetTop( int aVal ) override;
69 void SetLeft( int aVal ) override;
70 void SetRight( int aVal ) override;
71 void SetBottom( int aVal ) override;
72
73 int GetTextMargin() const;
74
75 VECTOR2I GetDrawPos() const override;
76
77 wxString GetShownText( int aDepth = 0 ) const override;
78
80 void SetVisible( bool aVisible ) override { /* do nothing */}
81 bool IsVisible() const override { return true; }
82
83 bool Matches( const EDA_SEARCH_DATA& aSearchData, void* aAuxData ) const override
84 {
85 return BOARD_ITEM::Matches( GetShownText(), aSearchData );
86 }
87
88 std::vector<VECTOR2I> GetAnchorAndOppositeCorner() const;
89
90 void Move( const VECTOR2I& aMoveVector ) override;
91
92 void Rotate( const VECTOR2I& aRotCentre, const EDA_ANGLE& aAngle ) override;
93
94 void Mirror( const VECTOR2I& aCentre, bool aMirrorAroundXAxis ) override;
95
96 void Flip( const VECTOR2I& aCentre, bool aFlipLeftRight ) override;
97
98 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
99
100 bool HitTest( const VECTOR2I& aPosition, int aAccuracy ) const override;
101
102 bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override;
103
104 wxString GetClass() const override
105 {
106 return wxT( "PCB_TEXTBOX" );
107 }
108
119 PCB_LAYER_ID aLayer, int aClearanceValue,
120 int aError, ERROR_LOC aErrorLoc ) const;
121
123 int aClearanceValue, int aError, ERROR_LOC aErrorLoc,
124 bool aIgnoreLineWidth = false ) const override;
125
126 // @copydoc BOARD_ITEM::GetEffectiveShape
127 virtual std::shared_ptr<SHAPE> GetEffectiveShape( PCB_LAYER_ID aLayer = UNDEFINED_LAYER,
128 FLASHING aFlash = FLASHING::DEFAULT ) const override;
129
130 wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override;
131
132 BITMAPS GetMenuImage() const override;
133
134 double ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;
135
136 EDA_ITEM* Clone() const override;
137
138 virtual void SwapData( BOARD_ITEM* aImage ) override;
139};
140
141#endif // #define PCB_TEXTBOX_H
BITMAPS
A list of all bitmap identifiers.
Definition: bitmaps_list.h:33
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:50
The base class for create windows for drawing purpose.
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:85
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:97
virtual bool Matches(const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const
Compare the item against the search criteria in aSearchData.
Definition: eda_item.h:382
virtual bool IsType(const std::vector< KICAD_T > &aScanTypes) const
Check whether the item is one of the listed types.
Definition: eda_item.h:183
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
Definition: eda_text.h:72
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition: view.h:69
An abstract class from which implementation specific LINE_READERs may be derived to read single lines...
Definition: richio.h:81
EDA_MSG_PANEL items for displaying messages.
Definition: msgpanel.h:54
bool HitTest(const VECTOR2I &aPosition, int aAccuracy) const override
Test if aPosition is inside or on the boundary of this item.
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
void Rotate(const VECTOR2I &aRotCentre, const EDA_ANGLE &aAngle) override
Rotate this object.
int GetTextMargin() const
Definition: pcb_textbox.cpp:55
void SetVisible(bool aVisible) override
PCB_TEXTBOXes are always visible:
Definition: pcb_textbox.h:80
bool IsType(const std::vector< KICAD_T > &aScanTypes) const override
Check whether the item is one of the listed types.
Definition: pcb_textbox.h:51
std::vector< VECTOR2I > GetAnchorAndOppositeCorner() const
virtual void SwapData(BOARD_ITEM *aImage) override
Swap data between aItem and aImage.
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
virtual std::shared_ptr< SHAPE > GetEffectiveShape(PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=FLASHING::DEFAULT) const override
Make a set of SHAPE objects representing the PCB_SHAPE.
void TransformTextShapeWithClearanceToPolygon(SHAPE_POLY_SET &aCornerBuffer, PCB_LAYER_ID aLayer, int aClearanceValue, int aError, ERROR_LOC aErrorLoc) const
Function TransformTextShapeWithClearanceToPolygon Convert the text to a polygonSet describing the act...
bool Matches(const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const override
Compare the item against the search criteria in aSearchData.
Definition: pcb_textbox.h:83
VECTOR2I GetDrawPos() const override
void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.
void SetLeft(int aVal) override
double ViewGetLOD(int aLayer, KIGFX::VIEW *aView) const override
Return the level of detail (LOD) of the item.
static bool ClassOf(const EDA_ITEM *aItem)
Definition: pcb_textbox.h:46
void SetRight(int aVal) override
wxString GetShownText(int aDepth=0) const override
Return the string actually shown after processing of the base text.
void SetTop(int aVal) override
Definition: pcb_textbox.cpp:91
PCB_TEXTBOX(BOARD_ITEM *parent)
Definition: pcb_textbox.cpp:40
wxString GetSelectMenuText(UNITS_PROVIDER *aUnitsProvider) const override
Return the text to display to be used in the selection clarification context menu when multiple items...
void Move(const VECTOR2I &aMoveVector) override
Move this object.
void SetBottom(int aVal) override
void Mirror(const VECTOR2I &aCentre, bool aMirrorAroundXAxis) override
void Flip(const VECTOR2I &aCentre, bool aFlipLeftRight) override
Flip this object, i.e.
VECTOR2I GetTopLeft() const override
Definition: pcb_textbox.cpp:61
VECTOR2I GetBotRight() const override
Definition: pcb_textbox.cpp:76
void TransformShapeWithClearanceToPolygon(SHAPE_POLY_SET &aCornerBuffer, PCB_LAYER_ID aLayer, int aClearanceValue, int aError, ERROR_LOC aErrorLoc, bool aIgnoreLineWidth=false) const override
Convert the shape to a closed polygon.
bool IsVisible() const override
Definition: pcb_textbox.h:81
wxString GetClass() const override
Return the class name.
Definition: pcb_textbox.h:104
Represent a set of closed polygons.
ERROR_LOC
When approximating an arc or circle, should the error be placed on the outside or inside of the curve...
FLASHING
Enum used during connectivity building to ensure we do not query connectivity while building the data...
Definition: layer_ids.h:147
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:59
@ UNDEFINED_LAYER
Definition: layer_ids.h:60
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:78
@ PCB_TEXTBOX_T
class PCB_TEXTBOX, wrapped text on a layer
Definition: typeinfo.h:91
@ PCB_LOCATE_TEXT_T
Definition: typeinfo.h:123