234 lines
6.9 KiB
C++
234 lines
6.9 KiB
C++
/*
|
|
* 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
|
|
*/
|
|
|
|
#ifndef _LIB_TEXT_H_
|
|
#define _LIB_TEXT_H_
|
|
|
|
#include <lib_draw_item.h>
|
|
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
class LIB_TEXT : public LIB_ITEM, public EDA_TEXT
|
|
{
|
|
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.
|
|
|
|
/**
|
|
* Draw the polyline.
|
|
*/
|
|
void drawGraphic( EDA_DRAW_PANEL* aPanel, wxDC* aDC, const wxPoint& aOffset,
|
|
int aColor, int aDrawMode, void* aData, const TRANSFORM& aTransform );
|
|
|
|
/**
|
|
* Calculate the text attributes relative to \a aPosition while editing.
|
|
*
|
|
* @param aPosition - Edit position in drawing units.
|
|
*/
|
|
void calcEdit( const wxPoint& aPosition );
|
|
|
|
public:
|
|
LIB_TEXT( LIB_COMPONENT * aParent );
|
|
|
|
// Do not create a copy constructor. The one generated by the compiler is adequate.
|
|
|
|
~LIB_TEXT() { }
|
|
|
|
virtual wxString GetClass() const
|
|
{
|
|
return wxT( "LIB_TEXT" );
|
|
}
|
|
|
|
/**
|
|
* Sets the text item string to \a aText.
|
|
*
|
|
* This method does more than just set the set the text string. There are special
|
|
* 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.
|
|
*/
|
|
void SetText( const wxString& aText );
|
|
|
|
/**
|
|
* Write text object out to a FILE in "*.lib" format.
|
|
*
|
|
* @param aFormatter A reference to an OUTPUTFORMATTER to write the component library
|
|
* text to.
|
|
* @return True if success writing else false.
|
|
*/
|
|
virtual bool Save( OUTPUTFORMATTER& aFormatter );
|
|
|
|
virtual bool Load( LINE_READER& aLineReader, wxString& aErrorMsg );
|
|
|
|
/** @copydoc EDA_ITEM::HitTest(const wxPoint&) */
|
|
virtual bool HitTest( const wxPoint& aPosition );
|
|
|
|
/**
|
|
* @param aPosition = a wxPoint to test, in Eeschema coordinates
|
|
* @param aThreshold = max distance to a segment
|
|
* @param aTransform = the transform matrix
|
|
* @return true if the point \a aPosition is near a segment
|
|
*/
|
|
virtual bool HitTest( wxPoint aPosition, int aThreshold, const TRANSFORM& aTransform );
|
|
|
|
/**
|
|
* Test if the given rectangle intersects this object.
|
|
*
|
|
* For now, an ending point must be inside this rect.
|
|
*
|
|
* @param aRect - the given EDA_RECT
|
|
* @return - true if a hit, else false
|
|
*/
|
|
virtual bool HitTest( EDA_RECT& aRect )
|
|
{
|
|
return TextHitTest( aRect );
|
|
}
|
|
|
|
/**
|
|
* Function GetPenSize
|
|
* @return the size of the "pen" that be used to draw or plot this item
|
|
*/
|
|
virtual int GetPenSize( ) const;
|
|
|
|
virtual void DisplayInfo( EDA_DRAW_FRAME* aFrame );
|
|
|
|
/**
|
|
* @return the boundary box for this, in schematic coordinates
|
|
*/
|
|
virtual EDA_RECT GetBoundingBox() const;
|
|
|
|
void Rotate();
|
|
|
|
/**
|
|
* See LIB_ITEM::BeginEdit().
|
|
*/
|
|
void BeginEdit( int aEditMode, const wxPoint aStartPoint = wxPoint( 0, 0 ) );
|
|
|
|
/**
|
|
* See LIB_ITEM::ContinueEdit().
|
|
*/
|
|
bool ContinueEdit( const wxPoint aNextPoint );
|
|
|
|
/**
|
|
* See LIB_ITEM::AbortEdit().
|
|
*/
|
|
void EndEdit( const wxPoint& aPosition, bool aAbort = false );
|
|
|
|
/**
|
|
* @copydoc LIB_ITEM::SetOffset(const wxPoint&)
|
|
*/
|
|
virtual void SetOffset( const wxPoint& aOffset );
|
|
|
|
/**
|
|
* @copydoc LIB_ITEM::Inside()
|
|
*/
|
|
virtual bool Inside( EDA_RECT& aRect ) const;
|
|
|
|
/**
|
|
* @copydoc LIB_ITEM::Move()
|
|
*/
|
|
virtual void Move( const wxPoint& aPosition );
|
|
|
|
/**
|
|
* @copydoc LIB_ITEM::GetPosition()
|
|
*/
|
|
virtual wxPoint GetPosition() const { return m_Pos; }
|
|
|
|
/**
|
|
* @copydoc LIB_ITEM::MirrorHorizontal()
|
|
*/
|
|
virtual void MirrorHorizontal( const wxPoint& aCenter );
|
|
|
|
/**
|
|
* @copydoc LIB_ITEM::MirrorVertical()
|
|
*/
|
|
virtual void MirrorVertical( const wxPoint& aCenter );
|
|
|
|
/**
|
|
* @copydoc LIB_ITEM::Rotate(const wxPoint&,bool)
|
|
*/
|
|
virtual void Rotate( const wxPoint& aCenter, bool aRotateCCW = true );
|
|
|
|
/**
|
|
* @copydoc LIB_ITEM::Plot()
|
|
*/
|
|
virtual void Plot( PLOTTER* aPlotter, const wxPoint& aOffset, bool aFill,
|
|
const TRANSFORM& aTransform );
|
|
|
|
/**
|
|
* @copydoc LIB_ITEM::GetWidth()
|
|
*/
|
|
virtual int GetWidth() const { return m_Thickness; }
|
|
|
|
/**
|
|
* @copydoc LIB_ITEM::SetWidth()
|
|
*/
|
|
virtual void SetWidth( int aWidth ) { m_Thickness = aWidth; }
|
|
|
|
/** @copydoc EDA_ITEM::GetSelectMenuText() */
|
|
virtual wxString GetSelectMenuText() const;
|
|
|
|
/** @copydoc EDA_ITEM::GetMenuImage() */
|
|
virtual BITMAP_DEF GetMenuImage() const { return add_text_xpm; }
|
|
|
|
/** @copydoc EDA_ITEM::Clone() */
|
|
virtual EDA_ITEM* Clone() const;
|
|
|
|
private:
|
|
|
|
/**
|
|
* Function compare
|
|
* provides the text draw object specific comparison.
|
|
*
|
|
* The sort order is as follows:
|
|
* - Text string, case insensitive compare.
|
|
* - Text horizontal (X) position.
|
|
* - Text vertical (Y) position.
|
|
* - Text width.
|
|
* - Text height.
|
|
*
|
|
* @param aOther A reference to the other #LIB_ITEM to compare the text against.
|
|
* @return An integer value less than 0 if the text is less than \a aOther, zero
|
|
* if the text is equal to \a aOther, or greater than 0 if the text is
|
|
* greater than \a aOther.
|
|
*/
|
|
virtual int compare( const LIB_ITEM& aOther ) const;
|
|
};
|
|
|
|
|
|
#endif // _LIB_TEXT_H_
|