kicad/pcbnew/class_pcb_text.h

105 lines
2.7 KiB
C
Raw Normal View History

/************************************/
/* fonctions de la classe TEXTE_PCB */
/************************************/
#ifndef CLASS_PCB_TEXT_H
#define CLASS_PCB_TEXT_H
#include "base_struct.h"
2007-08-23 04:28:46 +00:00
class TEXTE_PCB : public BOARD_ITEM, public EDA_TextStruct
{
public:
2008-04-01 05:21:50 +00:00
TEXTE_PCB( BOARD_ITEM* parent );
TEXTE_PCB( TEXTE_PCB* textepcb );
~TEXTE_PCB();
2007-12-01 03:42:52 +00:00
/**
* Function GetPosition
* returns the position of this object.
2008-04-01 05:21:50 +00:00
* @return wxPoint& - The position of this object, non-const so it
2007-12-01 03:42:52 +00:00
* can be changed
*/
wxPoint& GetPosition()
{
return m_Pos; // within EDA_TextStruct
}
2008-04-01 05:21:50 +00:00
/* supprime du chainage la structure Struct */
void UnLink();
/* duplicate structure */
void Copy( TEXTE_PCB* source );
void Draw( WinEDA_DrawPanel * panel, wxDC* DC, int aDrawMode, const wxPoint& offset = ZeroOffset );
// File Operations:
int ReadTextePcbDescr( FILE* File, int* LineNum );
2007-10-30 21:30:58 +00:00
/**
* Function Save
2007-10-31 14:14:21 +00:00
* writes the data structures for this object out to a FILE in "*.brd" format.
2007-10-30 21:30:58 +00:00
* @param aFile The FILE to write to.
* @return bool - true if success writing else false.
2008-04-01 05:21:50 +00:00
*/
2007-10-30 21:30:58 +00:00
bool Save( FILE* aFile ) const;
2008-04-01 05:21:50 +00:00
/**
* Function Display_Infos
* has knowledge about the frame and how and where to put status information
* about this object into the frame's message panel.
* Is virtual from EDA_BaseStruct.
2007-08-30 22:20:52 +00:00
* @param frame A WinEDA_DrawFrame in which to print status information.
2008-04-01 05:21:50 +00:00
*/
void Display_Infos( WinEDA_DrawFrame* frame );
2007-08-22 05:11:01 +00:00
/**
* Function HitTest
* tests if the given wxPoint is within the bounds of this object.
* @param refPos A wxPoint to test
* @return bool - true if a hit, else false
*/
bool HitTest( const wxPoint& refPos )
{
return EDA_TextStruct::HitTest( refPos );
}
2008-04-01 05:21:50 +00:00
/**
* Function HitTest (overlayed)
* tests if the given EDA_Rect intersect this object.
* @param refArea the given EDA_Rect to test
* @return bool - true if a hit, else false
*/
2008-01-06 12:43:57 +00:00
bool HitTest( EDA_Rect& refArea )
{
return EDA_TextStruct::HitTest( refArea );
}
2008-04-01 05:21:50 +00:00
/**
* Function GetClass
* returns the class name.
* @return wxString
*/
virtual wxString GetClass() const
{
return wxT("PTEXT");
}
#if defined(DEBUG)
/**
* Function Show
* is used to output the object tree, currently for debugging only.
2008-04-01 05:21:50 +00:00
* @param nestLevel An aid to prettier tree indenting, and is the level
* of nesting of this object within the overall tree.
* @param os The ostream& to output to.
*/
virtual void Show( int nestLevel, std::ostream& os );
#endif
2008-04-01 05:21:50 +00:00
};
#endif // #define CLASS_PCB_TEXT_H