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-2011 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 
45 class LIB_TEXT : public LIB_ITEM, public EDA_TEXT
46 {
47  wxString m_savedText;
48  bool m_rotate;
49  bool m_updateText;
50 
51  void drawGraphic( EDA_DRAW_PANEL* aPanel, wxDC* aDC, const wxPoint& aOffset,
52  COLOR4D aColor, GR_DRAWMODE aDrawMode, void* aData,
53  const TRANSFORM& aTransform ) override;
54 
55  void calcEdit( const wxPoint& aPosition ) override;
56 
57 public:
58  LIB_TEXT( LIB_PART * aParent );
59 
60  // Do not create a copy constructor. The one generated by the compiler is adequate.
61 
62  ~LIB_TEXT() { }
63 
64  wxString GetClass() const override
65  {
66  return wxT( "LIB_TEXT" );
67  }
68 
79  void SetText( const wxString& aText ) override;
80 
81  bool Save( OUTPUTFORMATTER& aFormatter ) override;
82 
83  bool Load( LINE_READER& aLineReader, wxString& aErrorMsg ) override;
84 
85  bool HitTest( const wxPoint& aPosition ) const override;
86 
87  bool HitTest( const wxPoint &aPosition, int aThreshold, const TRANSFORM& aTransform ) const override;
88 
89  bool HitTest( const EDA_RECT& aRect ) const
90  {
91  return TextHitTest( aRect );
92  }
93 
94 
95  int GetPenSize( ) const override;
96 
97  void GetMsgPanelInfo( std::vector< MSG_PANEL_ITEM >& aList ) override;
98 
99  const EDA_RECT GetBoundingBox() const override;
100 
101  void Rotate() override;
102 
103  void BeginEdit( STATUS_FLAGS aEditMode, const wxPoint aStartPoint = wxPoint( 0, 0 ) ) override;
104 
105  bool ContinueEdit( const wxPoint aNextPoint ) override;
106 
107  void EndEdit( const wxPoint& aPosition, bool aAbort = false ) override;
108 
109  void SetOffset( const wxPoint& aOffset ) override;
110 
111  bool Inside( EDA_RECT& aRect ) const override;
112 
113  void Move( const wxPoint& aPosition ) override;
114 
115  wxPoint GetPosition() const override { return EDA_TEXT::GetTextPos(); }
116 
117  void MirrorHorizontal( const wxPoint& aCenter ) override;
118 
119  void MirrorVertical( const wxPoint& aCenter ) override;
120 
121  void Rotate( const wxPoint& aCenter, bool aRotateCCW = true ) override;
122 
123  void Plot( PLOTTER* aPlotter, const wxPoint& aOffset, bool aFill,
124  const TRANSFORM& aTransform ) override;
125 
126  int GetWidth() const override { return GetThickness(); }
127 
128  void SetWidth( int aWidth ) override { SetThickness( aWidth ); }
129 
130  wxString GetSelectMenuText() const override;
131 
132  BITMAP_DEF GetMenuImage() const override;
133 
134  EDA_ITEM* Clone() const override;
135 
136 private:
137 
148  int compare( const LIB_ITEM& aOther ) const override;
149 };
150 
151 
152 #endif // _LIB_TEXT_H_
void BeginEdit(STATUS_FLAGS aEditMode, const wxPoint aStartPoint=wxPoint(0, 0)) override
Begin an editing a component library draw item in aEditMode at aPosition.
Definition: lib_text.cpp:519
Class LINE_READER is an abstract class from which implementation specific LINE_READERs may be derived...
Definition: richio.h:81
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:321
PNG memory record (file in memory).
Definition: bitmap_types.h:38
const wxPoint & GetTextPos() const
Definition: eda_text.h:224
void Move(const wxPoint &aPosition) override
Function Move moves a draw object to aPosition.
Definition: lib_text.cpp:279
Class LIB_TEXT defines a component library graphical text item.
Definition: lib_text.h:45
bool HitTest(const wxPoint &aPosition) const override
Function HitTest tests if aPosition is contained within or on the bounding area of an item...
Definition: lib_text.cpp:196
void EndEdit(const wxPoint &aPosition, bool aAbort=false) override
End an object editing action.
Definition: lib_text.cpp:548
bool ContinueEdit(const wxPoint aNextPoint) override
Continue an edit in progress at aPosition.
Definition: lib_text.cpp:539
void MirrorHorizontal(const wxPoint &aCenter) override
Function MirrorHorizontal mirrors the draw object along the horizontal (X) axis about aCenter point...
Definition: lib_text.cpp:285
wxPoint GetPosition() const override
Function GetPosition returns the current draw object position.
Definition: lib_text.h:115
Class OUTPUTFORMATTER is an important interface (abstract class) used to output 8 bit text in a conve...
Definition: richio.h:327
Definition of base KiCad text object.
void Rotate() override
Rotate the draw item.
Definition: lib_text.cpp:475
bool Inside(EDA_RECT &aRect) const override
Function Inside tests if any part of the draw object is inside rectangle bounds of aRect...
Definition: lib_text.cpp:269
~LIB_TEXT()
Definition: lib_text.h:62
Class LIB_ITEM is the base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:67
int GetThickness() const
Function GetThickness returns pen width.
Definition: eda_text.h:154
Class EDA_TEXT is a mix-in class (via multiple inheritance) that handles texts such as labels...
Definition: eda_text.h:114
bool Load(LINE_READER &aLineReader, wxString &aErrorMsg) override
Definition: lib_text.cpp:101
void GetMsgPanelInfo(std::vector< MSG_PANEL_ITEM > &aList) override
Function GetMsgPanelInfo displays basic info (type, part and convert) about the current item in messa...
Definition: lib_text.cpp:438
Class for tranforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
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:267
GR_DRAWMODE
Drawmode. Compositing mode plus a flag or two.
Definition: gr_basic.h:41
void SetOffset(const wxPoint &aOffset) override
Function Offset sets the drawing object by aOffset from the current position.
Definition: lib_text.cpp:263
bool Save(OUTPUTFORMATTER &aFormatter) override
Function Save writes draw item object to aFormatter in component library "*.lib" format.
Definition: lib_text.cpp:58
Class LIB_PART defines a library part object.
int GetWidth() const override
Function GetWidth return the width of the draw item.
Definition: lib_text.h:126
unsigned STATUS_FLAGS
Definition: base_struct.h:144
bool m_rotate
Flag to indicate a rotation occurred while editing.
Definition: lib_text.h:48
void MirrorVertical(const wxPoint &aCenter) override
Function MirrorVertical mirrors the draw object along the MirrorVertical (Y) axis about aCenter point...
Definition: lib_text.cpp:297
int GetPenSize() const override
Function GetPenSize.
Definition: lib_text.cpp:351
wxString m_savedText
Temporary storage for the string when edition.
Definition: lib_text.h:47
void calcEdit(const wxPoint &aPosition) override
Calculates the attributes of an item at aPosition when it is being edited.
Definition: lib_text.cpp:560
Base plotter engine class.
Definition: plot_common.h:86
BITMAP_DEF GetMenuImage() const override
Function GetMenuImage returns a pointer to an image to be used in menus.
Definition: lib_text.cpp:513
void drawGraphic(EDA_DRAW_PANEL *aPanel, wxDC *aDC, const wxPoint &aOffset, COLOR4D aColor, GR_DRAWMODE aDrawMode, void *aData, const TRANSFORM &aTransform) override
Function drawGraphic.
Definition: lib_text.cpp:369
const EDA_RECT GetBoundingBox() const override
Definition: lib_text.cpp:450
void SetText(const wxString &aText) override
Sets the text item string to aText.
Definition: lib_text.cpp:488
wxString GetClass() const override
Function GetClass returns the class name.
Definition: lib_text.h:64
Class EDA_RECT handles the component boundary box.
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:151
bool HitTest(const EDA_RECT &aRect) const
Definition: lib_text.h:89
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
Definition: lib_text.cpp:221
void SetWidth(int aWidth) override
Function SetWidth sets the width of the draw item to aWidth.
Definition: lib_text.h:128
bool m_updateText
Flag to indicate text change occurred while editing.
Definition: lib_text.h:49
LIB_TEXT(LIB_PART *aParent)
Definition: lib_text.cpp:47
int compare(const LIB_ITEM &aOther) const override
Function compare provides the draw object specific comparison called by the == and < operators...
Definition: lib_text.cpp:236
void SetThickness(int aNewThickness)
Function SetThickness sets pen width.
Definition: eda_text.h:148
wxString GetSelectMenuText() const override
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
Definition: lib_text.cpp:505
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39