FP_TEXT_GRID_TABLE Class Reference

#include <fp_text_grid_table.h>

Inheritance diagram for FP_TEXT_GRID_TABLE:

Public Member Functions
	FP_TEXT_GRID_TABLE (PCB_BASE_FRAME *aFrame)
	~FP_TEXT_GRID_TABLE ()
int	GetNumberRows () override
int	GetNumberCols () override
wxString	GetColLabelValue (int aCol) override
wxString	GetRowLabelValue (int aRow) override
bool	IsEmptyCell (int row, int col) override
bool	CanGetValueAs (int aRow, int aCol, const wxString &aTypeName) override
bool	CanSetValueAs (int aRow, int aCol, const wxString &aTypeName) override
wxGridCellAttr *	GetAttr (int row, int col, wxGridCellAttr::wxAttrKind kind) override
wxString	GetValue (int aRow, int aCol) override
bool	GetValueAsBool (int aRow, int aCol) override
long	GetValueAsLong (int aRow, int aCol) override
void	SetValue (int aRow, int aCol, const wxString &aValue) override
void	SetValueAsBool (int aRow, int aCol, bool aValue) override
void	SetValueAsLong (int aRow, int aCol, long aValue) override

Protected Member Functions
void	onUnitsChanged (wxCommandEvent &aEvent)

Private Attributes
PCB_BASE_FRAME *	m_frame
wxGridCellAttr *	m_readOnlyAttr
wxGridCellAttr *	m_boolColAttr
wxGridCellAttr *	m_orientationColAttr
wxGridCellAttr *	m_layerColAttr

Detailed Description

Definition at line 54 of file fp_text_grid_table.h.

Constructor & Destructor Documentation

FP_TEXT_GRID_TABLE()

FP_TEXT_GRID_TABLE::FP_TEXT_GRID_TABLE

(

PCB_BASE_FRAME *

aFrame

)

Definition at line 43 of file fp_text_grid_table.cpp.

 :
 m_frame( aFrame )
{
 // Build the column attributes.

 m_readOnlyAttr = new wxGridCellAttr;
 m_readOnlyAttr->SetReadOnly( true );

 m_boolColAttr = new wxGridCellAttr;
 m_boolColAttr->SetRenderer( new wxGridCellBoolRenderer() );
 m_boolColAttr->SetEditor( new wxGridCellBoolEditor() );
 m_boolColAttr->SetAlignment( wxALIGN_CENTER, wxALIGN_CENTER );

 if( g_menuOrientations.IsEmpty() )
 {
 g_menuOrientations.push_back(
 wxT( "0 " ) + GetAbbreviatedUnitsLabel( EDA_UNITS::DEGREES ) );
 g_menuOrientations.push_back(
 wxT( "90 " ) + GetAbbreviatedUnitsLabel( EDA_UNITS::DEGREES ) );
 g_menuOrientations.push_back(
 wxT( "-90 " ) + GetAbbreviatedUnitsLabel( EDA_UNITS::DEGREES ) );
 g_menuOrientations.push_back(
 wxT( "180 " ) + GetAbbreviatedUnitsLabel( EDA_UNITS::DEGREES ) );
 }

 m_orientationColAttr = new wxGridCellAttr;
 m_orientationColAttr->SetEditor( new GRID_CELL_COMBOBOX( g_menuOrientations ) );

 m_layerColAttr = new wxGridCellAttr;
 m_layerColAttr->SetRenderer( new GRID_CELL_LAYER_RENDERER( m_frame ) );
 m_layerColAttr->SetEditor( new GRID_CELL_LAYER_SELECTOR( m_frame, {} ) );

 m_frame->Bind( UNITS_CHANGED, &FP_TEXT_GRID_TABLE::onUnitsChanged, this );
}

References DEGREES, g_menuOrientations, GetAbbreviatedUnitsLabel(), m_boolColAttr, m_frame, m_layerColAttr, m_orientationColAttr, m_readOnlyAttr, and onUnitsChanged().

~FP_TEXT_GRID_TABLE()

FP_TEXT_GRID_TABLE::~FP_TEXT_GRID_TABLE

(

)

Definition at line 79 of file fp_text_grid_table.cpp.

{
 m_readOnlyAttr->DecRef();
 m_boolColAttr->DecRef();
 m_orientationColAttr->DecRef();
 m_layerColAttr->DecRef();

 m_frame->Unbind( UNITS_CHANGED, &FP_TEXT_GRID_TABLE::onUnitsChanged, this );
}

References m_boolColAttr, m_frame, m_layerColAttr, m_orientationColAttr, m_readOnlyAttr, and onUnitsChanged().

Member Function Documentation

CanGetValueAs()

bool FP_TEXT_GRID_TABLE::CanGetValueAs ( int  aRow, int  aCol, const wxString &  aTypeName  )

override

Definition at line 130 of file fp_text_grid_table.cpp.

{
 switch( aCol )
 {
 case FPT_TEXT:
 case FPT_WIDTH:
 case FPT_HEIGHT:
 case FPT_THICKNESS:
 case FPT_ORIENTATION:
 case FPT_XOFFSET:
 case FPT_YOFFSET:
 return aTypeName == wxGRID_VALUE_STRING;

 case FPT_SHOWN:
 case FPT_ITALIC:
 case FPT_UPRIGHT:
 return aTypeName == wxGRID_VALUE_BOOL;

 case FPT_LAYER:
 return aTypeName == wxGRID_VALUE_NUMBER;

 default:
 wxFAIL;
 return false;
 }
}

References FPT_HEIGHT, FPT_ITALIC, FPT_LAYER, FPT_ORIENTATION, FPT_SHOWN, FPT_TEXT, FPT_THICKNESS, FPT_UPRIGHT, FPT_WIDTH, FPT_XOFFSET, and FPT_YOFFSET.

Referenced by CanSetValueAs().

CanSetValueAs()

bool FP_TEXT_GRID_TABLE::CanSetValueAs ( int  aRow, int  aCol, const wxString &  aTypeName  )

override

Definition at line 158 of file fp_text_grid_table.cpp.

{
 return CanGetValueAs( aRow, aCol, aTypeName );
}

References CanGetValueAs().

GetAttr()

wxGridCellAttr * FP_TEXT_GRID_TABLE::GetAttr ( int  row, int  col, wxGridCellAttr::wxAttrKind  kind  )

override

Definition at line 164 of file fp_text_grid_table.cpp.

{
 switch( aCol )
 {
 case FPT_TEXT:
 case FPT_WIDTH:
 case FPT_HEIGHT:
 case FPT_THICKNESS:
 case FPT_XOFFSET:
 case FPT_YOFFSET:
 return nullptr;

 case FPT_SHOWN:
 case FPT_ITALIC:
 case FPT_UPRIGHT:
 m_boolColAttr->IncRef();
 return m_boolColAttr;

 case FPT_LAYER:
 m_layerColAttr->IncRef();
 return m_layerColAttr;

 case FPT_ORIENTATION:
 m_orientationColAttr->IncRef();
 return m_orientationColAttr;

 default:
 wxFAIL;
 return nullptr;
 }
}

References FPT_HEIGHT, FPT_ITALIC, FPT_LAYER, FPT_ORIENTATION, FPT_SHOWN, FPT_TEXT, FPT_THICKNESS, FPT_UPRIGHT, FPT_WIDTH, FPT_XOFFSET, FPT_YOFFSET, m_boolColAttr, m_layerColAttr, and m_orientationColAttr.

GetColLabelValue()

wxString FP_TEXT_GRID_TABLE::GetColLabelValue ( int  aCol )

override

Definition at line 99 of file fp_text_grid_table.cpp.

{
 switch( aCol )
 {
 case FPT_TEXT: return _( "Text Items" );
 case FPT_SHOWN: return _( "Show" );
 case FPT_WIDTH: return _( "Width" );
 case FPT_HEIGHT: return _( "Height" );
 case FPT_THICKNESS: return _( "Thickness" );
 case FPT_ITALIC: return _( "Italic" );
 case FPT_LAYER: return _( "Layer" );
 case FPT_ORIENTATION: return _( "Orientation" );
 case FPT_UPRIGHT: return _( "Keep Upright" );
 case FPT_XOFFSET: return _( "X Offset" );
 case FPT_YOFFSET: return _( "Y Offset" );
 default: wxFAIL; return wxEmptyString;
 }
}

References _, FPT_HEIGHT, FPT_ITALIC, FPT_LAYER, FPT_ORIENTATION, FPT_SHOWN, FPT_TEXT, FPT_THICKNESS, FPT_UPRIGHT, FPT_WIDTH, FPT_XOFFSET, and FPT_YOFFSET.

GetNumberCols()

int FP_TEXT_GRID_TABLE::GetNumberCols ( )

inlineoverride

Definition at line 61 of file fp_text_grid_table.h.

{ return FPT_COUNT; }

References FPT_COUNT.

GetNumberRows()

int FP_TEXT_GRID_TABLE::GetNumberRows ( )

inlineoverride

Definition at line 60 of file fp_text_grid_table.h.

{ return (int) size(); }

Referenced by DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow(), and DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow().

GetRowLabelValue()

wxString FP_TEXT_GRID_TABLE::GetRowLabelValue ( int  aRow )

override

Definition at line 119 of file fp_text_grid_table.cpp.

{
 switch( aRow )
 {
 case 0: return _( "Reference designator" );
 case 1: return _( "Value" );
 default: return wxEmptyString;
 }
}

References _.

GetValue()

wxString FP_TEXT_GRID_TABLE::GetValue ( int  aRow, int  aCol  )

override

Definition at line 197 of file fp_text_grid_table.cpp.

{
 const FP_TEXT& text = this->at((size_t) aRow );

 switch( aCol )
 {
 case FPT_TEXT:
 return text.GetText();

 case FPT_WIDTH:
 return StringFromValue( m_frame->GetUserUnits(), text.GetTextWidth(), true );

 case FPT_HEIGHT:
 return StringFromValue( m_frame->GetUserUnits(), text.GetTextHeight(), true );

 case FPT_THICKNESS:
 return StringFromValue( m_frame->GetUserUnits(), text.GetTextThickness(), true );

 case FPT_LAYER:
 return text.GetLayerName();

 case FPT_ORIENTATION:
 return StringFromValue( EDA_UNITS::DEGREES, (int) NormalizeAnglePos( text.GetTextAngle() ),
 true );

 case FPT_XOFFSET:
 return StringFromValue( m_frame->GetUserUnits(), text.GetPos0().x, true );

 case FPT_YOFFSET:
 return StringFromValue( m_frame->GetUserUnits(), text.GetPos0().y, true );

 default:
 // we can't assert here because wxWidgets sometimes calls this without checking
 // the column type when trying to see if there's an overflow
 return wxT( "bad wxWidgets!" );
 }
}

References DEGREES, FPT_HEIGHT, FPT_LAYER, FPT_ORIENTATION, FPT_TEXT, FPT_THICKNESS, FPT_WIDTH, FPT_XOFFSET, FPT_YOFFSET, EDA_BASE_FRAME::GetUserUnits(), m_frame, NormalizeAnglePos(), StringFromValue(), and text.

GetValueAsBool()

bool FP_TEXT_GRID_TABLE::GetValueAsBool ( int  aRow, int  aCol  )

override

Definition at line 236 of file fp_text_grid_table.cpp.

{
 FP_TEXT& text = this->at((size_t) aRow );

 switch( aCol )
 {
 case FPT_SHOWN: return text.IsVisible();
 case FPT_ITALIC: return text.IsItalic();
 case FPT_UPRIGHT: return text.IsKeepUpright();
 default:
 wxFAIL_MSG( wxString::Format( wxT( "column %d doesn't hold a bool value" ), aCol ) );
 return false;
 }
}

References Format(), FPT_ITALIC, FPT_SHOWN, FPT_UPRIGHT, and text.

GetValueAsLong()

long FP_TEXT_GRID_TABLE::GetValueAsLong ( int  aRow, int  aCol  )

override

Definition at line 252 of file fp_text_grid_table.cpp.

{
 FP_TEXT& text = this->at((size_t) aRow );

 switch( aCol )
 {
 case FPT_LAYER: return text.GetLayer();
 default:
 wxFAIL_MSG( wxString::Format( wxT( "column %d doesn't hold a long value" ), aCol ) );
 return 0;
 }
}

References Format(), FPT_LAYER, and text.

IsEmptyCell()

bool FP_TEXT_GRID_TABLE::IsEmptyCell ( int  row, int  col  )

inlineoverride

Definition at line 66 of file fp_text_grid_table.h.

 {
 return false; // don't allow adjacent cell overflow, even if we are actually empty
 }

onUnitsChanged()

void FP_TEXT_GRID_TABLE::onUnitsChanged ( wxCommandEvent &  aEvent )

protected

Definition at line 90 of file fp_text_grid_table.cpp.

{
 if( GetView() )
 GetView()->ForceRefresh();

 aEvent.Skip();
}

Referenced by FP_TEXT_GRID_TABLE(), and ~FP_TEXT_GRID_TABLE().

SetValue()

void FP_TEXT_GRID_TABLE::SetValue ( int  aRow, int  aCol, const wxString &  aValue  )

override

Definition at line 266 of file fp_text_grid_table.cpp.

{
 FP_TEXT& text = this->at((size_t) aRow );
 wxPoint pos;

 switch( aCol )
 {
 case FPT_TEXT:
 text.SetText( aValue );
 break;

 case FPT_WIDTH:
 text.SetTextWidth( ValueFromString( m_frame->GetUserUnits(), aValue ) );
 break;

 case FPT_HEIGHT:
 text.SetTextHeight( ValueFromString( m_frame->GetUserUnits(), aValue ) );
 break;

 case FPT_THICKNESS:text.SetTextThickness( ValueFromString( m_frame->GetUserUnits(), aValue ) );
 break;

 case FPT_ORIENTATION:
 text.SetTextAngle( DoubleValueFromString( EDA_UNITS::DEGREES, aValue ) );
 text.SetDrawCoord();
 break;

 case FPT_XOFFSET:
 case FPT_YOFFSET:
 pos = text.GetPos0();

 if( aCol == FPT_XOFFSET )
 pos.x = ValueFromString( m_frame->GetUserUnits(), aValue );
 else
 pos.y = ValueFromString( m_frame->GetUserUnits(), aValue );

 text.SetPos0( pos );
 text.SetDrawCoord();
 break;

 default:
 wxFAIL_MSG( wxString::Format( wxT( "column %d doesn't hold a string value" ), aCol ) );
 break;
 }

 GetView()->Refresh();
}

References DEGREES, DoubleValueFromString(), Format(), FPT_HEIGHT, FPT_ORIENTATION, FPT_TEXT, FPT_THICKNESS, FPT_WIDTH, FPT_XOFFSET, FPT_YOFFSET, EDA_BASE_FRAME::GetUserUnits(), m_frame, text, and ValueFromString().

SetValueAsBool()

void FP_TEXT_GRID_TABLE::SetValueAsBool ( int  aRow, int  aCol, bool  aValue  )

override

Definition at line 315 of file fp_text_grid_table.cpp.

{
 FP_TEXT& text = this->at((size_t) aRow );

 switch( aCol )
 {
 case FPT_SHOWN:
 text.SetVisible( aValue );
 break;

 case FPT_ITALIC:
 text.SetItalic( aValue );
 break;

 case FPT_UPRIGHT:text.SetKeepUpright( aValue );
 break;

 default:
 wxFAIL_MSG( wxString::Format( wxT( "column %d doesn't hold a bool value" ), aCol ) );
 break;
 }
}

References Format(), FPT_ITALIC, FPT_SHOWN, FPT_UPRIGHT, and text.

SetValueAsLong()

void FP_TEXT_GRID_TABLE::SetValueAsLong ( int  aRow, int  aCol, long  aValue  )

override

Definition at line 339 of file fp_text_grid_table.cpp.

{
 FP_TEXT& text = this->at((size_t) aRow );

 switch( aCol )
 {
 case FPT_LAYER:
 text.SetLayer( ToLAYER_ID( (int) aValue ) );
 text.SetMirrored( IsBackLayer( text.GetLayer() ) );
 break;

 default:
 wxFAIL_MSG( wxString::Format( wxT( "column %d doesn't hold a long value" ), aCol ) );
 break;
 }
}

References Format(), FPT_LAYER, IsBackLayer(), text, and ToLAYER_ID().

Member Data Documentation

m_boolColAttr

wxGridCellAttr* FP_TEXT_GRID_TABLE::m_boolColAttr

private

Definition at line 90 of file fp_text_grid_table.h.

Referenced by FP_TEXT_GRID_TABLE(), GetAttr(), and ~FP_TEXT_GRID_TABLE().

m_frame

PCB_BASE_FRAME* FP_TEXT_GRID_TABLE::m_frame

private

Definition at line 87 of file fp_text_grid_table.h.

Referenced by FP_TEXT_GRID_TABLE(), GetValue(), SetValue(), and ~FP_TEXT_GRID_TABLE().

m_layerColAttr

wxGridCellAttr* FP_TEXT_GRID_TABLE::m_layerColAttr

private

Definition at line 92 of file fp_text_grid_table.h.

Referenced by FP_TEXT_GRID_TABLE(), GetAttr(), and ~FP_TEXT_GRID_TABLE().

m_orientationColAttr

wxGridCellAttr* FP_TEXT_GRID_TABLE::m_orientationColAttr

private

Definition at line 91 of file fp_text_grid_table.h.

Referenced by FP_TEXT_GRID_TABLE(), GetAttr(), and ~FP_TEXT_GRID_TABLE().

m_readOnlyAttr

wxGridCellAttr* FP_TEXT_GRID_TABLE::m_readOnlyAttr

private

Definition at line 89 of file fp_text_grid_table.h.

Referenced by FP_TEXT_GRID_TABLE(), and ~FP_TEXT_GRID_TABLE().

---

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

• fp_text_grid_table.h
• fp_text_grid_table.cpp