2011-10-31 20:49:48 +00:00
|
|
|
/*
|
|
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
|
|
*
|
|
|
|
* Copyright (C) 2004 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com
|
|
|
|
* Copyright (C) 2004-2011 KiCad Developers, see change_log.txt for contributors.
|
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU General Public License
|
|
|
|
* as published by the Free Software Foundation; either version 2
|
|
|
|
* of the License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program; if not, you may find one here:
|
|
|
|
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
|
|
|
* or you may search the http://www.gnu.org website for the version 2 license,
|
|
|
|
* or you may write to the Free Software Foundation, Inc.,
|
|
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @file lib_text.h
|
|
|
|
*/
|
2010-11-27 13:09:18 +00:00
|
|
|
|
|
|
|
#ifndef _LIB_TEXT_H_
|
|
|
|
#define _LIB_TEXT_H_
|
|
|
|
|
2012-04-12 21:31:31 +00:00
|
|
|
#include <eda_text.h>
|
2012-01-23 04:33:36 +00:00
|
|
|
#include <lib_draw_item.h>
|
2010-11-27 13:09:18 +00:00
|
|
|
|
2013-01-12 17:32:24 +00:00
|
|
|
|
2011-11-01 15:06:26 +00:00
|
|
|
/**
|
|
|
|
* Class LIB_TEXT
|
|
|
|
* defines a component library graphical text item.
|
|
|
|
* <p>
|
|
|
|
* This is only a graphical text item. Field text like the reference designator,
|
|
|
|
* component value, etc. are not LIB_TEXT items. See the #LIB_FIELD class for the
|
|
|
|
* field item definition.
|
2012-03-26 23:47:08 +00:00
|
|
|
* </p>
|
2011-11-01 15:06:26 +00:00
|
|
|
*/
|
2011-04-27 19:44:32 +00:00
|
|
|
class LIB_TEXT : public LIB_ITEM, public EDA_TEXT
|
2010-11-27 13:09:18 +00:00
|
|
|
{
|
|
|
|
wxString m_savedText; ///< Temporary storage for the string when edition.
|
|
|
|
bool m_rotate; ///< Flag to indicate a rotation occurred while editing.
|
|
|
|
bool m_updateText; ///< Flag to indicate text change occurred while editing.
|
|
|
|
|
2011-01-21 19:30:59 +00:00
|
|
|
void drawGraphic( EDA_DRAW_PANEL* aPanel, wxDC* aDC, const wxPoint& aOffset,
|
2012-09-02 12:06:47 +00:00
|
|
|
EDA_COLOR_T aColor, GR_DRAWMODE aDrawMode, void* aData,
|
2016-09-25 17:06:49 +00:00
|
|
|
const TRANSFORM& aTransform ) override;
|
2010-11-27 13:09:18 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
void calcEdit( const wxPoint& aPosition ) override;
|
2010-11-27 13:09:18 +00:00
|
|
|
|
|
|
|
public:
|
Modular KiCad Blueprint Milestone B), major portions:
*) When kicad.exe closes a project, close any open KIFACEs so that they cannot
get disassociated from their true PROJECT.
*) Allow loading eeschema library editor from kicad.exe
*) Allow loading pcbnew library editor from kicad.exe
*) Rename LIB_COMPONENT to LIB_PART.
*) Add class PART_LIBS, and PART_LIB.
*) Make PART_LIBS non-global, i.e. PROJECT specific.
*) Implement "data on demand" for PART_LIBS
*) Implement "data on demand" for schematic SEARCH_STACK.
*) Use RSTRINGs to retain eeschema editor's notion of last library and part being edited.
*) Get rid of library search on every SCH_COMPONENT::Draw() call, instead use
a weak pointer.
*) Remove all chdir() calls so projects don't need to be CWD.
*) Romove APPEND support from OpenProjectFiles().
*) Make OpenProjectFiles() robust, even for creating new projects.
*) Load EESCHEMA colors in the KIWAY::OnKiwayStart() rather in window open,
and save them in the .eeschema config file, not in the project file.
*) Fix bug with wxDir() while accessing protected dirs in kicad.exe
*) Consolidate template copying into PROJECT class, not in kicad.exe source.
*) Generally untangle eeschema, making its libraries not global but rather
held in the PROJECT.
2014-08-13 20:28:54 +00:00
|
|
|
LIB_TEXT( LIB_PART * aParent );
|
2012-01-09 20:26:55 +00:00
|
|
|
|
|
|
|
// Do not create a copy constructor. The one generated by the compiler is adequate.
|
|
|
|
|
2010-11-27 13:09:18 +00:00
|
|
|
~LIB_TEXT() { }
|
|
|
|
|
2016-09-25 17:06:49 +00:00
|
|
|
wxString GetClass() const override
|
2010-11-27 13:09:18 +00:00
|
|
|
{
|
|
|
|
return wxT( "LIB_TEXT" );
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the text item string to \a aText.
|
|
|
|
*
|
2011-10-31 20:49:48 +00:00
|
|
|
* This method does more than just set the set the text string. There are special
|
2010-11-27 13:09:18 +00:00
|
|
|
* cases when changing the text string alone is not enough. If the text item is
|
|
|
|
* being moved, the name change must be delayed until the next redraw to prevent
|
|
|
|
* drawing artifacts.
|
|
|
|
*
|
|
|
|
* @param aText - New text value.
|
|
|
|
*/
|
2016-09-24 18:53:15 +00:00
|
|
|
void SetText( const wxString& aText ) override;
|
2010-11-27 13:09:18 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
bool Save( OUTPUTFORMATTER& aFormatter ) override;
|
2011-10-31 20:49:48 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
bool Load( LINE_READER& aLineReader, wxString& aErrorMsg ) override;
|
2010-11-27 13:09:18 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
bool HitTest( const wxPoint& aPosition ) const override;
|
2010-11-27 13:09:18 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
bool HitTest( const wxPoint &aPosition, int aThreshold, const TRANSFORM& aTransform ) const override;
|
2010-11-27 13:09:18 +00:00
|
|
|
|
2014-05-04 17:08:36 +00:00
|
|
|
bool HitTest( const EDA_RECT& aRect ) const
|
2010-11-27 13:09:18 +00:00
|
|
|
{
|
|
|
|
return TextHitTest( aRect );
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
int GetPenSize( ) const override;
|
2010-11-27 13:09:18 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
void GetMsgPanelInfo( std::vector< MSG_PANEL_ITEM >& aList ) override;
|
2012-03-26 23:47:08 +00:00
|
|
|
|
2016-09-25 17:06:49 +00:00
|
|
|
const EDA_RECT GetBoundingBox() const override;
|
2010-11-27 13:09:18 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
void Rotate() override;
|
2010-11-27 13:09:18 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
void BeginEdit( STATUS_FLAGS aEditMode, const wxPoint aStartPoint = wxPoint( 0, 0 ) ) override;
|
2010-11-27 13:09:18 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
bool ContinueEdit( const wxPoint aNextPoint ) override;
|
2010-11-27 13:09:18 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
void EndEdit( const wxPoint& aPosition, bool aAbort = false ) override;
|
2010-11-27 13:09:18 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
void SetOffset( const wxPoint& aOffset ) override;
|
2012-02-27 23:02:08 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
bool Inside( EDA_RECT& aRect ) const override;
|
2012-02-27 23:02:08 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
void Move( const wxPoint& aPosition ) override;
|
2012-02-27 23:02:08 +00:00
|
|
|
|
2017-01-23 20:30:11 +00:00
|
|
|
wxPoint GetPosition() const override { return EDA_TEXT::GetTextPos(); }
|
2012-02-27 23:02:08 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
void MirrorHorizontal( const wxPoint& aCenter ) override;
|
2012-02-27 23:02:08 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
void MirrorVertical( const wxPoint& aCenter ) override;
|
2012-02-27 23:02:08 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
void Rotate( const wxPoint& aCenter, bool aRotateCCW = true ) override;
|
2012-02-27 23:02:08 +00:00
|
|
|
|
2012-03-26 23:47:08 +00:00
|
|
|
void Plot( PLOTTER* aPlotter, const wxPoint& aOffset, bool aFill,
|
2016-09-25 17:06:49 +00:00
|
|
|
const TRANSFORM& aTransform ) override;
|
2012-02-27 23:02:08 +00:00
|
|
|
|
2017-01-23 20:30:11 +00:00
|
|
|
int GetWidth() const override { return GetThickness(); }
|
2012-02-27 23:02:08 +00:00
|
|
|
|
2017-01-23 20:30:11 +00:00
|
|
|
void SetWidth( int aWidth ) override { SetThickness( aWidth ); }
|
2012-02-27 23:02:08 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
wxString GetSelectMenuText() const override;
|
2011-04-27 19:44:32 +00:00
|
|
|
|
2017-02-20 12:20:39 +00:00
|
|
|
BITMAP_DEF GetMenuImage() const override;
|
2011-04-27 19:44:32 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
EDA_ITEM* Clone() const override;
|
2012-03-17 14:39:27 +00:00
|
|
|
|
2012-02-27 23:02:08 +00:00
|
|
|
private:
|
2010-11-27 13:09:18 +00:00
|
|
|
|
|
|
|
/**
|
2012-03-26 23:47:08 +00:00
|
|
|
* @copydoc LIB_ITEM::compare()
|
2010-11-27 13:09:18 +00:00
|
|
|
*
|
2012-03-26 23:47:08 +00:00
|
|
|
* The text specific sort order is as follows:
|
2010-11-27 13:09:18 +00:00
|
|
|
* - Text string, case insensitive compare.
|
|
|
|
* - Text horizontal (X) position.
|
|
|
|
* - Text vertical (Y) position.
|
|
|
|
* - Text width.
|
|
|
|
* - Text height.
|
|
|
|
*/
|
2016-09-24 18:53:15 +00:00
|
|
|
int compare( const LIB_ITEM& aOther ) const override;
|
2010-11-27 13:09:18 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
#endif // _LIB_TEXT_H_
|