#include <ds_data_item.h>

Inheritance diagram for DS_DATA_ITEM_TEXT:

Public Types
enum	DS_ITEM_TYPE { DS_TEXT, DS_SEGMENT, DS_RECT, DS_POLYPOLYGON, DS_BITMAP }

Public Member Functions
	DS_DATA_ITEM_TEXT (const wxString &aTextBase)

void	SyncDrawItems (DS_DRAW_ITEM_LIST aCollector, KIGFX::VIEW aView) override

virtual int	GetPenSizeUi () override

void	IncrementLabel (int aIncr)
	Try to build text which is an increment of m_TextBase has meaning only if m_TextBase is a basic text (one char) If the basic char is a digit, build a number If the basic char is a letter, use the letter with ASCII code aIncr + (basic char ascc code) More...

void	SetConstrainedTextSize ()
	Calculate m_ConstrainedTextSize from m_TextSize to keep the X size and the full Y size of the text smaller than m_BoundingBoxSize if m_BoundingBoxSize.x or m_BoundingBoxSize.y > 0 if m_BoundingBoxSize.x or m_BoundingBoxSize.y == 0 the corresponding text size is not constrained. More...

bool	ReplaceAntiSlashSequence ()
	Replace the '\''n' sequence by EOL and the sequence '\''\' by only one '\' inside m_FullText. More...

const std::vector< DS_DRAW_ITEM_BASE * > &	GetDrawItems () const

void	SetStart (double aPosx, double aPosy, enum CORNER_ANCHOR aAnchor=RB_CORNER)

void	SetEnd (double aPosx, double aPosy, enum CORNER_ANCHOR aAnchor=RB_CORNER)

DS_ITEM_TYPE	GetType () const

PAGE_OPTION	GetPage1Option () const

void	SetPage1Option (PAGE_OPTION aChoice)

const wxPoint	GetStartPosUi (int ii=0) const

const wxPoint	GetEndPosUi (int ii=0) const

const DPOINT	GetStartPos (int ii=0) const

const DPOINT	GetEndPos (int ii=0) const

void	MoveTo (const DPOINT &aPosition)
	Move item to a new position. More...

void	MoveToUi (const wxPoint &aPosition)
	Move item to a new position. More...

void	MoveStartPointTo (const DPOINT &aPosition)
	Move the starting point of the item to a new position. More...

void	MoveStartPointToUi (const wxPoint &aPosition)
	Move the starting point of the item to a new position. More...

void	MoveEndPointTo (const DPOINT &aPosition)
	Move the ending point of the item to a new position. More...

void	MoveEndPointToUi (const wxPoint &aPosition)
	Move the ending point of the item to a new position. More...

virtual bool	IsInsidePage (int ii) const

const wxString	GetClassName () const

Public Attributes
wxString	m_TextBase

wxString	m_FullText

double	m_Orient

EDA_TEXT_HJUSTIFY_T	m_Hjustify

EDA_TEXT_VJUSTIFY_T	m_Vjustify

bool	m_Italic

bool	m_Bold

DSIZE	m_TextSize

DSIZE	m_BoundingBoxSize

DSIZE	m_ConstrainedTextSize

wxString	m_Name

wxString	m_Info

POINT_COORD	m_Pos

POINT_COORD	m_End

double	m_LineWidth

int	m_RepeatCount

DPOINT	m_IncrementVector

int	m_IncrementLabel

Protected Attributes
DS_ITEM_TYPE	m_type

PAGE_OPTION	m_pageOption

std::vector< DS_DRAW_ITEM_BASE * >	m_drawItems

Detailed Description

Definition at line 297 of file ds_data_item.h.

Member Enumeration Documentation

◆ DS_ITEM_TYPE

enum DS_DATA_ITEM::DS_ITEM_TYPE

inherited

Enumerator
DS_TEXT
DS_SEGMENT
DS_RECT
DS_POLYPOLYGON
DS_BITMAP

Definition at line 98 of file ds_data_item.h.

                       {
         DS_TEXT,
         DS_SEGMENT,
         DS_RECT,
         DS_POLYPOLYGON,
         DS_BITMAP
     };

Constructor & Destructor Documentation

◆ DS_DATA_ITEM_TEXT()

DS_DATA_ITEM_TEXT::DS_DATA_ITEM_TEXT ( const wxString & aTextBase )

Definition at line 521 of file ds_data_item.cpp.

                                                                 :
         DS_DATA_ITEM( DS_TEXT )
 {
     m_TextBase = aTextBase;
     m_IncrementLabel = 1;
     m_Hjustify = GR_TEXT_HJUSTIFY_LEFT;
     m_Vjustify = GR_TEXT_VJUSTIFY_CENTER;
     m_Italic = false;
     m_Bold = false;
     m_Orient = 0.0;
     m_LineWidth = 0.0;      // 0 means use default value
 }

References GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_VJUSTIFY_CENTER, m_Bold, m_Hjustify, DS_DATA_ITEM::m_IncrementLabel, m_Italic, DS_DATA_ITEM::m_LineWidth, m_Orient, m_TextBase, and m_Vjustify.

Member Function Documentation

◆ GetClassName()

const wxString DS_DATA_ITEM::GetClassName ( ) const

inherited

Definition at line 364 of file ds_data_item.cpp.

 {
     wxString name;
 
     switch( GetType() )
     {
         case DS_TEXT:        name = _( "Text" );           break;
         case DS_SEGMENT:     name = _( "Line" );           break;
         case DS_RECT:        name = _( "Rectangle" );      break;
         case DS_POLYPOLYGON: name = _( "Imported Shape" ); break;
         case DS_BITMAP:      name = _( "Image" );          break;
     }
 
     return name;
 }

References _, DS_DATA_ITEM::DS_BITMAP, DS_DATA_ITEM::DS_POLYPOLYGON, DS_DATA_ITEM::DS_RECT, DS_DATA_ITEM::DS_SEGMENT, DS_DATA_ITEM::DS_TEXT, DS_DATA_ITEM::GetType(), and name.

Referenced by PROPERTIES_FRAME::CopyPrmsFromItemToPanel().

◆ GetDrawItems()

const std::vector<DS_DRAW_ITEM_BASE*>& DS_DATA_ITEM::GetDrawItems ( ) const

inlineinherited

Definition at line 110 of file ds_data_item.h.

110 { return m_drawItems; }

DS_DATA_ITEM::m_drawItems

std::vector< DS_DRAW_ITEM_BASE * > m_drawItems

Definition: ds_data_item.h:211

References DS_DATA_ITEM::m_drawItems.

Referenced by PL_DRAWING_TOOLS::DrawShape(), DS_PROXY_UNDO_ITEM::DS_PROXY_UNDO_ITEM(), PL_EDIT_TOOL::moveItem(), DIALOG_INSPECTOR::onCellClicked(), PL_DRAWING_TOOLS::PlaceItem(), DS_PROXY_UNDO_ITEM::Restore(), and PL_POINT_EDITOR::updateItem().

◆ GetEndPos()

const DPOINT DS_DATA_ITEM::GetEndPos ( int ii = 0 ) const

inherited

Definition at line 305 of file ds_data_item.cpp.

 {
     DPOINT pos( m_End.m_Pos.x + ( m_IncrementVector.x * ii ),
                 m_End.m_Pos.y + ( m_IncrementVector.y * ii ) );
 
     switch( m_End.m_Anchor )
     {
     case RB_CORNER:      // right bottom corner
         pos = DS_DATA_MODEL::GetTheInstance().m_RB_Corner - pos;
         break;
 
     case RT_CORNER:      // right top corner
         pos.x = DS_DATA_MODEL::GetTheInstance().m_RB_Corner.x - pos.x;
         pos.y = DS_DATA_MODEL::GetTheInstance().m_LT_Corner.y + pos.y;
         break;
 
     case LB_CORNER:      // left bottom corner
         pos.x = DS_DATA_MODEL::GetTheInstance().m_LT_Corner.x + pos.x;
         pos.y = DS_DATA_MODEL::GetTheInstance().m_RB_Corner.y - pos.y;
         break;
 
     case LT_CORNER:      // left top corner
         pos = DS_DATA_MODEL::GetTheInstance().m_LT_Corner + pos;
         break;
     }
 
     return pos;
 }

References DS_DATA_MODEL::GetTheInstance(), LB_CORNER, LT_CORNER, POINT_COORD::m_Anchor, DS_DATA_ITEM::m_End, DS_DATA_ITEM::m_IncrementVector, DS_DATA_MODEL::m_LT_Corner, POINT_COORD::m_Pos, DS_DATA_MODEL::m_RB_Corner, RB_CORNER, RT_CORNER, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by DS_DATA_ITEM::GetEndPosUi(), DS_DATA_ITEM::IsInsidePage(), and DS_DATA_ITEM::MoveTo().

◆ GetEndPosUi()

const wxPoint DS_DATA_ITEM::GetEndPosUi ( int ii = 0 ) const

inherited

Definition at line 335 of file ds_data_item.cpp.

 {
     DPOINT pos = GetEndPos( ii );
     pos = pos * DS_DATA_MODEL::GetTheInstance().m_WSunits2Iu;
     return wxPoint( KiROUND( pos.x ), KiROUND( pos.y ) );
 }

References DS_DATA_ITEM::GetEndPos(), DS_DATA_MODEL::GetTheInstance(), KiROUND(), DS_DATA_MODEL::m_WSunits2Iu, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by DS_DATA_ITEM::MoveTo(), DS_DATA_ITEM::SyncDrawItems(), and PL_POINT_EDITOR::updateItem().

◆ GetPage1Option()

PAGE_OPTION DS_DATA_ITEM::GetPage1Option ( ) const

inlineinherited

Returns: true if the item has a end point (segment; rect) of false (text, polygon).

Definition at line 133 of file ds_data_item.h.

133 { return m_pageOption; }

DS_DATA_ITEM::m_pageOption

PAGE_OPTION m_pageOption

Definition: ds_data_item.h:209

References DS_DATA_ITEM::m_pageOption.

Referenced by PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), DS_DATA_MODEL_IO::formatOptions(), DS_DRAW_ITEM_BASE::GetMsgPanelInfo(), and DS_DRAW_ITEM_BASE::ViewGetLayers().

◆ GetPenSizeUi()

int DS_DATA_ITEM_TEXT::GetPenSizeUi ( )

overridevirtual

Reimplemented from DS_DATA_ITEM.

Definition at line 609 of file ds_data_item.cpp.

 {
     DS_DATA_MODEL& model = DS_DATA_MODEL::GetTheInstance();
 
     if( m_LineWidth != 0 )
         return KiROUND( m_LineWidth * model.m_WSunits2Iu );
     else
         return KiROUND( model.m_DefaultTextThickness * model.m_WSunits2Iu );
 }

References DS_DATA_MODEL::GetTheInstance(), KiROUND(), DS_DATA_MODEL::m_DefaultTextThickness, DS_DATA_ITEM::m_LineWidth, and DS_DATA_MODEL::m_WSunits2Iu.

Referenced by SyncDrawItems().

◆ GetStartPos()

const DPOINT DS_DATA_ITEM::GetStartPos ( int ii = 0 ) const

inherited

Definition at line 267 of file ds_data_item.cpp.

 {
     DS_DATA_MODEL& model = DS_DATA_MODEL::GetTheInstance();
     DPOINT         pos( m_Pos.m_Pos.x + ( m_IncrementVector.x * ii ),
                         m_Pos.m_Pos.y + ( m_IncrementVector.y * ii ) );
 
     switch( m_Pos.m_Anchor )
     {
         case RB_CORNER:      // right bottom corner
             pos = model.m_RB_Corner - pos;
             break;
 
         case RT_CORNER:      // right top corner
             pos.x = model.m_RB_Corner.x - pos.x;
             pos.y = model.m_LT_Corner.y + pos.y;
             break;
 
         case LB_CORNER:      // left bottom corner
             pos.x = model.m_LT_Corner.x + pos.x;
             pos.y = model.m_RB_Corner.y - pos.y;
             break;
 
         case LT_CORNER:      // left top corner
             pos = model.m_LT_Corner + pos;
             break;
     }
 
     return pos;
 }

References DS_DATA_MODEL::GetTheInstance(), LB_CORNER, LT_CORNER, POINT_COORD::m_Anchor, DS_DATA_ITEM::m_IncrementVector, DS_DATA_MODEL::m_LT_Corner, POINT_COORD::m_Pos, DS_DATA_ITEM::m_Pos, DS_DATA_MODEL::m_RB_Corner, RB_CORNER, RT_CORNER, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by DS_DATA_ITEM_POLYGONS::GetCornerPosition(), DS_DATA_ITEM::GetStartPosUi(), DS_DATA_ITEM::IsInsidePage(), DS_DATA_ITEM_POLYGONS::IsInsidePage(), and DS_DATA_ITEM::MoveTo().

◆ GetStartPosUi()

const wxPoint DS_DATA_ITEM::GetStartPosUi ( int ii = 0 ) const

inherited

Definition at line 298 of file ds_data_item.cpp.

 {
     DPOINT pos = GetStartPos( ii ) * DS_DATA_MODEL::GetTheInstance().m_WSunits2Iu;
     return wxPoint( KiROUND( pos.x ), KiROUND( pos.y ) );
 }

References DS_DATA_ITEM::GetStartPos(), DS_DATA_MODEL::GetTheInstance(), KiROUND(), DS_DATA_MODEL::m_WSunits2Iu, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PL_EDIT_TOOL::moveItem(), DS_DATA_ITEM::MoveTo(), PL_DRAWING_TOOLS::PlaceItem(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), and PL_POINT_EDITOR::updateItem().

◆ GetType()

DS_ITEM_TYPE DS_DATA_ITEM::GetType ( ) const

inlineinherited

Definition at line 128 of file ds_data_item.h.

128 { return m_type; }

DS_DATA_ITEM::m_type

DS_ITEM_TYPE m_type

Definition: ds_data_item.h:208

References DS_DATA_ITEM::m_type.

Referenced by PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), PROPERTIES_FRAME::CopyPrmsFromPanelToItem(), DS_DATA_MODEL_IO::Format(), DS_DATA_MODEL_IO::format(), DS_DATA_MODEL_IO::formatRepeatParameters(), DS_DATA_ITEM::GetClassName(), DS_DRAW_ITEM_BASE::GetMsgPanelInfo(), and DS_DATA_ITEM::MoveEndPointTo().

◆ IncrementLabel()

void DS_DATA_ITEM_TEXT::IncrementLabel ( int aIncr )

Try to build text which is an increment of m_TextBase has meaning only if m_TextBase is a basic text (one char) If the basic char is a digit, build a number If the basic char is a letter, use the letter with ASCII code aIncr + (basic char ascc code)

Parameters

aIncr = the increment value return the incremented label in m_FullText

Definition at line 620 of file ds_data_item.cpp.

 {
     int last = m_TextBase.Len() -1;
 
     wxChar lbchar = m_TextBase[last];
     m_FullText = m_TextBase;
     m_FullText.RemoveLast();
 
     if( lbchar >= '0' &&  lbchar <= '9' )
         // A number is expected:
         m_FullText << (int)( aIncr + lbchar - '0' );
     else
         m_FullText << (wxChar) ( aIncr + lbchar );
 }

References m_FullText, and m_TextBase.

Referenced by SyncDrawItems().

◆ IsInsidePage()

bool DS_DATA_ITEM::IsInsidePage ( int ii ) const

virtualinherited

Returns: true if the item is inside the rectangle defined by the 4 corners, false otherwise.

Reimplemented in DS_DATA_ITEM_POLYGONS.

Definition at line 343 of file ds_data_item.cpp.

 {
     DS_DATA_MODEL& model = DS_DATA_MODEL::GetTheInstance();
 
     DPOINT pos = GetStartPos( ii );
 
     for( int kk = 0; kk < 1; kk++ )
     {
         if( model.m_RB_Corner.x < pos.x || model.m_LT_Corner.x > pos.x )
             return false;
 
         if( model.m_RB_Corner.y < pos.y || model.m_LT_Corner.y > pos.y )
             return false;
 
         pos = GetEndPos( ii );
     }
 
     return true;
 }

References DS_DATA_ITEM::GetEndPos(), DS_DATA_ITEM::GetStartPos(), DS_DATA_MODEL::GetTheInstance(), DS_DATA_MODEL::m_LT_Corner, DS_DATA_MODEL::m_RB_Corner, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by DS_DATA_ITEM::SyncDrawItems(), SyncDrawItems(), and DS_DATA_ITEM_BITMAP::SyncDrawItems().

◆ MoveEndPointTo()

void DS_DATA_ITEM::MoveEndPointTo ( const DPOINT & aPosition )

inherited

Move the ending point of the item to a new position.

This has meaning only for items defined by 2 points (segments and rectangles).

Parameters

aPosition is the new position of the ending point, in mm.

Definition at line 214 of file ds_data_item.cpp.

 {
     DS_DATA_MODEL& model = DS_DATA_MODEL::GetTheInstance();
     DPOINT         position;
 
     // Calculate the position of the starting point
     // relative to the reference corner
     // aPosition is the position relative to the right top paper corner
     switch( m_End.m_Anchor )
     {
     case RB_CORNER:
         position = model.m_RB_Corner - aPosition;
         break;
 
     case RT_CORNER:
         position.x = model.m_RB_Corner.x - aPosition.x;
         position.y = aPosition.y - model.m_LT_Corner.y;
         break;
 
     case LB_CORNER:
         position.x = aPosition.x - model.m_LT_Corner.x;
         position.y = model.m_RB_Corner.y - aPosition.y;
         break;
 
     case LT_CORNER:
         position = aPosition - model.m_LT_Corner;
         break;
     }
 
     // Modify m_End only for items having 2 coordinates
     switch( GetType() )
     {
     case DS_SEGMENT:
     case DS_RECT:
         m_End.m_Pos = position;
         break;
 
     default:
         break;
     }
 }

References DS_DATA_ITEM::DS_RECT, DS_DATA_ITEM::DS_SEGMENT, DS_DATA_MODEL::GetTheInstance(), DS_DATA_ITEM::GetType(), LB_CORNER, LT_CORNER, POINT_COORD::m_Anchor, DS_DATA_ITEM::m_End, DS_DATA_MODEL::m_LT_Corner, POINT_COORD::m_Pos, DS_DATA_MODEL::m_RB_Corner, RB_CORNER, RT_CORNER, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by DS_DATA_ITEM::MoveEndPointToUi(), and DS_DATA_ITEM::MoveTo().

◆ MoveEndPointToUi()

void DS_DATA_ITEM::MoveEndPointToUi ( const wxPoint & aPosition )

inherited

Move the ending point of the item to a new position.

This has meaning only for items defined by 2 points (segments and rectangles).

Parameters

aPosition is the new position of the ending point in graphic units

Definition at line 257 of file ds_data_item.cpp.

 {
     DPOINT pos_mm;
     pos_mm.x = aPosition.x / DS_DATA_MODEL::GetTheInstance().m_WSunits2Iu;
     pos_mm.y = aPosition.y / DS_DATA_MODEL::GetTheInstance().m_WSunits2Iu;
 
     MoveEndPointTo( pos_mm );
 }

References DS_DATA_MODEL::GetTheInstance(), DS_DATA_MODEL::m_WSunits2Iu, DS_DATA_ITEM::MoveEndPointTo(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PL_POINT_EDITOR::updateItem().

◆ MoveStartPointTo()

void DS_DATA_ITEM::MoveStartPointTo ( const DPOINT & aPosition )

inherited

Move the starting point of the item to a new position.

Parameters

aPosition the new position of the starting point, in mm.

Definition at line 172 of file ds_data_item.cpp.

 {
     DS_DATA_MODEL& model = DS_DATA_MODEL::GetTheInstance();
     DPOINT         position;
 
     // Calculate the position of the starting point
     // relative to the reference corner
     // aPosition is the position relative to the right top paper corner
     switch( m_Pos.m_Anchor )
     {
     case RB_CORNER:
         position = model.m_RB_Corner - aPosition;
         break;
 
     case RT_CORNER:
         position.x = model.m_RB_Corner.x - aPosition.x;
         position.y = aPosition.y - model.m_LT_Corner.y;
         break;
 
     case LB_CORNER:
         position.x = aPosition.x - model.m_LT_Corner.x;
         position.y = model.m_RB_Corner.y - aPosition.y;
         break;
 
     case LT_CORNER:
         position = aPosition - model.m_LT_Corner;
         break;
     }
 
     m_Pos.m_Pos = position;
 }

References DS_DATA_MODEL::GetTheInstance(), LB_CORNER, LT_CORNER, POINT_COORD::m_Anchor, DS_DATA_MODEL::m_LT_Corner, POINT_COORD::m_Pos, DS_DATA_ITEM::m_Pos, DS_DATA_MODEL::m_RB_Corner, RB_CORNER, RT_CORNER, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by DS_DATA_ITEM::MoveStartPointToUi(), and DS_DATA_ITEM::MoveTo().

◆ MoveStartPointToUi()

void DS_DATA_ITEM::MoveStartPointToUi ( const wxPoint & aPosition )

inherited

Move the starting point of the item to a new position.

Parameters

aPosition is the new position of item in graphic units.

Definition at line 205 of file ds_data_item.cpp.

 {
     DPOINT pos_mm( aPosition.x / DS_DATA_MODEL::GetTheInstance().m_WSunits2Iu,
                    aPosition.y / DS_DATA_MODEL::GetTheInstance().m_WSunits2Iu );
 
     MoveStartPointTo( pos_mm );
 }

References DS_DATA_MODEL::GetTheInstance(), DS_DATA_MODEL::m_WSunits2Iu, and DS_DATA_ITEM::MoveStartPointTo().

Referenced by PL_DRAWING_TOOLS::PlaceItem(), and PL_POINT_EDITOR::updateItem().

◆ MoveTo()

void DS_DATA_ITEM::MoveTo ( const DPOINT & aPosition )

inherited

Move item to a new position.

Parameters

aPosition the new position of item, in mm.

Definition at line 156 of file ds_data_item.cpp.

 {
     DPOINT vector = aPosition - GetStartPos();
     DPOINT endpos = vector + GetEndPos();
 
     MoveStartPointTo( aPosition );
     MoveEndPointTo( endpos );
 
     for( DS_DRAW_ITEM_BASE* drawItem : m_drawItems )
     {
         drawItem->SetPosition( GetStartPosUi( drawItem->GetIndexInPeer() ) );
         drawItem->SetEnd( GetEndPosUi( drawItem->GetIndexInPeer() ) );
     }
 }

References DS_DATA_ITEM::GetEndPos(), DS_DATA_ITEM::GetEndPosUi(), DS_DATA_ITEM::GetStartPos(), DS_DATA_ITEM::GetStartPosUi(), DS_DATA_ITEM::m_drawItems, DS_DATA_ITEM::MoveEndPointTo(), and DS_DATA_ITEM::MoveStartPointTo().

Referenced by DS_DATA_ITEM::MoveToUi().

◆ MoveToUi()

void DS_DATA_ITEM::MoveToUi ( const wxPoint & aPosition )

inherited

Move item to a new position.

Parameters

aPosition the new position of the starting point in graphic units.

Definition at line 146 of file ds_data_item.cpp.

 {
     DPOINT pos_mm;
     pos_mm.x = aPosition.x / DS_DATA_MODEL::GetTheInstance().m_WSunits2Iu;
     pos_mm.y = aPosition.y / DS_DATA_MODEL::GetTheInstance().m_WSunits2Iu;
 
     MoveTo( pos_mm );
 }

References DS_DATA_MODEL::GetTheInstance(), DS_DATA_MODEL::m_WSunits2Iu, DS_DATA_ITEM::MoveTo(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PL_DRAWING_TOOLS::DrawShape(), and PL_EDIT_TOOL::moveItem().

◆ ReplaceAntiSlashSequence()

bool DS_DATA_ITEM_TEXT::ReplaceAntiSlashSequence ( )

Replace the '\''n' sequence by EOL and the sequence '\''\' by only one '\' inside m_FullText.

Returns: true if the EOL symbol is found or is inserted (multiline text).

Definition at line 639 of file ds_data_item.cpp.

 {
     bool multiline = false;
 
     for( unsigned ii = 0; ii < m_FullText.Len(); ii++ )
     {
         if( m_FullText[ii] == '\n' )
             multiline = true;
 
         else if( m_FullText[ii] == '\\' )
         {
             if( ++ii >= m_FullText.Len() )
                 break;
 
             if( m_FullText[ii] == '\\' )
             {
                 // a double \\ sequence is replaced by a single \ char
                 m_FullText.Remove(ii, 1);
                 ii--;
             }
             else if( m_FullText[ii] == 'n' )
             {
                 // Replace the "\n" sequence by a EOL char
                 multiline = true;
                 m_FullText[ii] = '\n';
                 m_FullText.Remove(ii-1, 1);
                 ii--;
             }
         }
     }
 
     return multiline;
 }

References m_FullText.

Referenced by PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), and SyncDrawItems().

◆ SetConstrainedTextSize()

void DS_DATA_ITEM_TEXT::SetConstrainedTextSize ( )

Calculate m_ConstrainedTextSize from m_TextSize to keep the X size and the full Y size of the text smaller than m_BoundingBoxSize if m_BoundingBoxSize.x or m_BoundingBoxSize.y > 0 if m_BoundingBoxSize.x or m_BoundingBoxSize.y == 0 the corresponding text size is not constrained.

Definition at line 674 of file ds_data_item.cpp.

 {
     m_ConstrainedTextSize = m_TextSize;
 
     if( m_ConstrainedTextSize.x == 0  )
         m_ConstrainedTextSize.x = DS_DATA_MODEL::GetTheInstance().m_DefaultTextSize.x;
 
     if( m_ConstrainedTextSize.y == 0 )
         m_ConstrainedTextSize.y = DS_DATA_MODEL::GetTheInstance().m_DefaultTextSize.y;
 
     if( m_BoundingBoxSize.x || m_BoundingBoxSize.y )
     {
         // to know the X and Y size of the line, we should use
         // EDA_TEXT::GetTextBox()
         // but this function uses integers
         // So, to avoid truncations with our unit in mm, use microns.
         wxSize size_micron;
         #define FSCALE 1000.0
         int linewidth = 0;
         size_micron.x = KiROUND( m_ConstrainedTextSize.x * FSCALE );
         size_micron.y = KiROUND( m_ConstrainedTextSize.y * FSCALE );
         DS_DRAW_ITEM_TEXT dummy( DS_DRAW_ITEM_TEXT( this, 0, m_FullText, wxPoint( 0, 0 ),
                                                     size_micron, linewidth, m_Italic, m_Bold ) );
         dummy.SetMultilineAllowed( true );
         dummy.SetHorizJustify( m_Hjustify ) ;
         dummy.SetVertJustify( m_Vjustify );
         dummy.SetTextAngle( m_Orient * 10 );
 
         EDA_RECT rect = dummy.GetTextBox();
         DSIZE size;
         size.x = rect.GetWidth() / FSCALE;
         size.y = rect.GetHeight() / FSCALE;
 
         if( m_BoundingBoxSize.x && size.x > m_BoundingBoxSize.x )
             m_ConstrainedTextSize.x *= m_BoundingBoxSize.x / size.x;
 
         if( m_BoundingBoxSize.y &&  size.y > m_BoundingBoxSize.y )
             m_ConstrainedTextSize.y *= m_BoundingBoxSize.y / size.y;
     }
 }

References dummy(), FSCALE, EDA_RECT::GetHeight(), DS_DATA_MODEL::GetTheInstance(), EDA_RECT::GetWidth(), KiROUND(), m_Bold, m_BoundingBoxSize, m_ConstrainedTextSize, DS_DATA_MODEL::m_DefaultTextSize, m_FullText, m_Hjustify, m_Italic, m_Orient, m_TextSize, m_Vjustify, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SyncDrawItems().

◆ SetEnd()

void DS_DATA_ITEM::SetEnd	(	double	aPosx,
		double	aPosy,
		enum CORNER_ANCHOR	aAnchor = `RB_CORNER`
	)

inlineinherited

Definition at line 121 of file ds_data_item.h.

     {
         m_End.m_Pos.x = aPosx;
         m_End.m_Pos.y = aPosy;
         m_End.m_Anchor = aAnchor;
     }

References POINT_COORD::m_Anchor, DS_DATA_ITEM::m_End, POINT_COORD::m_Pos, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ SetPage1Option()

void DS_DATA_ITEM::SetPage1Option ( PAGE_OPTION aChoice )

inlineinherited

Definition at line 134 of file ds_data_item.h.

134 { m_pageOption = aChoice; }

DS_DATA_ITEM::m_pageOption

PAGE_OPTION m_pageOption

Definition: ds_data_item.h:209

References DS_DATA_ITEM::m_pageOption.

Referenced by PROPERTIES_FRAME::CopyPrmsFromPanelToItem(), and DRAWING_SHEET_PARSER::readOption().

◆ SetStart()

void DS_DATA_ITEM::SetStart	(	double	aPosx,
		double	aPosy,
		enum CORNER_ANCHOR	aAnchor = `RB_CORNER`
	)

inlineinherited

Definition at line 114 of file ds_data_item.h.

     {
         m_Pos.m_Pos.x = aPosx;
         m_Pos.m_Pos.y = aPosy;
         m_Pos.m_Anchor = aAnchor;
     }

References POINT_COORD::m_Anchor, POINT_COORD::m_Pos, DS_DATA_ITEM::m_Pos, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ SyncDrawItems()

void DS_DATA_ITEM_TEXT::SyncDrawItems	(	DS_DRAW_ITEM_LIST *	aCollector,
		KIGFX::VIEW *	aView
	)

overridevirtual

Reimplemented from DS_DATA_ITEM.

Definition at line 535 of file ds_data_item.cpp.

 {
     int   pensize = GetPenSizeUi();
     bool  multilines = false;
 
     if( DS_DATA_MODEL::GetTheInstance().m_EditMode )
     {
         m_FullText = m_TextBase;
     }
     else
     {
         m_FullText = aCollector ? aCollector->BuildFullText( m_TextBase ) : wxString();
         multilines = ReplaceAntiSlashSequence();
     }
 
     if( pensize == 0 )
         pensize = aCollector ? aCollector->GetDefaultPenSize() : 1;
 
     SetConstrainedTextSize();
     wxSize textsize;
 
     textsize.x = KiROUND( m_ConstrainedTextSize.x * DS_DATA_MODEL::GetTheInstance().m_WSunits2Iu );
     textsize.y = KiROUND( m_ConstrainedTextSize.y * DS_DATA_MODEL::GetTheInstance().m_WSunits2Iu );
 
     if( m_Bold )
         pensize = GetPenSizeForBold( std::min( textsize.x, textsize.y ) );
 
     std::map<size_t, EDA_ITEM_FLAGS> itemFlags;
     DS_DRAW_ITEM_TEXT*          text = nullptr;
 
     for( size_t i = 0; i < m_drawItems.size(); ++i )
     {
         text = (DS_DRAW_ITEM_TEXT*) m_drawItems[ i ];
         itemFlags[ i ] = text->GetFlags();
 
         if( aCollector )
             aCollector->Remove( text );
 
         if( aView )
             aView->Remove( text );
 
         delete text;
     }
 
     m_drawItems.clear();
 
     for( int j = 0; j < m_RepeatCount; ++j )
     {
         if( j > 0 && !IsInsidePage( j ) )
             continue;
 
         text = new DS_DRAW_ITEM_TEXT( this, j, m_FullText, GetStartPosUi( j ), textsize, pensize,
                                       m_Italic, m_Bold );
         text->SetFlags( itemFlags[ j ] );
         m_drawItems.push_back( text );
 
         if( aCollector )
             aCollector->Append( text );
 
         if( aView )
             aView->Add( text );
 
         text->SetHorizJustify( m_Hjustify ) ;
         text->SetVertJustify( m_Vjustify );
         text->SetTextAngle( m_Orient * 10 );    // graphic text orient unit = 0.1 degree
         text->SetMultilineAllowed( multilines );
 
         // Increment label for the next text (has no meaning for multiline texts)
         if( m_RepeatCount > 1 && !multilines )
             IncrementLabel(( j + 1 ) * m_IncrementLabel );
     }
 }

References KIGFX::VIEW::Add(), DS_DRAW_ITEM_LIST::Append(), DS_DRAW_ITEM_LIST::BuildFullText(), DS_DRAW_ITEM_LIST::GetDefaultPenSize(), GetPenSizeForBold(), GetPenSizeUi(), DS_DATA_ITEM::GetStartPosUi(), DS_DATA_MODEL::GetTheInstance(), IncrementLabel(), DS_DATA_ITEM::IsInsidePage(), KiROUND(), m_Bold, m_ConstrainedTextSize, DS_DATA_ITEM::m_drawItems, m_FullText, m_Hjustify, DS_DATA_ITEM::m_IncrementLabel, m_Italic, m_Orient, DS_DATA_ITEM::m_RepeatCount, m_TextBase, m_Vjustify, DS_DATA_MODEL::m_WSunits2Iu, KIGFX::VIEW::Remove(), DS_DRAW_ITEM_LIST::Remove(), ReplaceAntiSlashSequence(), SetConstrainedTextSize(), text, VECTOR2< T >::x, and VECTOR2< T >::y.

Member Data Documentation

◆ m_Bold

bool DS_DATA_ITEM_TEXT::m_Bold

Definition at line 341 of file ds_data_item.h.

Referenced by PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), PROPERTIES_FRAME::CopyPrmsFromPanelToItem(), DS_DATA_ITEM_TEXT(), DS_DATA_MODEL_IO::format(), DRAWING_SHEET_PARSER::parseText(), SetConstrainedTextSize(), and SyncDrawItems().

◆ m_BoundingBoxSize

DSIZE DS_DATA_ITEM_TEXT::m_BoundingBoxSize

Definition at line 343 of file ds_data_item.h.

Referenced by PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), PROPERTIES_FRAME::CopyPrmsFromPanelToItem(), DS_DATA_MODEL_IO::format(), DRAWING_SHEET_PARSER::parseText(), and SetConstrainedTextSize().

◆ m_ConstrainedTextSize

DSIZE DS_DATA_ITEM_TEXT::m_ConstrainedTextSize

Definition at line 346 of file ds_data_item.h.

Referenced by SetConstrainedTextSize(), and SyncDrawItems().

◆ m_drawItems

std::vector<DS_DRAW_ITEM_BASE*> DS_DATA_ITEM::m_drawItems

protectedinherited

Definition at line 211 of file ds_data_item.h.

Referenced by DS_DATA_ITEM::GetDrawItems(), DS_DATA_ITEM::MoveTo(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), and DS_DATA_ITEM::~DS_DATA_ITEM().

◆ m_End

POINT_COORD DS_DATA_ITEM::m_End

inherited

Definition at line 201 of file ds_data_item.h.

Referenced by PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), PROPERTIES_FRAME::CopyPrmsFromPanelToItem(), DS_DATA_MODEL_IO::format(), DS_DATA_ITEM::GetEndPos(), DS_DATA_ITEM::MoveEndPointTo(), DRAWING_SHEET_PARSER::parseGraphic(), and DS_DATA_ITEM::SetEnd().

◆ m_FullText

wxString DS_DATA_ITEM_TEXT::m_FullText

Definition at line 336 of file ds_data_item.h.

Referenced by PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), IncrementLabel(), ReplaceAntiSlashSequence(), SetConstrainedTextSize(), and SyncDrawItems().

◆ m_Hjustify

EDA_TEXT_HJUSTIFY_T DS_DATA_ITEM_TEXT::m_Hjustify

Definition at line 338 of file ds_data_item.h.

Referenced by PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), PROPERTIES_FRAME::CopyPrmsFromPanelToItem(), DS_DATA_ITEM_TEXT(), DS_DATA_MODEL_IO::format(), DRAWING_SHEET_PARSER::parseText(), SetConstrainedTextSize(), and SyncDrawItems().

◆ m_IncrementLabel

int DS_DATA_ITEM::m_IncrementLabel

inherited

Definition at line 205 of file ds_data_item.h.

Referenced by PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), PROPERTIES_FRAME::CopyPrmsFromPanelToItem(), DS_DATA_ITEM::DS_DATA_ITEM(), DS_DATA_ITEM_TEXT(), DS_DATA_MODEL_IO::formatRepeatParameters(), DS_DRAW_ITEM_BASE::GetMsgPanelInfo(), DRAWING_SHEET_PARSER::parseText(), and SyncDrawItems().

◆ m_IncrementVector

DPOINT DS_DATA_ITEM::m_IncrementVector

inherited

Definition at line 204 of file ds_data_item.h.

Referenced by PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), PROPERTIES_FRAME::CopyPrmsFromPanelToItem(), DS_DATA_MODEL_IO::formatRepeatParameters(), DS_DATA_ITEM::GetEndPos(), DS_DRAW_ITEM_BASE::GetMsgPanelInfo(), DS_DATA_ITEM::GetStartPos(), DRAWING_SHEET_PARSER::parseBitmap(), DRAWING_SHEET_PARSER::parseGraphic(), DRAWING_SHEET_PARSER::parsePolygon(), and DRAWING_SHEET_PARSER::parseText().

◆ m_Info

wxString DS_DATA_ITEM::m_Info

inherited

Definition at line 199 of file ds_data_item.h.

Referenced by PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), PROPERTIES_FRAME::CopyPrmsFromPanelToItem(), DS_DATA_MODEL_IO::format(), DS_DRAW_ITEM_BASE::GetMsgPanelInfo(), DRAWING_SHEET_PARSER::parseGraphic(), DRAWING_SHEET_PARSER::parsePolygon(), and DRAWING_SHEET_PARSER::parseText().

◆ m_Italic

bool DS_DATA_ITEM_TEXT::m_Italic

Definition at line 340 of file ds_data_item.h.

Referenced by PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), PROPERTIES_FRAME::CopyPrmsFromPanelToItem(), DS_DATA_ITEM_TEXT(), DS_DATA_MODEL_IO::format(), DRAWING_SHEET_PARSER::parseText(), SetConstrainedTextSize(), and SyncDrawItems().

◆ m_LineWidth

double DS_DATA_ITEM::m_LineWidth

inherited

Definition at line 202 of file ds_data_item.h.

Referenced by PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), PROPERTIES_FRAME::CopyPrmsFromPanelToItem(), DS_DATA_ITEM::DS_DATA_ITEM(), DS_DATA_ITEM_TEXT(), DS_DATA_MODEL_IO::format(), DS_DATA_ITEM::GetPenSizeUi(), DS_DATA_ITEM_POLYGONS::GetPenSizeUi(), GetPenSizeUi(), DRAWING_SHEET_PARSER::parseBitmap(), DRAWING_SHEET_PARSER::parseGraphic(), DRAWING_SHEET_PARSER::parsePolygon(), and DRAWING_SHEET_PARSER::parseText().

◆ m_Name

wxString DS_DATA_ITEM::m_Name

inherited

Definition at line 198 of file ds_data_item.h.

Referenced by DS_DATA_MODEL_IO::format(), DRAWING_SHEET_PARSER::parseBitmap(), DRAWING_SHEET_PARSER::parseGraphic(), DRAWING_SHEET_PARSER::parsePolygon(), and DRAWING_SHEET_PARSER::parseText().

◆ m_Orient

double DS_DATA_ITEM_TEXT::m_Orient

Definition at line 337 of file ds_data_item.h.

Referenced by PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), PROPERTIES_FRAME::CopyPrmsFromPanelToItem(), DS_DATA_ITEM_TEXT(), DS_DATA_MODEL_IO::format(), DRAWING_SHEET_PARSER::parseText(), SetConstrainedTextSize(), and SyncDrawItems().

◆ m_pageOption

PAGE_OPTION DS_DATA_ITEM::m_pageOption

protectedinherited

Definition at line 209 of file ds_data_item.h.

Referenced by DS_DATA_ITEM::DS_DATA_ITEM(), DS_DATA_ITEM::GetPage1Option(), and DS_DATA_ITEM::SetPage1Option().

◆ m_Pos

POINT_COORD DS_DATA_ITEM::m_Pos

inherited

Definition at line 200 of file ds_data_item.h.

Referenced by PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), PROPERTIES_FRAME::CopyPrmsFromPanelToItem(), DS_DATA_MODEL_IO::format(), DS_DATA_ITEM::GetStartPos(), DS_DATA_ITEM::MoveStartPointTo(), DRAWING_SHEET_PARSER::parseBitmap(), DRAWING_SHEET_PARSER::parseGraphic(), DRAWING_SHEET_PARSER::parsePolygon(), DRAWING_SHEET_PARSER::parseText(), and DS_DATA_ITEM::SetStart().

◆ m_RepeatCount

int DS_DATA_ITEM::m_RepeatCount

inherited

Definition at line 203 of file ds_data_item.h.

Referenced by PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), PROPERTIES_FRAME::CopyPrmsFromPanelToItem(), DS_DATA_ITEM::DS_DATA_ITEM(), DS_DATA_MODEL_IO::formatRepeatParameters(), DS_DRAW_ITEM_BASE::GetMsgPanelInfo(), DRAWING_SHEET_PARSER::parseBitmap(), DRAWING_SHEET_PARSER::parseGraphic(), DRAWING_SHEET_PARSER::parsePolygon(), DRAWING_SHEET_PARSER::parseText(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), SyncDrawItems(), and DS_DATA_ITEM_BITMAP::SyncDrawItems().

◆ m_TextBase

wxString DS_DATA_ITEM_TEXT::m_TextBase

Definition at line 335 of file ds_data_item.h.

Referenced by PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), PROPERTIES_FRAME::CopyPrmsFromPanelToItem(), DS_DATA_ITEM_TEXT(), DS_DATA_MODEL_IO::format(), IncrementLabel(), DRAWING_SHEET_PARSER::parseText(), DIALOG_INSPECTOR::ReCreateDesignList(), and SyncDrawItems().

◆ m_TextSize

DSIZE DS_DATA_ITEM_TEXT::m_TextSize

Definition at line 342 of file ds_data_item.h.

Referenced by PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), PROPERTIES_FRAME::CopyPrmsFromPanelToItem(), DS_DATA_MODEL_IO::format(), DRAWING_SHEET_PARSER::parseText(), and SetConstrainedTextSize().

◆ m_type

DS_ITEM_TYPE DS_DATA_ITEM::m_type

protectedinherited

Definition at line 208 of file ds_data_item.h.

Referenced by DS_DATA_ITEM::DS_DATA_ITEM(), DS_DATA_ITEM::GetType(), and DS_DATA_ITEM::SyncDrawItems().

◆ m_Vjustify

EDA_TEXT_VJUSTIFY_T DS_DATA_ITEM_TEXT::m_Vjustify

Definition at line 339 of file ds_data_item.h.

Referenced by PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), PROPERTIES_FRAME::CopyPrmsFromPanelToItem(), DS_DATA_ITEM_TEXT(), DS_DATA_MODEL_IO::format(), DRAWING_SHEET_PARSER::parseText(), SetConstrainedTextSize(), and SyncDrawItems().

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ DS_ITEM_TYPE

Constructor & Destructor Documentation

◆ DS_DATA_ITEM_TEXT()

Member Function Documentation

◆ GetClassName()

◆ GetDrawItems()

◆ GetEndPos()

◆ GetEndPosUi()

◆ GetPage1Option()

◆ GetPenSizeUi()

◆ GetStartPos()

◆ GetStartPosUi()

◆ GetType()

◆ IncrementLabel()

◆ IsInsidePage()

◆ MoveEndPointTo()

◆ MoveEndPointToUi()

◆ MoveStartPointTo()

◆ MoveStartPointToUi()

◆ MoveTo()

◆ MoveToUi()

◆ ReplaceAntiSlashSequence()

◆ SetConstrainedTextSize()

◆ SetEnd()

◆ SetPage1Option()

◆ SetStart()

◆ SyncDrawItems()

Member Data Documentation

◆ m_Bold

◆ m_BoundingBoxSize

◆ m_ConstrainedTextSize

◆ m_drawItems

◆ m_End

◆ m_FullText

◆ m_Hjustify

◆ m_IncrementLabel

◆ m_IncrementVector

◆ m_Info

◆ m_Italic

◆ m_LineWidth

◆ m_Name

◆ m_Orient

◆ m_pageOption

◆ m_Pos

◆ m_RepeatCount

◆ m_TextBase

◆ m_TextSize

◆ m_type

◆ m_Vjustify