diff options
Diffstat (limited to 'eeschema/lib_field.h')
| -rw-r--r-- | eeschema/lib_field.h | 277 |
1 files changed, 277 insertions, 0 deletions
diff --git a/eeschema/lib_field.h b/eeschema/lib_field.h new file mode 100644 index 0000000..1f8f8e7 --- /dev/null +++ b/eeschema/lib_field.h @@ -0,0 +1,277 @@ +/* + * 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_field.h + */ + +#ifndef CLASS_LIBENTRY_FIELDS_H +#define CLASS_LIBENTRY_FIELDS_H + +#include <eda_text.h> +#include <lib_draw_item.h> + + +/** + * Class LIB_FIELD + * is used in symbol libraries. At least MANDATORY_FIELDS are always present + * in a ram resident library symbol. All constructors must ensure this because + * the component property editor assumes it. + * <p> + * A field is a string linked to a component. Unlike purely graphical text, fields can + * be used in netlist generation and other tools (BOM). + * + * The first 4 fields have a special meaning: + * + * 0 = REFERENCE + * 1 = VALUE + * 2 = FOOTPRINT (default Footprint) + * 3 = DATASHEET (user doc link) + * + * others = free fields + * </p> + * + * @see enum NumFieldType + */ +class LIB_FIELD : public LIB_ITEM, public EDA_TEXT +{ + int m_id; ///< @see enum NumFieldType + wxString m_name; ///< Name (not the field text value itself, that is .m_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 field. + * <p> + * If \a aData not NULL, \a aData must point a wxString which is used instead of + * the m_Text + * </p> + */ + void drawGraphic( EDA_DRAW_PANEL* aPanel, wxDC* aDC, const wxPoint& aOffset, + EDA_COLOR_T aColor, GR_DRAWMODE aDrawMode, void* aData, + const TRANSFORM& aTransform ); + + /** + * Calculate the new circle at \a aPosition when editing. + * + * @param aPosition - The position to edit the circle in drawing coordinates. + */ + void calcEdit( const wxPoint& aPosition ); + +public: + + LIB_FIELD( int idfield = 2 ); + + LIB_FIELD( LIB_PART * aParent, int idfield = 2 ); + + // Do not create a copy constructor. The one generated by the compiler is adequate. + + ~LIB_FIELD(); + + wxString GetClass() const + { + return wxT( "LIB_FIELD" ); + } + + /** + * Object constructor initialization helper. + */ + void Init( int idfield ); + + /** + * Returns the field name. + * + * The first four field IDs are reserved and therefore always return their respective + * names. The user definable fields will return FieldN where N is the ID of the field + * when the m_name member is empty. + * + * @param aTranslate True to return translated field name (default). False to return + * the english name (useful when the name is used as keyword in + * netlists ...) + * @return Name of the field. + */ + wxString GetName( bool aTranslate = true ) const; + + /** + * Function SetName + * + * Sets a user definable field name to \a aName. + * + * Reserved fields such as value and reference are not renamed. If the field name is + * changed, the field modified flag is set. If the field is the child of a component, + * the parent component's modified flag is also set. + * + * @param aName - User defined field name. + */ + void SetName( const wxString& aName ); + + int GetId() const { return m_id; } + + void SetId( int aId ) { m_id = aId; } + + int GetPenSize( ) const; + + bool Save( OUTPUTFORMATTER& aFormatter ); + + bool Load( LINE_READER& aLineReader, wxString& errorMsg ); + + /** + * Copy parameters of this field to another field. Pointers are not copied. + * + * @param aTarget Target field to copy values to. + */ + void Copy( LIB_FIELD* aTarget ) const; + + void SetFields( const std::vector <LIB_FIELD> aFields ); + + /** + * Function IsVoid + * @return true if the field value is void (no text in this field) + */ + bool IsVoid() const + { + return m_Text.IsEmpty(); + } + + /** + * Function IsVisible + * @return true is this field is visible, false if flagged invisible + */ + bool IsVisible() + { + return (m_Attributs & TEXT_NO_VISIBLE) == 0 ? true : false; + } + + const EDA_RECT GetBoundingBox() const; // Virtual + + void GetMsgPanelInfo( std::vector< MSG_PANEL_ITEM >& aList ); + + bool HitTest( const wxPoint& aPosition ) const; + + bool HitTest( const wxPoint &aPosition, int aThreshold, const TRANSFORM& aTransform ) const; + + void operator=( const LIB_FIELD& field ) + { + m_id = field.m_id; + m_Text = field.m_Text; + m_name = field.m_name; + m_Pos = field.m_Pos; + m_Size = field.m_Size; + m_Thickness = field.m_Thickness; + m_Orient = field.m_Orient; + m_Mirror = field.m_Mirror; + m_Attributs = field.m_Attributs; + m_Italic = field.m_Italic; + m_Bold = field.m_Bold; + m_HJustify = field.m_HJustify; + m_VJustify = field.m_VJustify; + m_Parent = field.m_Parent; + } + + /** + * Return the text of a field. + * + * If the field is the reference field, the unit number is used to + * create a pseudo reference text. If the base reference field is U, + * the string U?A will be returned for unit = 1. + * + * @todo This should be handled by the field object. + * + * @param unit - The package unit number. Only effects reference field. + * @return Field text. + */ + wxString GetFullText( int unit = 1 ); + + EDA_COLOR_T GetDefaultColor(); + + void BeginEdit( STATUS_FLAGS aEditMode, const wxPoint aStartPoint = wxPoint( 0, 0 ) ); + + bool ContinueEdit( const wxPoint aNextPoint ); + + void EndEdit( const wxPoint& aPosition, bool aAbort = false ); + + void Rotate(); + + /** + * Sets the field text to \a aText. + * + * This method does more than just set the set the field text. There are special + * cases when changing the text string alone is not enough. If the field is the + * value field, the parent component's name is changed as well. If the field 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 ); + + void SetOffset( const wxPoint& aOffset ); + + bool Inside( EDA_RECT& aRect ) const; + + void Move( const wxPoint& aPosition ); + + wxPoint GetPosition() const { return m_Pos; } + + void MirrorHorizontal( const wxPoint& aCenter ); + + void MirrorVertical( const wxPoint& aCenter ); + + void Rotate( const wxPoint& aCenter, bool aRotateCCW = true ); + + void Plot( PLOTTER* aPlotter, const wxPoint& aOffset, bool aFill, + const TRANSFORM& aTransform ); + + int GetWidth() const { return m_Thickness; } + + void SetWidth( int aWidth ) { m_Thickness = aWidth; } + + wxString GetSelectMenuText() const; + + BITMAP_DEF GetMenuImage() const { return move_field_xpm; } + + EDA_ITEM* Clone() const; + +private: + + /** + * @copydoc LIB_ITEM::compare() + * + * The field specific sort order is as follows: + * + * - Field ID, REFERENCE, VALUE, etc. + * - Field string, case insensitive compare. + * - Field horizontal (X) position. + * - Field vertical (Y) position. + * - Field width. + * - Field height. + */ + int compare( const LIB_ITEM& aOther ) const; +}; + +typedef std::vector< LIB_FIELD > LIB_FIELDS; + +#endif // CLASS_LIBENTRY_FIELDS_H |