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 
29 #ifndef _LIB_TEXT_H_
30 #define _LIB_TEXT_H_
31 
32 #include <eda_text.h>
33 #include <lib_draw_item.h>
34 
35 
44 class LIB_TEXT : public LIB_ITEM, public EDA_TEXT
45 {
46  wxString m_savedText;
47  bool m_rotate;
48  bool m_updateText;
49 
50  void drawGraphic( EDA_DRAW_PANEL* aPanel, wxDC* aDC, const wxPoint& aOffset, void* aData,
51  const TRANSFORM& aTransform ) override;
52 
53 public:
54  LIB_TEXT( LIB_PART * aParent );
55 
56  // Do not create a copy constructor. The one generated by the compiler is adequate.
57 
58  ~LIB_TEXT() { }
59 
60  wxString GetClass() const override
61  {
62  return wxT( "LIB_TEXT" );
63  }
64 
65  wxString GetTypeName() override
66  {
67  return _( "Text" );
68  }
69 
70  void ViewGetLayers( int aLayers[], int& aCount ) const override;
71 
82  void SetText( const wxString& aText ) override;
83 
84  bool HitTest( const wxPoint& aPosition, int aAccuracy = 0 ) const override;
85 
86  bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const override
87  {
88  return TextHitTest( aRect, aContained, aAccuracy );
89  }
90 
91 
92  int GetPenSize( ) const override;
93 
94  void GetMsgPanelInfo( EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM >& aList ) override;
95 
96  const EDA_RECT GetBoundingBox() const override;
97 
98  void Rotate() override;
99 
100  void BeginEdit( STATUS_FLAGS aEditMode, const wxPoint aStartPoint ) override;
101  void CalcEdit( const wxPoint& aPosition ) override;
102  void EndEdit( const wxPoint& aPosition ) override;
103 
104  void Offset( const wxPoint& aOffset ) override;
105 
106  bool Inside( EDA_RECT& aRect ) const override;
107 
108  void MoveTo( const wxPoint& aPosition ) override;
109 
110  wxPoint GetPosition() const override { return EDA_TEXT::GetTextPos(); }
111 
112  void MirrorHorizontal( const wxPoint& aCenter ) override;
113 
114  void MirrorVertical( const wxPoint& aCenter ) override;
115 
116  void Rotate( const wxPoint& aCenter, bool aRotateCCW = true ) override;
117 
118  void Plot( PLOTTER* aPlotter, const wxPoint& aOffset, bool aFill,
119  const TRANSFORM& aTransform ) override;
120 
121  int GetWidth() const override { return GetThickness(); }
122 
123  void SetWidth( int aWidth ) override { SetThickness( aWidth ); }
124 
125  wxString GetSelectMenuText( EDA_UNITS_T aUnits ) const override;
126 
127  BITMAP_DEF GetMenuImage() const override;
128 
129  EDA_ITEM* Clone() const override;
130 
131 private:
132 
143  int compare( const LIB_ITEM& aOther ) const override;
144 };
145 
146 
147 #endif // _LIB_TEXT_H_
void MoveTo(const wxPoint &aPosition) override
Move a draw object to aPosition.
Definition: lib_text.cpp:132
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:86
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:174
void EndEdit(const wxPoint &aPosition) override
End an object editing action.
Definition: lib_text.cpp:358
Define a symbol library graphical text item.
Definition: lib_text.h:44
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:330
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:267
void CalcEdit(const wxPoint &aPosition) override
Calculates the attributes of an item at aPosition when it is being edited.
Definition: lib_text.cpp:367
void MirrorHorizontal(const wxPoint &aCenter) override
Mirror the draw object along the horizontal (X) axis about aCenter point.
Definition: lib_text.cpp:138
wxPoint GetPosition() const override
Return the current draw object position.
Definition: lib_text.h:110
int GetThickness() const
Function GetThickness returns pen width.
Definition: eda_text.h:171
Definition of base KiCad text object.
void Rotate() override
Rotate the draw item.
Definition: lib_text.cpp:304
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:126
~LIB_TEXT()
Definition: lib_text.h:58
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:67
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:55
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:62
Class EDA_TEXT is a mix-in class (via multiple inheritance) that handles texts such as labels,...
Definition: eda_text.h:128
Class for tranforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
void drawGraphic(EDA_DRAW_PANEL *aPanel, wxDC *aDC, const wxPoint &aOffset, void *aData, const TRANSFORM &aTransform) override
Draw the item on aPanel.
Definition: lib_text.cpp:222
Define a library symbol object.
int GetWidth() const override
Return the width of the draw item.
Definition: lib_text.h:121
unsigned STATUS_FLAGS
Definition: base_struct.h:150
bool m_rotate
Flag to indicate a rotation occurred while editing.
Definition: lib_text.h:47
void MirrorVertical(const wxPoint &aCenter) override
Mirror the draw object along the MirrorVertical (Y) axis about aCenter point.
Definition: lib_text.cpp:150
int GetPenSize() const override
Definition: lib_text.cpp:204
wxString m_savedText
Temporary storage for the string when editing.
Definition: lib_text.h:46
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:120
BITMAP_DEF GetMenuImage() const override
Function GetMenuImage returns a pointer to an image to be used in menus.
Definition: lib_text.cpp:336
const EDA_RECT GetBoundingBox() const override
Definition: lib_text.cpp:279
void SetText(const wxString &aText) override
Sets the text item string to aText.
Definition: lib_text.cpp:313
wxString GetClass() const override
Function GetClass returns the class name.
Definition: lib_text.h:60
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:271
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:157
const wxPoint & GetTextPos() const
Definition: eda_text.h:241
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
Definition: lib_text.cpp:78
wxString GetTypeName() override
Provide a user-consumable name of the object type.
Definition: lib_text.h:65
void BeginEdit(STATUS_FLAGS aEditMode, const wxPoint aStartPoint) override
Begin an editing a component library draw item in aEditMode at aPosition.
Definition: lib_text.cpp:342
void SetWidth(int aWidth) override
Set the width of the draw item to aWidth.
Definition: lib_text.h:123
bool m_updateText
Flag to indicate text change occurred while editing.
Definition: lib_text.h:48
LIB_TEXT(LIB_PART *aParent)
Definition: lib_text.cpp:45
EDA_UNITS_T
Definition: common.h:157
int compare(const LIB_ITEM &aOther) const override
Provide the draw object specific comparison called by the == and < operators.
Definition: lib_text.cpp:93
void SetThickness(int aNewThickness)
Function SetThickness sets pen width.
Definition: eda_text.h:165