KiCad PCB EDA Suite
lib_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) 2004 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com
5  * Copyright (C) 2004-2017 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 LIB_TEXT_H
26 #define LIB_TEXT_H
27 
28 #include <eda_text.h>
29 #include <lib_item.h>
30 
31 
40 class LIB_TEXT : public LIB_ITEM, public EDA_TEXT
41 {
42  void print( wxDC* aDC, const wxPoint& aOffset, void* aData,
43  const TRANSFORM& aTransform ) override;
44 
45 public:
46  LIB_TEXT( LIB_PART * aParent );
47 
48  // Do not create a copy constructor. The one generated by the compiler is adequate.
49 
50  ~LIB_TEXT() { }
51 
52  wxString GetClass() const override
53  {
54  return wxT( "LIB_TEXT" );
55  }
56 
57  wxString GetTypeName() override
58  {
59  return _( "Text" );
60  }
61 
62  void ViewGetLayers( int aLayers[], int& aCount ) const override;
63 
64  bool HitTest( const wxPoint& aPosition, int aAccuracy = 0 ) const override;
65 
66  bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const override
67  {
68  return TextHitTest( aRect, aContained, aAccuracy );
69  }
70 
71  int GetPenSize( ) const override;
72 
73  void GetMsgPanelInfo( EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM >& aList ) override;
74 
75  const EDA_RECT GetBoundingBox() const override;
76 
77  void BeginEdit( const wxPoint aStartPoint ) override;
78  void CalcEdit( const wxPoint& aPosition ) override;
79 
80  void Offset( const wxPoint& aOffset ) override;
81 
82  bool Inside( EDA_RECT& aRect ) const override;
83 
84  void MoveTo( const wxPoint& aPosition ) override;
85 
86  wxPoint GetPosition() const override { return EDA_TEXT::GetTextPos(); }
87 
88  void MirrorHorizontal( const wxPoint& aCenter ) override;
89  void MirrorVertical( const wxPoint& aCenter ) override;
90  void Rotate( const wxPoint& aCenter, bool aRotateCCW = true ) override;
91 
92  void Plot( PLOTTER* aPlotter, const wxPoint& aOffset, bool aFill,
93  const TRANSFORM& aTransform ) override;
94 
95  int GetWidth() const override { return GetThickness(); }
96  void SetWidth( int aWidth ) override { SetThickness( aWidth ); }
97 
98  wxString GetSelectMenuText( EDA_UNITS_T aUnits ) const override;
99 
100  BITMAP_DEF GetMenuImage() const override;
101 
102  EDA_ITEM* Clone() const override;
103 
104 private:
105 
116  int compare( const LIB_ITEM& aOther ) const override;
117 };
118 
119 
120 #endif // LIB_TEXT_H
void MoveTo(const wxPoint &aPosition) override
Move a draw object to aPosition.
Definition: lib_text.cpp:131
bool HitTest(const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const override
Function HitTest tests if aRect intersects or is contained within the bounding box of an item.
Definition: lib_text.h:66
void Plot(PLOTTER *aPlotter, const wxPoint &aOffset, bool aFill, const TRANSFORM &aTransform) override
Plot the draw item using the plot object.
Definition: lib_text.cpp:173
Define a symbol library graphical text item.
Definition: lib_text.h:40
wxString GetSelectMenuText(EDA_UNITS_T aUnits) const override
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
Definition: lib_text.cpp:296
void GetMsgPanelInfo(EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM > &aList) override
Display basic info (type, part and convert) about the current item in message panel.
Definition: lib_text.cpp:262
void CalcEdit(const wxPoint &aPosition) override
Calculates the attributes of an item at aPosition when it is being edited.
Definition: lib_text.cpp:314
void MirrorHorizontal(const wxPoint &aCenter) override
Mirror the draw object along the horizontal (X) axis about aCenter point.
Definition: lib_text.cpp:137
wxPoint GetPosition() const override
Definition: lib_text.h:86
int GetThickness() const
Function GetThickness returns pen width.
Definition: eda_text.h:148
bool Inside(EDA_RECT &aRect) const override
Test if any part of the draw object is inside rectangle bounds of aRect.
Definition: lib_text.cpp:125
void BeginEdit(const wxPoint aStartPoint) override
Begin drawing a component library draw item at aPosition.
Definition: lib_text.cpp:308
~LIB_TEXT()
Definition: lib_text.h:50
The base class for drawable items used by schematic library components.
Definition: lib_item.h:61
void ViewGetLayers(int aLayers[], int &aCount) const override
Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on.
Definition: lib_text.cpp:53
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: lib_text.cpp:61
Class EDA_TEXT is a mix-in class (via multiple inheritance) that handles texts such as labels,...
Definition: eda_text.h:109
Class for tranforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
void Rotate(const wxPoint &aCenter, bool aRotateCCW=true) override
Rotate the object about aCenter point.
Definition: lib_text.cpp:161
Define a library symbol object.
int GetWidth() const override
Definition: lib_text.h:95
void MirrorVertical(const wxPoint &aCenter) override
Mirror the draw object along the MirrorVertical (Y) axis about aCenter point.
Definition: lib_text.cpp:149
#define _(s)
int GetPenSize() const override
Definition: lib_text.cpp:202
Base plotter engine class.
Definition: plotter.h:97
void Offset(const wxPoint &aOffset) override
Set the drawing object by aOffset from the current position.
Definition: lib_text.cpp:119
BITMAP_DEF GetMenuImage() const override
Function GetMenuImage returns a pointer to an image to be used in menus.
Definition: lib_text.cpp:302
const EDA_RECT GetBoundingBox() const override
Definition: lib_text.cpp:271
wxString GetClass() const override
Function GetClass returns the class name.
Definition: lib_text.h:52
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
virtual bool TextHitTest(const wxPoint &aPoint, int aAccuracy=0) const
Function TextHitTest Test if aPoint is within the bounds of this object.
Definition: eda_text.cpp:330
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 wxPoint & GetTextPos() const
Definition: eda_text.h:230
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
Definition: lib_text.cpp:77
wxString GetTypeName() override
Provide a user-consumable name of the object type.
Definition: lib_text.h:57
void print(wxDC *aDC, const wxPoint &aOffset, void *aData, const TRANSFORM &aTransform) override
Print the item to aDC.
Definition: lib_text.cpp:220
void SetWidth(int aWidth) override
Definition: lib_text.h:96
LIB_TEXT(LIB_PART *aParent)
Definition: lib_text.cpp:45
EDA_UNITS_T
Definition: common.h:154
int compare(const LIB_ITEM &aOther) const override
Provide the draw object specific comparison called by the == and < operators.
Definition: lib_text.cpp:92
void SetThickness(int aNewThickness)
Function SetThickness sets pen width.
Definition: eda_text.h:142