KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
PCB_FIELDS_GRID_TABLE Class Reference

#include <pcb_fields_grid_table.h>

Inheritance diagram for PCB_FIELDS_GRID_TABLE:
WX_GRID_TABLE_BASE

Public Member Functions

 PCB_FIELDS_GRID_TABLE (PCB_BASE_FRAME *aFrame, DIALOG_SHIM *aDialog, std::vector< EMBEDDED_FILES * > aFilesStack)
 
 ~PCB_FIELDS_GRID_TABLE ()
 
int GetNumberRows () override
 
int GetNumberCols () override
 
int GetMandatoryRowCount () const
 
wxString GetColLabelValue (int aCol) 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 aRow, int aCol, wxGridCellAttr::wxAttrKind aKind) 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
 
bool DeleteRows (size_t aPos=0, size_t aNumRows=1) override
 
void SetColAttr (wxGridCellAttr *aAttr, int aCol) override
 
virtual bool HasRowLabelExpanders () const
 Show grouping controls in the row headers instead of row numbers.
 
virtual ROW_STATE GetRowState (int aRow) const
 
virtual bool HasUndoStateSerialization () const
 Optional identity-based serialization for the host dialog's Ctrl+Z/Ctrl+Y.
 
virtual wxString SerializeUndoState () const
 
virtual void RestoreUndoState (const wxString &aState)
 
void Clear () override
 

Public Attributes

T elements
 STL member.
 

Protected Member Functions

void onUnitsChanged (wxCommandEvent &aEvent)
 
wxGridCellAttr * enhanceAttr (wxGridCellAttr *aInputAttr, int aRow, int aCol, wxGridCellAttr::wxAttrKind aKind)
 

Protected Attributes

std::map< int, wxGridCellAttr * > m_colAttrs
 

Private Attributes

PCB_BASE_FRAME * m_frame
 
DIALOG_SHIM * m_dialog
 
FIELD_VALIDATOR m_fieldNameValidator
 
FIELD_VALIDATOR m_referenceValidator
 
FIELD_VALIDATOR m_valueValidator
 
FIELD_VALIDATOR m_urlValidator
 
FIELD_VALIDATOR m_nonUrlValidator
 
wxGridCellAttr * m_readOnlyAttr
 
wxGridCellAttr * m_fieldNameAttr
 
wxGridCellAttr * m_boolColAttr
 
wxGridCellAttr * m_orientationColAttr
 
wxGridCellAttr * m_layerColAttr
 
wxGridCellAttr * m_referenceAttr
 
wxGridCellAttr * m_valueAttr
 
wxGridCellAttr * m_urlAttr
 
std::unique_ptr< NUMERIC_EVALUATOR > m_eval
 
std::map< std::pair< int, int >, wxString > m_evalOriginal
 

Detailed Description

Definition at line 53 of file pcb_fields_grid_table.h.

Constructor & Destructor Documentation

◆ PCB_FIELDS_GRID_TABLE()

PCB_FIELDS_GRID_TABLE::PCB_FIELDS_GRID_TABLE ( PCB_BASE_FRAME * aFrame,
DIALOG_SHIM * aDialog,
std::vector< EMBEDDED_FILES * > aFilesStack )

Definition at line 46 of file pcb_fields_grid_table.cpp.

References DEGREES, g_menuOrientations, EDA_UNIT_UTILS::GetText(), m_boolColAttr, m_dialog, m_eval, m_fieldNameAttr, m_fieldNameValidator, m_frame, m_layerColAttr, m_nonUrlValidator, m_orientationColAttr, m_readOnlyAttr, m_referenceAttr, m_referenceValidator, m_urlAttr, m_urlValidator, m_valueAttr, m_valueValidator, onUnitsChanged(), REFERENCE, GRID_CELL_TEXT_EDITOR::SetValidator(), USER, and VALUE.

◆ ~PCB_FIELDS_GRID_TABLE()

PCB_FIELDS_GRID_TABLE::~PCB_FIELDS_GRID_TABLE ( )

Definition at line 107 of file pcb_fields_grid_table.cpp.

References m_boolColAttr, m_fieldNameAttr, m_frame, m_layerColAttr, m_orientationColAttr, m_readOnlyAttr, m_referenceAttr, m_urlAttr, m_valueAttr, and onUnitsChanged().

Member Function Documentation

◆ CanGetValueAs()

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

Definition at line 168 of file pcb_fields_grid_table.cpp.

References PFC_HEIGHT, PFC_ITALIC, PFC_KNOCKOUT, PFC_LAYER, PFC_MIRRORED, PFC_NAME, PFC_ORIENTATION, PFC_SHOWN, PFC_THICKNESS, PFC_UPRIGHT, PFC_VALUE, PFC_WIDTH, PFC_XOFFSET, and PFC_YOFFSET.

Referenced by CanSetValueAs().

◆ CanSetValueAs()

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

Definition at line 199 of file pcb_fields_grid_table.cpp.

References CanGetValueAs().

◆ Clear()

void WX_GRID_TABLE_BASE::Clear ( )
inlineoverrideinherited

Definition at line 122 of file wx_grid.h.

◆ DeleteRows()

bool PCB_FIELDS_GRID_TABLE::DeleteRows ( size_t aPos = 0,
size_t aNumRows = 1 )
override

Definition at line 451 of file pcb_fields_grid_table.cpp.

References m_evalOriginal.

◆ enhanceAttr()

wxGridCellAttr * WX_GRID_TABLE_BASE::enhanceAttr ( wxGridCellAttr * aInputAttr,
int aRow,
int aCol,
wxGridCellAttr::wxAttrKind aKind )
protectedinherited

Definition at line 43 of file wx_grid.cpp.

Referenced by FIELDS_GRID_TABLE::GetAttr(), LAYERS_GRID_TABLE::GetAttr(), LIB_TABLE_GRID_DATA_MODEL::GetAttr(), PCB_FIELDS_GRID_TABLE::GetAttr(), SCH_PIN_TABLE_DATA_MODEL::GetAttr(), and GetAttr().

◆ GetAttr()

wxGridCellAttr * PCB_FIELDS_GRID_TABLE::GetAttr ( int aRow,
int aCol,
wxGridCellAttr::wxAttrKind aKind )
override

Definition at line 205 of file pcb_fields_grid_table.cpp.

References DATASHEET, WX_GRID_TABLE_BASE::enhanceAttr(), PCB_FIELD::GetId(), PCB_FIELD::HasHypertext(), PCB_FIELD::IsMandatory(), m_boolColAttr, m_fieldNameAttr, m_layerColAttr, m_orientationColAttr, m_readOnlyAttr, m_referenceAttr, m_urlAttr, m_valueAttr, PFC_HEIGHT, PFC_ITALIC, PFC_KNOCKOUT, PFC_LAYER, PFC_MIRRORED, PFC_NAME, PFC_ORIENTATION, PFC_SHOWN, PFC_THICKNESS, PFC_UPRIGHT, PFC_VALUE, PFC_WIDTH, PFC_XOFFSET, PFC_YOFFSET, REFERENCE, and VALUE.

◆ GetColLabelValue()

wxString PCB_FIELDS_GRID_TABLE::GetColLabelValue ( int aCol)
override

Definition at line 145 of file pcb_fields_grid_table.cpp.

References _, PFC_HEIGHT, PFC_ITALIC, PFC_KNOCKOUT, PFC_LAYER, PFC_MIRRORED, PFC_NAME, PFC_ORIENTATION, PFC_SHOWN, PFC_THICKNESS, PFC_UPRIGHT, PFC_VALUE, PFC_WIDTH, PFC_XOFFSET, and PFC_YOFFSET.

◆ GetMandatoryRowCount()

int PCB_FIELDS_GRID_TABLE::GetMandatoryRowCount ( ) const

Definition at line 122 of file pcb_fields_grid_table.cpp.

References PCB_FIELD::IsMandatory().

◆ GetNumberCols()

int PCB_FIELDS_GRID_TABLE::GetNumberCols ( )
inlineoverride

Definition at line 61 of file pcb_fields_grid_table.h.

References PFC_COUNT.

◆ GetNumberRows()

int PCB_FIELDS_GRID_TABLE::GetNumberRows ( )
inlineoverride

Definition at line 60 of file pcb_fields_grid_table.h.

◆ GetRowState()

virtual ROW_STATE WX_GRID_TABLE_BASE::GetRowState ( int aRow) const
inlinevirtualinherited

Reimplemented in FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >, FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >, and FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >.

Definition at line 109 of file wx_grid.h.

References ROW_STATE::ROW_STATE.

Referenced by FIELDS_TABLE_DATA_MODEL_BASE::Export(), and DIALOG_FIELDS_TABLE::OnTableLabelClick().

◆ GetValue()

wxString PCB_FIELDS_GRID_TABLE::GetValue ( int aRow,
int aCol )
override

Definition at line 271 of file pcb_fields_grid_table.cpp.

References BOARD_ITEM::GetFPRelativePosition(), BOARD_ITEM::GetLayerName(), PCB_FIELD::GetName(), FOOTPRINT::GetOrientation(), BOARD_ITEM::GetParentFootprint(), EDA_TEXT::GetText(), PCB_TEXT::GetTextAngle(), EDA_TEXT::GetTextHeight(), PCB_TEXT::GetTextThickness(), EDA_TEXT::GetTextWidth(), grid, m_evalOriginal, m_frame, PFC_HEIGHT, PFC_LAYER, PFC_NAME, PFC_ORIENTATION, PFC_THICKNESS, PFC_VALUE, PFC_WIDTH, PFC_XOFFSET, PFC_YOFFSET, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ GetValueAsBool()

bool PCB_FIELDS_GRID_TABLE::GetValueAsBool ( int aRow,
int aCol )
override

Definition at line 311 of file pcb_fields_grid_table.cpp.

References EDA_TEXT::IsItalic(), EDA_TEXT::IsKeepUpright(), BOARD_ITEM::IsKnockout(), EDA_TEXT::IsMirrored(), EDA_TEXT::IsVisible(), PFC_ITALIC, PFC_KNOCKOUT, PFC_MIRRORED, PFC_SHOWN, and PFC_UPRIGHT.

◆ GetValueAsLong()

long PCB_FIELDS_GRID_TABLE::GetValueAsLong ( int aRow,
int aCol )
override

Definition at line 330 of file pcb_fields_grid_table.cpp.

References BOARD_ITEM::GetLayer(), and PFC_LAYER.

◆ HasRowLabelExpanders()

virtual bool WX_GRID_TABLE_BASE::HasRowLabelExpanders ( ) const
inlinevirtualinherited

Show grouping controls in the row headers instead of row numbers.

Reimplemented in FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 108 of file wx_grid.h.

◆ HasUndoStateSerialization()

virtual bool WX_GRID_TABLE_BASE::HasUndoStateSerialization ( ) const
inlinevirtualinherited

Optional identity-based serialization for the host dialog's Ctrl+Z/Ctrl+Y.

The dialog's generic grid undo snapshots cells by (row, col) position, which is wrong for tables whose rows can regroup/sort/reorder. A table that returns true here is asked to serialize and restore its own state by stable identity instead.

Reimplemented in FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 118 of file wx_grid.h.

◆ IsEmptyCell()

bool PCB_FIELDS_GRID_TABLE::IsEmptyCell ( int row,
int col )
inlineoverride

Definition at line 67 of file pcb_fields_grid_table.h.

◆ onUnitsChanged()

void PCB_FIELDS_GRID_TABLE::onUnitsChanged ( wxCommandEvent & aEvent)
protected

Definition at line 136 of file pcb_fields_grid_table.cpp.

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

◆ RestoreUndoState()

virtual void WX_GRID_TABLE_BASE::RestoreUndoState ( const wxString & aState)
inlinevirtualinherited

Reimplemented in FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 120 of file wx_grid.h.

◆ SerializeUndoState()

virtual wxString WX_GRID_TABLE_BASE::SerializeUndoState ( ) const
inlinevirtualinherited

Reimplemented in FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 119 of file wx_grid.h.

◆ SetColAttr()

void WX_GRID_TABLE_BASE::SetColAttr ( wxGridCellAttr * aAttr,
int aCol )
inlineoverrideinherited

Definition at line 90 of file wx_grid.h.

References m_colAttrs.

Referenced by DIALOG_FIELDS_TABLE::SetupColumnProperties().

◆ SetValue()

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

Definition at line 345 of file pcb_fields_grid_table.cpp.

References BOARD_ITEM::GetFPRelativePosition(), FOOTPRINT::GetOrientation(), BOARD_ITEM::GetParentFootprint(), m_dialog, m_eval, m_evalOriginal, m_frame, PFC_HEIGHT, PFC_NAME, PFC_ORIENTATION, PFC_THICKNESS, PFC_VALUE, PFC_WIDTH, PFC_XOFFSET, PFC_YOFFSET, BOARD_ITEM::SetFPRelativePosition(), PCB_FIELD::SetName(), EDA_TEXT::SetText(), PCB_TEXT::SetTextAngle(), EDA_TEXT::SetTextHeight(), PCB_TEXT::SetTextThickness(), EDA_TEXT::SetTextWidth(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ SetValueAsBool()

void PCB_FIELDS_GRID_TABLE::SetValueAsBool ( int aRow,
int aCol,
bool aValue )
override

Definition at line 404 of file pcb_fields_grid_table.cpp.

References m_dialog, PFC_ITALIC, PFC_KNOCKOUT, PFC_MIRRORED, PFC_SHOWN, PFC_UPRIGHT, BOARD_ITEM::SetIsKnockout(), EDA_TEXT::SetItalic(), EDA_TEXT::SetKeepUpright(), EDA_TEXT::SetMirrored(), and EDA_TEXT::SetVisible().

◆ SetValueAsLong()

void PCB_FIELDS_GRID_TABLE::SetValueAsLong ( int aRow,
int aCol,
long aValue )
override

Definition at line 425 of file pcb_fields_grid_table.cpp.

References BOARD_ITEM::GetBoard(), BOARD_ITEM::GetLayer(), IsBackLayer(), m_dialog, PFC_LAYER, BOARD_ITEM::SetLayer(), EDA_TEXT::SetMirrored(), and ToLAYER_ID().

Member Data Documentation

◆ elements

T std::vector< T >::elements
inherited

STL member.

◆ m_boolColAttr

wxGridCellAttr* PCB_FIELDS_GRID_TABLE::m_boolColAttr
private

Definition at line 101 of file pcb_fields_grid_table.h.

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

◆ m_colAttrs

std::map<int, wxGridCellAttr*> WX_GRID_TABLE_BASE::m_colAttrs
protectedinherited

Definition at line 133 of file wx_grid.h.

Referenced by FIELDS_TABLE_DATA_MODEL_BASE::cellUsesUrlEditor(), FIELDS_TABLE_DATA_MODEL_BASE::cloneUrlEditorAttr(), GetAttr(), SetColAttr(), and ~WX_GRID_TABLE_BASE().

◆ m_dialog

DIALOG_SHIM* PCB_FIELDS_GRID_TABLE::m_dialog
private

Definition at line 91 of file pcb_fields_grid_table.h.

Referenced by PCB_FIELDS_GRID_TABLE(), SetValue(), SetValueAsBool(), and SetValueAsLong().

◆ m_eval

std::unique_ptr<NUMERIC_EVALUATOR> PCB_FIELDS_GRID_TABLE::m_eval
private

Definition at line 108 of file pcb_fields_grid_table.h.

Referenced by PCB_FIELDS_GRID_TABLE(), and SetValue().

◆ m_evalOriginal

std::map< std::pair<int, int>, wxString > PCB_FIELDS_GRID_TABLE::m_evalOriginal
private

Definition at line 109 of file pcb_fields_grid_table.h.

Referenced by DeleteRows(), GetValue(), and SetValue().

◆ m_fieldNameAttr

wxGridCellAttr* PCB_FIELDS_GRID_TABLE::m_fieldNameAttr
private

Definition at line 100 of file pcb_fields_grid_table.h.

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

◆ m_fieldNameValidator

FIELD_VALIDATOR PCB_FIELDS_GRID_TABLE::m_fieldNameValidator
private

Definition at line 93 of file pcb_fields_grid_table.h.

Referenced by PCB_FIELDS_GRID_TABLE().

◆ m_frame

PCB_BASE_FRAME* PCB_FIELDS_GRID_TABLE::m_frame
private

Definition at line 90 of file pcb_fields_grid_table.h.

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

◆ m_layerColAttr

wxGridCellAttr* PCB_FIELDS_GRID_TABLE::m_layerColAttr
private

Definition at line 103 of file pcb_fields_grid_table.h.

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

◆ m_nonUrlValidator

FIELD_VALIDATOR PCB_FIELDS_GRID_TABLE::m_nonUrlValidator
private

Definition at line 97 of file pcb_fields_grid_table.h.

Referenced by PCB_FIELDS_GRID_TABLE().

◆ m_orientationColAttr

wxGridCellAttr* PCB_FIELDS_GRID_TABLE::m_orientationColAttr
private

Definition at line 102 of file pcb_fields_grid_table.h.

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

◆ m_readOnlyAttr

wxGridCellAttr* PCB_FIELDS_GRID_TABLE::m_readOnlyAttr
private

Definition at line 99 of file pcb_fields_grid_table.h.

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

◆ m_referenceAttr

wxGridCellAttr* PCB_FIELDS_GRID_TABLE::m_referenceAttr
private

Definition at line 104 of file pcb_fields_grid_table.h.

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

◆ m_referenceValidator

FIELD_VALIDATOR PCB_FIELDS_GRID_TABLE::m_referenceValidator
private

Definition at line 94 of file pcb_fields_grid_table.h.

Referenced by PCB_FIELDS_GRID_TABLE().

◆ m_urlAttr

wxGridCellAttr* PCB_FIELDS_GRID_TABLE::m_urlAttr
private

Definition at line 106 of file pcb_fields_grid_table.h.

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

◆ m_urlValidator

FIELD_VALIDATOR PCB_FIELDS_GRID_TABLE::m_urlValidator
private

Definition at line 96 of file pcb_fields_grid_table.h.

Referenced by PCB_FIELDS_GRID_TABLE().

◆ m_valueAttr

wxGridCellAttr* PCB_FIELDS_GRID_TABLE::m_valueAttr
private

Definition at line 105 of file pcb_fields_grid_table.h.

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

◆ m_valueValidator

FIELD_VALIDATOR PCB_FIELDS_GRID_TABLE::m_valueValidator
private

Definition at line 95 of file pcb_fields_grid_table.h.

Referenced by PCB_FIELDS_GRID_TABLE().

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