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 
59 
60 public:
61  SCH_FIELD( const wxPoint& aPos, int aFieldId, SCH_COMPONENT* aParent,
62  const wxString& aName = wxEmptyString );
63 
64  // Do not create a copy constructor. The one generated by the compiler is adequate.
65 
66  ~SCH_FIELD();
67 
68  wxString GetClass() const override
69  {
70  return wxT( "SCH_FIELD" );
71  }
72 
73  bool IsType( const KICAD_T aScanTypes[] ) override
74  {
75  if( SCH_ITEM::IsType( aScanTypes ) )
76  return true;
77 
78  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
79  {
81  return true;
82  else if ( *p == SCH_FIELD_LOCATE_VALUE_T && m_id == VALUE )
83  return true;
84  else if ( *p == SCH_FIELD_LOCATE_FOOTPRINT_T && m_id == FOOTPRINT )
85  return true;
86  else if ( *p == SCH_FIELD_LOCATE_DATASHEET_T && m_id == DATASHEET )
87  return true;
88  }
89 
90  return false;
91  }
92 
101  wxString GetName( bool aUseDefaultName = true ) const;
102 
103  void SetName( const wxString& aName ) { m_name = aName; }
104 
105  int GetId() const { return m_id; }
106 
107  void SetId( int aId ) { m_id = aId; }
108 
109  const wxString GetText() const override;
110  wxString GetShownText() const override;
111  void SetText( const wxString& aText ) override;
112 
121  const wxString GetFullyQualifiedText() const;
122 
123  void Place( SCH_EDIT_FRAME* frame, wxDC* DC );
124 
125  const EDA_RECT GetBoundingBox() const override;
126 
132  bool IsHorizJustifyFlipped() const;
133 
138  bool IsVoid() const;
139 
140  void SwapData( SCH_ITEM* aItem ) override;
141 
148  void ImportValues( const LIB_FIELD& aSource );
149 
150  int GetPenSize() const override;
151 
152  void Draw( EDA_DRAW_PANEL* aPanel, wxDC* aDC, const wxPoint& aOffset ) override;
153 
154  // Geometric transforms (used in block operations):
155 
156  void Move( const wxPoint& aMoveVector ) override
157  {
158  Offset( aMoveVector );
159  }
160 
161  void Rotate( wxPoint aPosition ) override;
162 
170  void MirrorX( int aXaxis_position ) override
171  {
172  }
173 
181  void MirrorY( int aYaxis_position ) override
182  {
183  }
184 
185  bool Matches( wxFindReplaceData& aSearchData, void* aAuxData, wxPoint* aFindLocation ) override;
186 
187  bool Replace( wxFindReplaceData& aSearchData, void* aAuxData = NULL ) override;
188 
189  wxString GetSelectMenuText( EDA_UNITS_T aUnits ) const override;
190 
191  BITMAP_DEF GetMenuImage() const override;
192 
193  bool IsReplaceable() const override;
194 
195  wxPoint GetLibPosition() const { return EDA_TEXT::GetTextPos(); }
196 
197  wxPoint GetPosition() const override;
198  void SetPosition( const wxPoint& aPosition ) override;
199 
200  bool HitTest( const wxPoint& aPosition, int aAccuracy = 0 ) const override;
201  bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const override;
202 
203  void Plot( PLOTTER* aPlotter ) override;
204 
205  EDA_ITEM* Clone() const override;
206 
207 #if defined(DEBUG)
208  void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
209 #endif
210 };
211 
212 
213 #endif /* CLASS_SCH_FIELD_H */
void Move(const wxPoint &aMoveVector) override
Function Move moves the item by aMoveVector to a new position.
Definition: sch_field.h:156
Class 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:246
UNIQUE_MUTEX m_mutex
Definition: sch_field.h:58
bool IsType(const KICAD_T aScanTypes[]) override
Function IsType Checks whether the item is one of the listed types.
Definition: sch_field.h:73
int GetPenSize() const override
Function GetPenSize virtual pure.
Definition: sch_field.cpp:135
void MirrorX(int aXaxis_position) override
Function MirrorX mirrors item relative to the X axis about aXaxis_position.
Definition: sch_field.h:170
SCH_FIELD(const wxPoint &aPos, int aFieldId, SCH_COMPONENT *aParent, const wxString &aName=wxEmptyString)
Definition: sch_field.cpp:56
name of datasheet
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
Definition: sch_field.cpp:74
const wxString GetText() const override
Function GetText returns the string associated with the text object.
Definition: sch_field.cpp:105
void ImportValues(const LIB_FIELD &aSource)
Function ImportValues copy parameters from a LIB_FIELD source.
Definition: sch_field.cpp:216
wxPoint GetPosition() const override
Function GetPosition.
Definition: sch_field.cpp:550
void SetText(const wxString &aText) override
Definition: sch_field.cpp:125
Field object used in symbol libraries.
Definition: lib_field.h:59
void Place(SCH_EDIT_FRAME *frame, wxDC *DC)
Definition: sch_field.cpp:309
int GetId() const
Definition: sch_field.h:105
virtual bool IsType(const KICAD_T aScanTypes[])
Function IsType Checks whether the item is one of the listed types.
Definition: base_struct.h:287
Schematic editor (Eeschema) main window.
void Draw(EDA_DRAW_PANEL *aPanel, wxDC *aDC, const wxPoint &aOffset) override
Function Draw Draw a schematic item.
Definition: sch_field.cpp:153
wxString m_name
Definition: sch_field.h:56
Definition of base KiCad text object.
wxString GetShownText() const override
Returns the string actually shown after processing of the base text.
Definition: sch_field.cpp:115
Field Name Module PCB, i.e. "16DIP300".
Field Reference of part, i.e. "IC21".
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:299
Class EDA_TEXT is a mix-in class (via multiple inheritance) that handles texts such as labels,...
Definition: eda_text.h:128
#define VALUE
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_field.cpp:421
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:453
wxPoint GetLibPosition() const
Definition: sch_field.h:195
BITMAP_DEF GetMenuImage() const override
Function GetMenuImage returns a pointer to an image to be used in menus.
Definition: sch_field.cpp:438
void MirrorY(int aYaxis_position) override
Function MirrorY mirrors item relative to the Y axis about aYaxis_position.
Definition: sch_field.h:181
Base plotter engine class.
Definition: plotter.h:97
void Plot(PLOTTER *aPlotter) override
Function Plot plots the schematic item to aPlotter.
Definition: sch_field.cpp:484
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:376
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: sch_field.cpp:236
void SwapData(SCH_ITEM *aItem) override
Function SwapData swap the internal data structures aItem with the schematic item.
Definition: sch_field.cpp:222
wxString GetName(bool aUseDefaultName=true) const
Function GetName returns the field name.
Definition: sch_field.cpp:427
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
void SetName(const wxString &aName)
Definition: sch_field.h:103
const wxString GetFullyQualifiedText() const
Function GetFullyQualifiedText returns the fully qualified field text by allowing for the part suffix...
Definition: sch_field.cpp:80
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:73
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:157
wxString GetClass() const override
Function GetClass returns the class name.
Definition: sch_field.h:68
bool IsHorizJustifyFlipped() const
Function IsHorizJustifyFlipped Returns whether the field will be rendered with the horizontal justifi...
Definition: sch_field.cpp:282
bool Matches(wxFindReplaceData &aSearchData, void *aAuxData, wxPoint *aFindLocation) override
Function Matches compares the item against the search criteria in aSearchData.
Definition: sch_field.cpp:323
const wxPoint & GetTextPos() const
Definition: eda_text.h:241
bool IsReplaceable() const override
Function IsReplaceable.
Definition: sch_field.cpp:363
void Rotate(wxPoint aPosition) override
Function Rotate rotates the item around aPosition 90 degrees in the clockwise direction.
Definition: sch_field.cpp:413
void SetId(int aId)
Definition: sch_field.h:107
int m_id
Field index,.
Definition: sch_field.h:54
void SetPosition(const wxPoint &aPosition) override
Function SetPosition set the schematic item position to aPosition.
Definition: sch_field.cpp:535
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114
EDA_UNITS_T
Definition: common.h:157