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-2019 KiCad Developers, see change_log.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 
35 class SCH_EDIT_FRAME;
36 class SCH_COMPONENT;
37 class LIB_FIELD;
38 
39 
52 class SCH_FIELD : public SCH_ITEM, public EDA_TEXT
53 {
54  int m_id;
55 
56  wxString m_name;
57 
58 public:
59  SCH_FIELD( const wxPoint& aPos, int aFieldId, SCH_ITEM* aParent,
60  const wxString& aName = wxEmptyString );
61 
62  // Do not create a copy constructor. The one generated by the compiler is adequate.
63 
64  ~SCH_FIELD();
65 
66  static inline bool ClassOf( const EDA_ITEM* aItem )
67  {
68  return aItem && SCH_FIELD_T == aItem->Type();
69  }
70 
71  wxString GetClass() const override
72  {
73  return wxT( "SCH_FIELD" );
74  }
75 
76  bool IsType( const KICAD_T aScanTypes[] ) const override
77  {
78  if( SCH_ITEM::IsType( aScanTypes ) )
79  return true;
80 
81  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
82  {
84  return true;
85  else if ( *p == SCH_FIELD_LOCATE_VALUE_T && m_id == VALUE )
86  return true;
87  else if ( *p == SCH_FIELD_LOCATE_FOOTPRINT_T && m_id == FOOTPRINT )
88  return true;
89  else if ( *p == SCH_FIELD_LOCATE_DATASHEET_T && m_id == DATASHEET )
90  return true;
91  }
92 
93  return false;
94  }
95 
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 
127  bool IsHorizJustifyFlipped() const;
128 
133  bool IsVoid() const;
134 
135  void SwapData( SCH_ITEM* aItem ) override;
136 
143  void ImportValues( const LIB_FIELD& aSource );
144 
145  int GetPenWidth() const override;
146 
147  void Print( RENDER_SETTINGS* aSettings, const wxPoint& aOffset ) override;
148 
149  void Move( const wxPoint& aMoveVector ) override
150  {
151  Offset( aMoveVector );
152  }
153 
154  void Rotate( wxPoint aPosition ) override;
155 
163  void MirrorX( int aXaxis_position ) override
164  {
165  }
166 
174  void MirrorY( int aYaxis_position ) override
175  {
176  }
177 
178  bool Matches( wxFindReplaceData& aSearchData, void* aAuxData ) override;
179 
180  bool Replace( wxFindReplaceData& aSearchData, void* aAuxData = NULL ) override;
181 
182  wxString GetSelectMenuText( EDA_UNITS aUnits ) const override;
183 
184  BITMAP_DEF GetMenuImage() const override;
185 
186  bool IsReplaceable() const override;
187 
189 
190  wxPoint GetPosition() const override;
191  void SetPosition( const wxPoint& aPosition ) override;
192 
193  wxPoint GetParentPosition() const;
194 
195  bool HitTest( const wxPoint& aPosition, int aAccuracy = 0 ) const override;
196  bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const override;
197 
198  void Plot( PLOTTER* aPlotter ) override;
199 
200  EDA_ITEM* Clone() const override;
201 
202  bool operator <( const SCH_ITEM& aItem ) const override;
203 
204 #if defined(DEBUG)
205  void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
206 #endif
207 };
208 
209 
210 #endif /* CLASS_SCH_FIELD_H */
void Move(const wxPoint &aMoveVector) override
Move the item by aMoveVector to a new position.
Definition: sch_field.h:149
EDA_UNITS
Definition: common.h:198
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
void Offset(const wxPoint &aOffset)
Definition: eda_text.h:252
void MirrorX(int aXaxis_position) override
Mirror item relative to the X axis about aXaxis_position.
Definition: sch_field.h:163
name of datasheet
static bool ClassOf(const EDA_ITEM *aItem)
Definition: sch_field.h:66
PNG memory record (file in memory).
Definition: bitmap_def.h:29
RENDER_SETTINGS Contains all the knowledge about how graphical objects are drawn on any output surfac...
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
Definition: sch_field.cpp:70
void ImportValues(const LIB_FIELD &aSource)
Function ImportValues copy parameters from a LIB_FIELD source.
Definition: sch_field.cpp:215
wxPoint GetPosition() const override
Definition: sch_field.cpp:579
Field object used in symbol libraries.
Definition: lib_field.h:59
int GetId() const
Definition: sch_field.h:114
Schematic editor (Eeschema) main window.
wxString GetSelectMenuText(EDA_UNITS aUnits) const override
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
Definition: sch_field.cpp:412
wxString m_name
Definition: sch_field.h:56
Field Name Module PCB, i.e. "16DIP300".
Field Reference of part, i.e. "IC21".
wxString GetShownText(int aDepth=0) const override
Return the string actually shown after processing of the base text.
Definition: sch_field.cpp:102
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
bool IsVoid() const
Function IsVoid returns true if the field is either empty or holds "~".
Definition: sch_field.cpp:293
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
Definition: eda_text.h:112
bool operator<(const SCH_ITEM &aItem) const override
Definition: sch_field.cpp:601
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:436
#define NULL
bool IsType(const KICAD_T aScanTypes[]) const override
Function IsType Checks whether the item is one of the listed types.
Definition: sch_field.h:76
SCH_FIELD(const wxPoint &aPos, int aFieldId, SCH_ITEM *aParent, const wxString &aName=wxEmptyString)
Definition: sch_field.cpp:52
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_field.cpp:478
virtual bool IsType(const KICAD_T aScanTypes[]) const
Function IsType Checks whether the item is one of the listed types.
Definition: base_struct.h:262
wxPoint GetLibPosition() const
Definition: sch_field.h:188
BITMAP_DEF GetMenuImage() const override
Function GetMenuImage returns a pointer to an image to be used in menus.
Definition: sch_field.cpp:461
void MirrorY(int aYaxis_position) override
Mirror item relative to the Y axis about aYaxis_position.
Definition: sch_field.h:174
Field Value of part, i.e. "3.3K".
Base plotter engine class.
Definition: plotter.h:114
void Plot(PLOTTER *aPlotter) override
Plot the schematic item to aPlotter.
Definition: sch_field.cpp:509
bool Replace(wxFindReplaceData &aSearchData, void *aAuxData=NULL) override
Function Replace performs a text replace using the find and replace criteria in aSearchData on items ...
Definition: sch_field.cpp:360
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: sch_field.cpp:234
bool Matches(wxFindReplaceData &aSearchData, void *aAuxData) override
Function Matches compares the item against the search criteria in aSearchData.
Definition: sch_field.cpp:299
void Print(RENDER_SETTINGS *aSettings, const wxPoint &aOffset) override
Print a schematic item.
Definition: sch_field.cpp:169
void SwapData(SCH_ITEM *aItem) override
Swap the internal data structures aItem with the schematic item.
Definition: sch_field.cpp:221
wxString GetName(bool aUseDefaultName=true) const
Function GetName returns the field name.
Definition: sch_field.cpp:420
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
void SetName(const wxString &aName)
Definition: sch_field.h:112
Schematic symbol object.
Definition: sch_component.h:88
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:159
wxString GetClass() const override
Function GetClass returns the class name.
Definition: sch_field.h:71
bool IsHorizJustifyFlipped() const
Function IsHorizJustifyFlipped Returns whether the field will be rendered with the horizontal justifi...
Definition: sch_field.cpp:276
const wxPoint & GetTextPos() const
Definition: eda_text.h:247
bool IsReplaceable() const override
Function IsReplaceable.
Definition: sch_field.cpp:335
void Rotate(wxPoint aPosition) override
Rotate the item around aPosition 90 degrees in the clockwise direction.
Definition: sch_field.cpp:404
void SetId(int aId)
Definition: sch_field.cpp:76
wxPoint GetParentPosition() const
Definition: sch_field.cpp:595
int m_id
Field index,.
Definition: sch_field.h:54
void SetPosition(const wxPoint &aPosition) override
Set the schematic item position to aPosition.
Definition: sch_field.cpp:558
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:187
int GetPenWidth() const override
Definition: sch_field.cpp:163
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193