KiCad PCB EDA Suite
sch_text.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) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
5  * Copyright (C) 1992-2019 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 
30 #ifndef CLASS_TEXT_LABEL_H
31 #define CLASS_TEXT_LABEL_H
32 
33 
34 #include <macros.h>
35 #include <eda_text.h>
36 #include <sch_item.h>
37 #include <sch_connection.h> // for CONNECTION_TYPE
38 
39 
40 class LINE_READER;
42 
43 
44 /* Shape/Type of SCH_HIERLABEL and SCH_GLOBALLABEL
45  * mainly used to handle the graphic associated shape
46  */
53 };
54 
55 
56 extern const char* SheetLabelType[]; /* names of types of labels */
57 
58 
59 class SCH_TEXT : public SCH_ITEM, public EDA_TEXT
60 {
61 protected:
63 
67 
69 
80 
81 public:
82  SCH_TEXT( const wxPoint& pos = wxPoint( 0, 0 ),
83  const wxString& text = wxEmptyString,
84  KICAD_T aType = SCH_TEXT_T );
85 
92  SCH_TEXT( const SCH_TEXT& aText );
93 
94  ~SCH_TEXT() { }
95 
96  virtual wxString GetClass() const override
97  {
98  return wxT( "SCH_TEXT" );
99  }
100 
106  void IncrementLabel( int aIncrement );
107 
118  virtual void SetLabelSpinStyle( int aSpinStyle );
119  int GetLabelSpinStyle() const { return m_spin_style; }
120 
122 
123  void SetShape( PINSHEETLABEL_SHAPE aShape ) { m_shape = aShape; }
124 
131  virtual wxPoint GetSchematicTextOffset() const;
132 
133  void Print( wxDC* DC, const wxPoint& offset ) override;
134 
142  virtual void CreateGraphicShape( std::vector <wxPoint>& aPoints, const wxPoint& Pos )
143  {
144  aPoints.clear();
145  }
146 
147  void SwapData( SCH_ITEM* aItem ) override;
148 
149  const EDA_RECT GetBoundingBox() const override;
150 
151  int GetPenSize() const override;
152 
153  // Geometric transforms (used in block operations):
154 
155  void Move( const wxPoint& aMoveVector ) override
156  {
157  EDA_TEXT::Offset( aMoveVector );
158  }
159 
160  void MirrorY( int aYaxis_position ) override;
161  void MirrorX( int aXaxis_position ) override;
162  void Rotate( wxPoint aPosition ) override;
163 
164  bool Matches( wxFindReplaceData& aSearchData, void* aAuxData ) override
165  {
166  return SCH_ITEM::Matches( GetText(), aSearchData );
167  }
168 
169  bool Replace( wxFindReplaceData& aSearchData, void* aAuxData ) override
170  {
171  return EDA_TEXT::Replace( aSearchData );
172  }
173 
174  virtual bool IsReplaceable() const override { return true; }
175 
176  void GetEndPoints( std::vector< DANGLING_END_ITEM >& aItemList ) override;
177 
178  bool UpdateDanglingState( std::vector<DANGLING_END_ITEM>& aItemList ) override;
179 
180  bool IsDangling() const override { return m_isDangling; }
181  void SetIsDangling( bool aIsDangling ) { m_isDangling = aIsDangling; }
182 
183  void GetConnectionPoints( std::vector< wxPoint >& aPoints ) const override;
184 
185  bool CanIncrementLabel() const override { return true; }
186 
187  wxString GetSelectMenuText( EDA_UNITS_T aUnits ) const override;
188 
189  BITMAP_DEF GetMenuImage() const override;
190 
191  void GetNetListItem( NETLIST_OBJECT_LIST& aNetListItems, SCH_SHEET_PATH* aSheetPath ) override;
192 
193  wxPoint GetPosition() const override { return EDA_TEXT::GetTextPos(); }
194  void SetPosition( const wxPoint& aPosition ) override { EDA_TEXT::SetTextPos( aPosition ); }
195 
196  bool HitTest( const wxPoint& aPosition, int aAccuracy = 0 ) const override;
197  bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const override;
198 
199  void Plot( PLOTTER* aPlotter ) override;
200 
201  EDA_ITEM* Clone() const override;
202 
203  void GetMsgPanelInfo( EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM >& aList ) override;
204 
205 #if defined(DEBUG)
206  void Show( int nestLevel, std::ostream& os ) const override;
207 #endif
208 };
209 
210 
211 class SCH_LABEL : public SCH_TEXT
212 {
213 public:
214  SCH_LABEL( const wxPoint& pos = wxPoint( 0, 0 ), const wxString& text = wxEmptyString );
215 
216  // Do not create a copy constructor. The one generated by the compiler is adequate.
217 
219 
220  wxString GetClass() const override
221  {
222  return wxT( "SCH_LABEL" );
223  }
224 
225  bool IsType( const KICAD_T aScanTypes[] ) override ;
226 
227  const EDA_RECT GetBoundingBox() const override;
228 
229  bool IsConnectable() const override { return true; }
230 
231  bool CanConnect( const SCH_ITEM* aItem ) const override
232  {
233  return aItem->Type() == SCH_LINE_T &&
234  ( aItem->GetLayer() == LAYER_WIRE || aItem->GetLayer() == LAYER_BUS );
235  }
236 
237  wxString GetSelectMenuText( EDA_UNITS_T aUnits ) const override;
238 
239  BITMAP_DEF GetMenuImage() const override;
240 
241  bool IsReplaceable() const override { return true; }
242 
243  EDA_ITEM* Clone() const override;
244 
245 private:
246  bool doIsConnected( const wxPoint& aPosition ) const override { return EDA_TEXT::GetTextPos() == aPosition; }
247 };
248 
249 
250 class SCH_GLOBALLABEL : public SCH_TEXT
251 {
252 public:
253  SCH_GLOBALLABEL( const wxPoint& pos = wxPoint( 0, 0 ), const wxString& text = wxEmptyString );
254 
255  // Do not create a copy constructor. The one generated by the compiler is adequate.
256 
258 
259  void Print( wxDC* DC, const wxPoint& offset ) override;
260 
261  wxString GetClass() const override
262  {
263  return wxT( "SCH_GLOBALLABEL" );
264  }
265 
266  void SetLabelSpinStyle( int aSpinStyle ) override;
267 
268  wxPoint GetSchematicTextOffset() const override;
269 
270  const EDA_RECT GetBoundingBox() const override;
271 
272  void CreateGraphicShape( std::vector <wxPoint>& aPoints, const wxPoint& aPos ) override;
273 
274  bool IsConnectable() const override { return true; }
275 
276  bool CanConnect( const SCH_ITEM* aItem ) const override
277  {
278  return aItem->Type() == SCH_LINE_T &&
279  ( aItem->GetLayer() == LAYER_WIRE || aItem->GetLayer() == LAYER_BUS );
280  }
281 
282  wxString GetSelectMenuText( EDA_UNITS_T aUnits ) const override;
283 
284  BITMAP_DEF GetMenuImage() const override;
285 
286  EDA_ITEM* Clone() const override;
287 
288 private:
289  bool doIsConnected( const wxPoint& aPosition ) const override { return EDA_TEXT::GetTextPos() == aPosition; }
290 };
291 
292 
293 class SCH_HIERLABEL : public SCH_TEXT
294 {
295 public:
296  SCH_HIERLABEL( const wxPoint& pos = wxPoint( 0, 0 ),
297  const wxString& text = wxEmptyString,
298  KICAD_T aType = SCH_HIER_LABEL_T );
299 
300  // Do not create a copy constructor. The one generated by the compiler is adequate.
301 
303 
304  void Print( wxDC* DC, const wxPoint& offset ) override;
305 
306  wxString GetClass() const override
307  {
308  return wxT( "SCH_HIERLABEL" );
309  }
310 
311  void SetLabelSpinStyle( int aSpinStyle ) override;
312 
313  wxPoint GetSchematicTextOffset() const override;
314 
315  void CreateGraphicShape( std::vector <wxPoint>& aPoints, const wxPoint& Pos ) override;
316 
317  const EDA_RECT GetBoundingBox() const override;
318 
319  bool IsConnectable() const override { return true; }
320 
321  bool CanConnect( const SCH_ITEM* aItem ) const override
322  {
323  return aItem->Type() == SCH_LINE_T &&
324  ( aItem->GetLayer() == LAYER_WIRE || aItem->GetLayer() == LAYER_BUS );
325  }
326 
327  wxString GetSelectMenuText( EDA_UNITS_T aUnits ) const override;
328 
329  BITMAP_DEF GetMenuImage() const override;
330 
331  EDA_ITEM* Clone() const override;
332 
333 private:
334  bool doIsConnected( const wxPoint& aPosition ) const override { return EDA_TEXT::GetTextPos() == aPosition; }
335 };
336 
337 #endif /* CLASS_TEXT_LABEL_H */
bool IsDangling() const override
Definition: sch_text.h:180
SCH_HIERLABEL(const wxPoint &pos=wxPoint(0, 0), const wxString &text=wxEmptyString, KICAD_T aType=SCH_HIER_LABEL_T)
Definition: sch_text.cpp:995
void Offset(const wxPoint &aOffset)
Definition: eda_text.h:235
BITMAP_DEF GetMenuImage() const override
Function GetMenuImage returns a pointer to an image to be used in menus.
Definition: sch_text.cpp:719
void Print(wxDC *DC, const wxPoint &offset) override
Function Print Print a schematic item.
Definition: sch_text.cpp:299
void SetShape(PINSHEETLABEL_SHAPE aShape)
Definition: sch_text.h:123
Class LINE_READER is an abstract class from which implementation specific LINE_READERs may be derived...
Definition: richio.h:81
wxString GetSelectMenuText(EDA_UNITS_T aUnits) const override
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
Definition: sch_text.cpp:982
bool IsReplaceable() const override
Function IsReplaceable.
Definition: sch_text.h:241
bool CanConnect(const SCH_ITEM *aItem) const override
Definition: sch_text.h:231
int GetPenSize() const override
Function GetPenSize virtual pure.
Definition: sch_text.cpp:281
SCH_GLOBALLABEL(const wxPoint &pos=wxPoint(0, 0), const wxString &text=wxEmptyString)
Definition: sch_text.cpp:725
virtual bool IsReplaceable() const override
Function IsReplaceable.
Definition: sch_text.h:174
bool m_isDangling
True if not connected to another object if the object derive from SCH_TEXT supports connections.
Definition: sch_text.h:66
bool HitTest(const wxPoint &aPosition, int aAccuracy=0) const override
Function HitTest tests if aPosition is contained within or on the bounding box of an item.
Definition: sch_text.cpp:484
virtual void SetLabelSpinStyle(int aSpinStyle)
Set a spin or rotation angle, along with specific horizontal and vertical justification styles with e...
Definition: sch_text.cpp:232
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:229
virtual wxPoint GetSchematicTextOffset() const
Definition: sch_text.cpp:147
bool UpdateDanglingState(std::vector< DANGLING_END_ITEM > &aItemList) override
Function IsDanglingStateChanged tests the schematic item to aItemList to check if it's dangling state...
Definition: sch_text.cpp:328
bool Matches(wxFindReplaceData &aSearchData, void *aAuxData) override
Function Matches compares the item against the search criteria in aSearchData.
Definition: sch_text.h:164
bool CanIncrementLabel() const override
Definition: sch_text.h:185
CONNECTION_TYPE
void SetIsDangling(bool aIsDangling)
Definition: sch_text.h:181
CONNECTION_TYPE m_connectionType
Definition: sch_text.h:68
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
void MirrorX(int aXaxis_position) override
Function MirrorX mirrors item relative to the X axis about aXaxis_position.
Definition: sch_text.cpp:183
BITMAP_DEF GetMenuImage() const override
Function GetMenuImage returns a pointer to an image to be used in menus.
Definition: sch_text.cpp:988
This file contains miscellaneous commonly used macros and functions.
Class NETLIST_OBJECT_LIST is a container holding and owning NETLIST_OBJECTs, which are connected item...
Class EDA_TEXT is a mix-in class (via multiple inheritance) that handles texts such as labels,...
Definition: eda_text.h:109
int GetLabelSpinStyle() const
Definition: sch_text.h:119
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
Definition: sch_text.cpp:651
void Move(const wxPoint &aMoveVector) override
Function Move moves the item by aMoveVector to a new position.
Definition: sch_text.h:155
wxString GetClass() const override
Function GetClass returns the class name.
Definition: sch_text.h:306
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
Definition: sch_text.cpp:133
void GetConnectionPoints(std::vector< wxPoint > &aPoints) const override
Function GetConnectionPoints add all the connection points for this item to aPoints.
Definition: sch_text.cpp:407
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
Definition: sch_text.cpp:1005
bool doIsConnected(const wxPoint &aPosition) const override
Function doIsConnected provides the object specific test to see if it is connected to aPosition.
Definition: sch_text.h:246
wxPoint GetSchematicTextOffset() const override
Definition: sch_text.cpp:741
wxString GetSelectMenuText(EDA_UNITS_T aUnits) const override
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
Definition: sch_text.cpp:444
const char * SheetLabelType[]
Definition: sch_text.cpp:57
void CreateGraphicShape(std::vector< wxPoint > &aPoints, const wxPoint &aPos) override
Calculate the graphic shape (a polygon) associated to the text.
Definition: sch_text.cpp:836
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: sch_text.cpp:929
void GetEndPoints(std::vector< DANGLING_END_ITEM > &aItemList) override
Function GetEndPoints adds the schematic item end points to aItemList if the item has end points.
Definition: sch_text.cpp:317
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: sch_text.cpp:1090
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: sch_text.cpp:417
Class SCH_SHEET_PATH.
bool IsType(const KICAD_T aScanTypes[]) override
Function IsType Checks whether the item is one of the listed types.
Definition: sch_text.cpp:657
wxPoint GetPosition() const override
Function GetPosition.
Definition: sch_text.h:193
wxString GetClass() const override
Function GetClass returns the class name.
Definition: sch_text.h:220
bool IsConnectable() const override
Function IsConnectable returns true if the schematic item can connect to another schematic item.
Definition: sch_text.h:229
wxString GetSelectMenuText(EDA_UNITS_T aUnits) const override
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
Definition: sch_text.cpp:1162
void Print(wxDC *DC, const wxPoint &offset) override
Function Print Print a schematic item.
Definition: sch_text.cpp:1045
SCH_LAYER_ID GetLayer() const
Function GetLayer returns the layer this item is on.
Definition: sch_item.h:193
~SCH_LABEL()
Definition: sch_text.h:218
bool CanConnect(const SCH_ITEM *aItem) const override
Definition: sch_text.h:321
void CreateGraphicShape(std::vector< wxPoint > &aPoints, const wxPoint &Pos) override
Calculate the graphic shape (a polygon) associated to the text.
Definition: sch_text.cpp:1068
Base plotter engine class.
Definition: plotter.h:97
void SetLabelSpinStyle(int aSpinStyle) override
Set a spin or rotation angle, along with specific horizontal and vertical justification styles with e...
Definition: sch_text.cpp:1011
PINSHEETLABEL_SHAPE
Definition: sch_text.h:47
virtual void CreateGraphicShape(std::vector< wxPoint > &aPoints, const wxPoint &Pos)
Calculate the graphic shape (a polygon) associated to the text.
Definition: sch_text.h:142
wxString GetClass() const override
Function GetClass returns the class name.
Definition: sch_text.h:261
void Plot(PLOTTER *aPlotter) override
Function Plot plots the schematic item to aPlotter.
Definition: sch_text.cpp:504
bool IsConnectable() const override
Function IsConnectable returns true if the schematic item can connect to another schematic item.
Definition: sch_text.h:274
bool Replace(wxFindReplaceData &aSearchData)
Helper function used in search and replace dialog performs a text replace using the find and replace ...
Definition: eda_text.cpp:138
void SwapData(SCH_ITEM *aItem) override
Function SwapData swap the internal data structures aItem with the schematic item.
Definition: sch_text.cpp:266
void Rotate(wxPoint aPosition) override
Function Rotate rotates the item around aPosition 90 degrees in the clockwise direction.
Definition: sch_text.cpp:199
virtual wxString GetClass() const override
Function GetClass returns the class name.
Definition: sch_text.h:96
SCH_TEXT(const wxPoint &pos=wxPoint(0, 0), const wxString &text=wxEmptyString, KICAD_T aType=SCH_TEXT_T)
Definition: sch_text.cpp:107
BITMAP_DEF GetMenuImage() const override
Function GetMenuImage returns a pointer to an image to be used in menus.
Definition: sch_text.cpp:450
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
void GetMsgPanelInfo(EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM > &aList) override
Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for displ...
Definition: sch_text.cpp:554
int m_spin_style
The orientation of text and any associated drawing elements of derived objects.
Definition: sch_text.h:79
~SCH_TEXT()
Definition: sch_text.h:94
bool CanConnect(const SCH_ITEM *aItem) const override
Definition: sch_text.h:276
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:163
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: sch_text.cpp:689
const wxPoint & GetTextPos() const
Definition: eda_text.h:230
PINSHEETLABEL_SHAPE m_shape
Definition: sch_text.h:62
bool Replace(wxFindReplaceData &aSearchData, void *aAuxData) override
Function Replace performs a text replace using the find and replace criteria in aSearchData on items ...
Definition: sch_text.h:169
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
Definition: sch_text.cpp:735
void MirrorY(int aYaxis_position) override
Function MirrorY mirrors item relative to the Y axis about aYaxis_position.
Definition: sch_text.cpp:167
void SetPosition(const wxPoint &aPosition) override
Function SetPosition set the schematic item position to aPosition.
Definition: sch_text.h:194
wxString GetSelectMenuText(EDA_UNITS_T aUnits) const override
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
Definition: sch_text.cpp:713
BITMAP_DEF GetMenuImage() const override
Function GetMenuImage returns a pointer to an image to be used in menus.
Definition: sch_text.cpp:1168
bool IsConnectable() const override
Function IsConnectable returns true if the schematic item can connect to another schematic item.
Definition: sch_text.h:319
virtual bool Matches(wxFindReplaceData &aSearchData, void *aAuxData)
Function Matches compares the item against the search criteria in aSearchData.
Definition: base_struct.h:492
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114
virtual const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:124
SCH_LABEL(const wxPoint &pos=wxPoint(0, 0), const wxString &text=wxEmptyString)
Definition: sch_text.cpp:641
void SetLabelSpinStyle(int aSpinStyle) override
Set a spin or rotation angle, along with specific horizontal and vertical justification styles with e...
Definition: sch_text.cpp:780
wxPoint GetSchematicTextOffset() const override
Definition: sch_text.cpp:1143
EDA_UNITS_T
Definition: common.h:154
bool doIsConnected(const wxPoint &aPosition) const override
Function doIsConnected provides the object specific test to see if it is connected to aPosition.
Definition: sch_text.h:289
void GetNetListItem(NETLIST_OBJECT_LIST &aNetListItems, SCH_SHEET_PATH *aSheetPath) override
Function GetNetListItem creates a new NETLIST_OBJECT for the schematic object and adds it to aNetList...
Definition: sch_text.cpp:456
void Print(wxDC *DC, const wxPoint &offset) override
Function Print Print a schematic item.
Definition: sch_text.cpp:814
PINSHEETLABEL_SHAPE GetShape() const
Definition: sch_text.h:121
bool doIsConnected(const wxPoint &aPosition) const override
Function doIsConnected provides the object specific test to see if it is connected to aPosition.
Definition: sch_text.h:334
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210
void IncrementLabel(int aIncrement)
Increment the label text, if it ends with a number.
Definition: sch_text.cpp:139