KiCad PCB EDA Suite
sch_field.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) 2004-2021 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 CLASS_SCH_FIELD_H
26 #define CLASS_SCH_FIELD_H
27 
28 
29 #include <eda_text.h>
30 #include <sch_item.h>
31 #include <template_fieldnames.h>
32 #include <general.h>
33 
34 class SCH_EDIT_FRAME;
35 class SCH_COMPONENT;
36 class LIB_FIELD;
37 
38 
50 class SCH_FIELD : public SCH_ITEM, public EDA_TEXT
51 {
52 public:
53  SCH_FIELD( const wxPoint& aPos, int aFieldId, SCH_ITEM* aParent,
54  const wxString& aName = wxEmptyString );
55 
56  // Do not create a copy constructor. The one generated by the compiler is adequate.
57 
58  ~SCH_FIELD();
59 
60  static inline bool ClassOf( const EDA_ITEM* aItem )
61  {
62  return aItem && SCH_FIELD_T == aItem->Type();
63  }
64 
65  wxString GetClass() const override
66  {
67  return wxT( "SCH_FIELD" );
68  }
69 
70  bool IsType( const KICAD_T aScanTypes[] ) const override
71  {
72  if( SCH_ITEM::IsType( aScanTypes ) )
73  return true;
74 
75  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
76  {
78  return true;
79  else if ( *p == SCH_FIELD_LOCATE_VALUE_T && m_id == VALUE_FIELD )
80  return true;
81  else if ( *p == SCH_FIELD_LOCATE_FOOTPRINT_T && m_id == FOOTPRINT_FIELD )
82  return true;
83  else if ( *p == SCH_FIELD_LOCATE_DATASHEET_T && m_id == DATASHEET_FIELD )
84  return true;
85  }
86 
87  return false;
88  }
89 
90  bool IsHypertext() const override
91  {
92  return m_parent && m_parent->Type() == SCH_GLOBAL_LABEL_T;
93  }
94 
95  void DoHypertextMenu( EDA_DRAW_FRAME* aFrame ) override;
96 
104  wxString GetName( bool aUseDefaultName = true ) const;
105 
110  wxString GetCanonicalName() const;
111 
112  void SetName( const wxString& aName ) { m_name = aName; }
113 
114  int GetId() const { return m_id; }
115 
116  void SetId( int aId );
117 
118  wxString GetShownText( int aDepth = 0 ) const override;
119 
120  const EDA_RECT GetBoundingBox() const override;
121 
126  bool IsHorizJustifyFlipped() const;
127 
131  bool IsVoid() const;
132 
133  void SwapData( SCH_ITEM* aItem ) override;
134 
142  void ImportValues( const LIB_FIELD& aSource );
143 
144  int GetPenWidth() const override;
145 
146  void Print( const RENDER_SETTINGS* aSettings, const wxPoint& aOffset ) override;
147 
148  void Move( const wxPoint& aMoveVector ) override
149  {
150  Offset( aMoveVector );
151  }
152 
153  void Rotate( wxPoint aCenter ) override;
154 
162  void MirrorVertically( int aCenter ) override
163  {
164  }
165 
173  void MirrorHorizontally( int aCenter ) override
174  {
175  }
176 
177  bool Matches( const wxFindReplaceData& aSearchData, void* aAuxData ) const override;
178 
179  bool Replace( const wxFindReplaceData& aSearchData, void* aAuxData = NULL ) override;
180 
181  wxString GetSelectMenuText( EDA_UNITS aUnits ) const override;
182 
183  BITMAPS GetMenuImage() const override;
184 
185  bool IsReplaceable() const override;
186 
187  wxPoint GetLibPosition() const { return EDA_TEXT::GetTextPos(); }
188 
189  wxPoint GetPosition() const override;
190  void SetPosition( const wxPoint& aPosition ) override;
191 
192  wxPoint GetParentPosition() const;
193 
194  bool HitTest( const wxPoint& aPosition, int aAccuracy = 0 ) const override;
195  bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const override;
196 
197  void Plot( PLOTTER* aPlotter ) const override;
198 
199  EDA_ITEM* Clone() const override;
200 
201  bool operator <( const SCH_ITEM& aItem ) const override;
202 
203 #if defined(DEBUG)
204  void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
205 #endif
206 
207 private:
208  int m_id;
209 
210  wxString m_name;
211 };
212 
213 
214 #endif /* CLASS_SCH_FIELD_H */
Field Reference of part, i.e. "IC21".
void Move(const wxPoint &aMoveVector) override
Move the item by aMoveVector to a new position.
Definition: sch_field.h:148
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:50
void Offset(const wxPoint &aOffset)
Definition: eda_text.h:259
EDA_ITEM * m_parent
Linked list: Link (parent struct)
Definition: eda_item.h:529
static bool ClassOf(const EDA_ITEM *aItem)
Definition: sch_field.h:60
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
Definition: sch_field.cpp:73
void ImportValues(const LIB_FIELD &aSource)
Copy parameters from a LIB_FIELD source.
Definition: sch_field.cpp:243
void Rotate(wxPoint aCenter) override
Rotate the item around aCenter 90 degrees in the clockwise direction.
Definition: sch_field.cpp:462
wxPoint GetPosition() const override
Definition: sch_field.cpp:707
Field object used in symbol libraries.
Definition: lib_field.h:59
bool IsHypertext() const override
Allow items to support hypertext actions when hovered/clicked.
Definition: sch_field.h:90
int GetId() const
Definition: sch_field.h:114
Schematic editor (Eeschema) main window.
wxString GetSelectMenuText(EDA_UNITS aUnits) const override
Return the text to display to be used in the selection clarification context menu when multiple items...
Definition: sch_field.cpp:470
The base class for create windows for drawing purpose.
void DoHypertextMenu(EDA_DRAW_FRAME *aFrame) override
Definition: sch_field.cpp:478
wxString m_name
Definition: sch_field.h:210
wxString GetShownText(int aDepth=0) const override
Return the string actually shown after processing of the base text.
Definition: sch_field.cpp:104
search types array terminator (End Of Types)
Definition: typeinfo.h:81
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:77
bool IsVoid() const
Definition: sch_field.cpp:321
name of datasheet
bool Replace(const wxFindReplaceData &aSearchData, void *aAuxData=NULL) override
Perform a text replace using the find and replace criteria in aSearchData on items that support text ...
Definition: sch_field.cpp:394
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
Definition: eda_text.h:119
bool operator<(const SCH_ITEM &aItem) const override
Definition: sch_field.cpp:729
wxString GetCanonicalName() const
Get a non-language-specific name for a field which can be used for storage, variable look-up,...
Definition: sch_field.cpp:560
Field Value of part, i.e. "3.3K".
#define NULL
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
Definition: sch_field.cpp:589
bool IsType(const KICAD_T aScanTypes[]) const override
Check whether the item is one of the listed types.
Definition: sch_field.h:70
void MirrorVertically(int aCenter) override
Mirror item vertically about aCenter.
Definition: sch_field.h:162
SCH_FIELD(const wxPoint &aPos, int aFieldId, SCH_ITEM *aParent, const wxString &aName=wxEmptyString)
Definition: sch_field.cpp:55
bool HitTest(const wxPoint &aPosition, int aAccuracy=0) const override
Test if aPosition is contained within or on the bounding box of an item.
Definition: sch_field.cpp:606
virtual bool IsType(const KICAD_T aScanTypes[]) const
Check whether the item is one of the listed types.
Definition: eda_item.h:233
wxPoint GetLibPosition() const
Definition: sch_field.h:187
EDA_UNITS
Definition: eda_units.h:38
Base plotter engine class.
Definition: plotter.h:121
BITMAPS
A list of all bitmap identifiers.
Definition: bitmaps_list.h:32
const EDA_RECT GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition: sch_field.cpp:262
void SwapData(SCH_ITEM *aItem) override
Swap the internal data structures aItem with the schematic item.
Definition: sch_field.cpp:249
wxString GetName(bool aUseDefaultName=true) const
Return the field name.
Definition: sch_field.cpp:542
Handle the component boundary box.
Definition: eda_rect.h:42
void SetName(const wxString &aName)
Definition: sch_field.h:112
Schematic symbol object.
Definition: sch_symbol.h:78
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:150
wxString GetClass() const override
Return the class name.
Definition: sch_field.h:65
bool IsHorizJustifyFlipped() const
Return whether the field will be rendered with the horizontal justification inverted due to rotation ...
Definition: sch_field.cpp:304
const wxPoint & GetTextPos() const
Definition: eda_text.h:254
bool IsReplaceable() const override
Override this method in any derived object that supports test find and replace.
Definition: sch_field.cpp:367
void SetId(int aId)
Definition: sch_field.cpp:79
wxPoint GetParentPosition() const
Definition: sch_field.cpp:723
void Print(const RENDER_SETTINGS *aSettings, const wxPoint &aOffset) override
Print a schematic item.
Definition: sch_field.cpp:198
int m_id
Field index,.
Definition: sch_field.h:208
void SetPosition(const wxPoint &aPosition) override
Definition: sch_field.cpp:687
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:197
void MirrorHorizontally(int aCenter) override
Mirror item horizontally about aCenter.
Definition: sch_field.h:173
bool Matches(const wxFindReplaceData &aSearchData, void *aAuxData) const override
Compare the item against the search criteria in aSearchData.
Definition: sch_field.cpp:327
void Plot(PLOTTER *aPlotter) const override
Plot the schematic item to aPlotter.
Definition: sch_field.cpp:637
int GetPenWidth() const override
Definition: sch_field.cpp:192
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:163
Field Name Module PCB, i.e. "16DIP300".