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

#include <fields_grid_table.h>

Inheritance diagram for FIELDS_GRID_TABLE:
WX_GRID_TABLE_BASE

Classes

struct  INHERITANCE
 

Public Member Functions

 FIELDS_GRID_TABLE (DIALOG_SHIM *aDialog, SCH_BASE_FRAME *aFrame, WX_GRID *aGrid, LIB_SYMBOL *aSymbol, std::vector< EMBEDDED_FILES * > aFilesStack)
 
 FIELDS_GRID_TABLE (DIALOG_SHIM *aDialog, SCH_EDIT_FRAME *aFrame, WX_GRID *aGrid, SCH_SYMBOL *aSymbol, std::vector< EMBEDDED_FILES * > aFilesStack)
 
 FIELDS_GRID_TABLE (DIALOG_SHIM *aDialog, SCH_EDIT_FRAME *aFrame, WX_GRID *aGrid, SCH_SHEET *aSheet)
 
 FIELDS_GRID_TABLE (DIALOG_SHIM *aDialog, SCH_EDIT_FRAME *aFrame, WX_GRID *aGrid, SCH_LABEL_BASE *aLabel)
 
 ~FIELDS_GRID_TABLE () override
 
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
 
void SetValue (int aRow, int aCol, const wxString &aValue) override
 
void SetValueAsBool (int aRow, int aCol, bool aValue) override
 
wxString StringFromBool (bool aValue) const
 
bool BoolFromString (const wxString &aValue) const
 
SCH_FIELD * GetField (FIELD_T aFieldId)
 
int GetFieldRow (FIELD_T aFieldId)
 
void AddInheritedField (const SCH_FIELD &aParent, const wxString &aSource)
 Append a row for an ancestor field the symbol does not define.
 
void SetFieldInherited (size_t aFieldIndex, const SCH_FIELD &aParent, const wxString &aSource)
 Record the ancestor field that aFieldIndex resolves against.
 
bool IsInherited (size_t aRow) const
 
const SCH_FIELD & ParentField (size_t aRow) const
 
const wxString & InheritedFrom (size_t aRow) const
 
void push_back (const SCH_FIELD &field)
 
void emplace_back (const SCH_FIELD &field)
 
bool EraseRow (size_t row)
 
void SwapRows (size_t a, size_t b)
 
void DetachFields ()
 
const std::vector< EMBEDDED_FILES * > & GetEmbeddedFilesStack () const
 
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 initGrid (WX_GRID *aGrid)
 
void onUnitsChanged (wxCommandEvent &aEvent)
 
bool privateFieldsAreHidden () const
 
int getFieldIndex (int aRow) const
 
int getColumnCount () const
 
int getVisibleRowCount () const
 
SCH_FIELD & getField (int aRow)
 
wxGridCellAttr * enhanceAttr (wxGridCellAttr *aInputAttr, int aRow, int aCol, wxGridCellAttr::wxAttrKind aKind)
 

Protected Attributes

std::map< int, wxGridCellAttr * > m_colAttrs
 

Private Attributes

SCH_BASE_FRAME * m_frame
 
DIALOG_SHIM * m_dialog
 
KICAD_T m_parentType
 
std::unique_ptr< LIB_SYMBOL > m_ownedPart
 
LIB_SYMBOL * m_part
 
std::vector< EMBEDDED_FILES * > m_filesStack
 
wxString m_symbolNetlist
 
wxString m_curdir
 
FIELD_VALIDATOR m_fieldNameValidator
 
FIELD_VALIDATOR m_referenceValidator
 
FIELD_VALIDATOR m_valueValidator
 
FIELD_VALIDATOR m_urlValidator
 
FIELD_VALIDATOR m_nonUrlValidator
 
FIELD_VALIDATOR m_filepathValidator
 
wxGridCellAttr * m_readOnlyAttr
 
wxGridCellAttr * m_fieldNameAttr
 
wxGridCellAttr * m_referenceAttr
 
wxGridCellAttr * m_valueAttr
 
wxGridCellAttr * m_footprintAttr
 
wxGridCellAttr * m_urlAttr
 
wxGridCellAttr * m_nonUrlAttr
 
wxGridCellAttr * m_filepathAttr
 
wxGridCellAttr * m_boolAttr
 
wxGridCellAttr * m_vAlignAttr
 
wxGridCellAttr * m_hAlignAttr
 
wxGridCellAttr * m_orientationAttr
 
wxGridCellAttr * m_netclassAttr
 
wxGridCellAttr * m_fontAttr
 
wxGridCellAttr * m_colorAttr
 
std::vector< INHERITANCE > m_inheritance
 
std::unique_ptr< NUMERIC_EVALUATOR > m_eval
 
std::map< std::pair< int, int >, wxString > m_evalOriginal
 

Detailed Description

Definition at line 88 of file fields_grid_table.h.

Constructor & Destructor Documentation

◆ FIELDS_GRID_TABLE() [1/4]

FIELDS_GRID_TABLE::FIELDS_GRID_TABLE ( DIALOG_SHIM * aDialog,
SCH_BASE_FRAME * aFrame,
WX_GRID * aGrid,
LIB_SYMBOL * aSymbol,
std::vector< EMBEDDED_FILES * > aFilesStack )

Definition at line 130 of file fields_grid_table.cpp.

References BuildFootprintChooserSymbolNetlist(), initGrid(), LIB_SYMBOL_T, m_dialog, m_fieldNameValidator, m_filepathValidator, m_filesStack, m_frame, m_nonUrlValidator, m_parentType, m_part, m_referenceValidator, m_symbolNetlist, m_urlValidator, m_valueValidator, REFERENCE, SHEET_FILENAME, USER, and VALUE.

◆ FIELDS_GRID_TABLE() [2/4]

FIELDS_GRID_TABLE::FIELDS_GRID_TABLE ( DIALOG_SHIM * aDialog,
SCH_EDIT_FRAME * aFrame,
WX_GRID * aGrid,
SCH_SYMBOL * aSymbol,
std::vector< EMBEDDED_FILES * > aFilesStack )

Definition at line 149 of file fields_grid_table.cpp.

References BuildFootprintChooserSymbolNetlist(), SCH_SYMBOL::GetLibSymbolRef(), initGrid(), m_dialog, m_fieldNameValidator, m_filepathValidator, m_filesStack, m_frame, m_nonUrlValidator, m_parentType, m_part, m_referenceValidator, m_symbolNetlist, m_urlValidator, m_valueValidator, REFERENCE, SCH_SYMBOL_T, SCH_ITEM::Schematic(), SHEET_FILENAME, USER, and VALUE.

◆ FIELDS_GRID_TABLE() [3/4]

FIELDS_GRID_TABLE::FIELDS_GRID_TABLE ( DIALOG_SHIM * aDialog,
SCH_EDIT_FRAME * aFrame,
WX_GRID * aGrid,
SCH_SHEET * aSheet )

Definition at line 183 of file fields_grid_table.cpp.

References initGrid(), m_dialog, m_fieldNameValidator, m_filepathValidator, m_filesStack, m_frame, m_nonUrlValidator, m_parentType, m_part, m_referenceValidator, m_urlValidator, m_valueValidator, SCH_SHEET_T, SCH_ITEM::Schematic(), SHEET_FILENAME, SHEET_NAME, USER, and VALUE.

◆ FIELDS_GRID_TABLE() [4/4]

FIELDS_GRID_TABLE::FIELDS_GRID_TABLE ( DIALOG_SHIM * aDialog,
SCH_EDIT_FRAME * aFrame,
WX_GRID * aGrid,
SCH_LABEL_BASE * aLabel )

Definition at line 202 of file fields_grid_table.cpp.

References initGrid(), m_dialog, m_fieldNameValidator, m_filepathValidator, m_filesStack, m_frame, m_nonUrlValidator, m_parentType, m_part, m_referenceValidator, m_urlValidator, m_valueValidator, SCH_LABEL_LOCATE_ANY_T, SCH_ITEM::Schematic(), and USER.

◆ ~FIELDS_GRID_TABLE()

FIELDS_GRID_TABLE::~FIELDS_GRID_TABLE ( )
override

Definition at line 406 of file fields_grid_table.cpp.

References m_boolAttr, m_colorAttr, m_fieldNameAttr, m_filepathAttr, m_fontAttr, m_footprintAttr, m_frame, m_hAlignAttr, m_inheritance, m_netclassAttr, m_nonUrlAttr, m_orientationAttr, m_readOnlyAttr, m_referenceAttr, m_urlAttr, m_vAlignAttr, m_valueAttr, and onUnitsChanged().

Member Function Documentation

◆ AddInheritedField()

void FIELDS_GRID_TABLE::AddInheritedField ( const SCH_FIELD & aParent,
const wxString & aSource )

Append a row for an ancestor field the symbol does not define.

Definition at line 1154 of file fields_grid_table.cpp.

References m_inheritance, m_part, push_back(), and SetFieldInherited().

◆ BoolFromString()

bool FIELDS_GRID_TABLE::BoolFromString ( const wxString & aValue) const

Definition at line 1080 of file fields_grid_table.cpp.

Referenced by SetValue().

◆ CanGetValueAs()

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

Definition at line 535 of file fields_grid_table.cpp.

References FDC_ALLOW_AUTOPLACE, FDC_BOLD, FDC_COLOR, FDC_FONT, FDC_H_ALIGN, FDC_ITALIC, FDC_NAME, FDC_ORIENTATION, FDC_POSX, FDC_POSY, FDC_PRIVATE, FDC_SHOW_NAME, FDC_SHOWN, FDC_TEXT_SIZE, FDC_V_ALIGN, and FDC_VALUE.

Referenced by CanSetValueAs().

◆ CanSetValueAs()

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

Definition at line 566 of file fields_grid_table.cpp.

References CanGetValueAs().

◆ Clear()

void WX_GRID_TABLE_BASE::Clear ( )
inlineoverrideinherited

Definition at line 122 of file wx_grid.h.

◆ DetachFields()

void FIELDS_GRID_TABLE::DetachFields ( )

Definition at line 1225 of file fields_grid_table.cpp.

References m_inheritance, and EDA_ITEM::SetParent().

Referenced by SCH_DRAWING_TOOLS::createNewLabel().

◆ emplace_back()

void FIELDS_GRID_TABLE::emplace_back ( const SCH_FIELD & field)
inline

Definition at line 155 of file fields_grid_table.h.

References push_back().

◆ 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().

◆ EraseRow()

bool FIELDS_GRID_TABLE::EraseRow ( size_t row)

Definition at line 1184 of file fields_grid_table.cpp.

References getFieldIndex(), FIELDS_GRID_TABLE::INHERITANCE::m_derived, FIELDS_GRID_TABLE::INHERITANCE::m_hasParent, m_inheritance, and FIELDS_GRID_TABLE::INHERITANCE::m_parentField.

◆ GetAttr()

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

Definition at line 572 of file fields_grid_table.cpp.

References DATASHEET, WX_GRID_TABLE_BASE::enhanceAttr(), FDC_ALLOW_AUTOPLACE, FDC_BOLD, FDC_COLOR, FDC_FONT, FDC_H_ALIGN, FDC_ITALIC, FDC_NAME, FDC_ORIENTATION, FDC_POSX, FDC_POSY, FDC_PRIVATE, FDC_SHOW_NAME, FDC_SHOWN, FDC_TEXT_SIZE, FDC_V_ALIGN, FDC_VALUE, FOOTPRINT, getField(), SCH_FIELD::GetId(), GetNumberRows(), SCH_FIELD::GetUntranslatedName(), GetValue(), SCH_FIELD::HasHypertext(), IsInherited(), SCH_FIELD::IsMandatory(), m_boolAttr, m_colorAttr, m_fieldNameAttr, m_filepathAttr, m_fontAttr, m_footprintAttr, m_frame, m_hAlignAttr, m_netclassAttr, m_nonUrlAttr, m_orientationAttr, m_parentType, m_part, m_readOnlyAttr, m_referenceAttr, TEMPLATE_FIELDNAME::m_URL, m_urlAttr, m_vAlignAttr, m_valueAttr, REFERENCE, SCH_LABEL_LOCATE_ANY_T, SHEET_FILENAME, SHEET_NAME, and VALUE.

◆ GetColLabelValue()

wxString FIELDS_GRID_TABLE::GetColLabelValue ( int aCol)
override

Definition at line 510 of file fields_grid_table.cpp.

References _, FDC_ALLOW_AUTOPLACE, FDC_BOLD, FDC_COLOR, FDC_FONT, FDC_H_ALIGN, FDC_ITALIC, FDC_NAME, FDC_ORIENTATION, FDC_POSX, FDC_POSY, FDC_PRIVATE, FDC_SHOW_NAME, FDC_SHOWN, FDC_TEXT_SIZE, FDC_V_ALIGN, and FDC_VALUE.

◆ getColumnCount()

int FIELDS_GRID_TABLE::getColumnCount ( ) const
protected

Definition at line 440 of file fields_grid_table.cpp.

References FDC_SCH_EDIT_COUNT, FDC_SYMBOL_EDITOR_COUNT, FRAME_SCH, FRAME_SCH_VIEWER, and m_frame.

Referenced by GetNumberCols().

◆ GetEmbeddedFilesStack()

const std::vector< EMBEDDED_FILES * > & FIELDS_GRID_TABLE::GetEmbeddedFilesStack ( ) const
inline

Definition at line 162 of file fields_grid_table.h.

References m_filesStack.

◆ GetField()

SCH_FIELD * FIELDS_GRID_TABLE::GetField ( FIELD_T aFieldId)

Definition at line 1099 of file fields_grid_table.cpp.

References SCH_FIELD::GetId().

Referenced by initGrid(), and positioningChanged().

◆ getField()

SCH_FIELD & FIELDS_GRID_TABLE::getField ( int aRow)
protected

Definition at line 504 of file fields_grid_table.cpp.

References getFieldIndex().

Referenced by GetAttr(), GetValue(), GetValueAsBool(), SetValue(), and SetValueAsBool().

◆ getFieldIndex()

int FIELDS_GRID_TABLE::getFieldIndex ( int aRow) const
protected

Definition at line 460 of file fields_grid_table.cpp.

References getVisibleRowCount(), and privateFieldsAreHidden().

Referenced by EraseRow(), getField(), InheritedFrom(), IsInherited(), ParentField(), and SwapRows().

◆ GetFieldRow()

int FIELDS_GRID_TABLE::GetFieldRow ( FIELD_T aFieldId)

Definition at line 1111 of file fields_grid_table.cpp.

References SCH_FIELD::GetId(), SCH_ITEM::IsPrivate(), and privateFieldsAreHidden().

Referenced by FIELDS_GRID_TRICKS::getFieldRow().

◆ GetMandatoryRowCount()

int FIELDS_GRID_TABLE::GetMandatoryRowCount ( ) const

Definition at line 221 of file fields_grid_table.cpp.

References SCH_FIELD::IsMandatory(), SCH_ITEM::IsPrivate(), and privateFieldsAreHidden().

◆ GetNumberCols()

int FIELDS_GRID_TABLE::GetNumberCols ( )
inlineoverride

Definition at line 102 of file fields_grid_table.h.

References getColumnCount().

◆ GetNumberRows()

int FIELDS_GRID_TABLE::GetNumberRows ( )
inlineoverride

Definition at line 101 of file fields_grid_table.h.

References getVisibleRowCount().

Referenced by GetAttr(), GetValue(), GetValueAsBool(), SetValue(), and SetValueAsBool().

◆ 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 FIELDS_GRID_TABLE::GetValue ( int aRow,
int aCol )
override

Definition at line 738 of file fields_grid_table.cpp.

References _, SCH_FIELD::CanAutoplace(), CTX_LINE, DEFAULT_FONT_NAME, EscapeString(), FDC_ALLOW_AUTOPLACE, FDC_BOLD, FDC_COLOR, FDC_FONT, FDC_H_ALIGN, FDC_ITALIC, FDC_NAME, FDC_ORIENTATION, FDC_POSX, FDC_POSY, FDC_PRIVATE, FDC_SHOW_NAME, FDC_SHOWN, FDC_TEXT_SIZE, FDC_V_ALIGN, FDC_VALUE, GetDefaultFieldName(), SCH_LABEL_BASE::GetDefaultFieldName(), SCH_FIELD::GetEffectiveHorizJustify(), SCH_FIELD::GetEffectiveVertJustify(), getField(), EDA_TEXT::GetFont(), SCH_FIELD::GetId(), KIFONT::FONT::GetName(), SCH_FIELD::GetName(), GetNumberRows(), SCH_FIELD::GetText(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextColor(), EDA_TEXT::GetTextHeight(), EDA_TEXT::GetTextPos(), SCH_FIELD::GetUntranslatedName(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_INDETERMINATE, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_INDETERMINATE, GR_TEXT_V_ALIGN_TOP, grid, INDETERMINATE_STATE, EDA_TEXT::IsBold(), EDA_ANGLE::IsHorizontal(), EDA_TEXT::IsItalic(), SCH_FIELD::IsMandatory(), SCH_FIELD::IsNameShown(), SCH_ITEM::IsPrivate(), EDA_TEXT::IsVisible(), m_evalOriginal, m_frame, m_parentType, SCH_LABEL_LOCATE_ANY_T, StringFromBool(), KIGFX::COLOR4D::ToCSSString(), TRANSLATED, UnescapeString(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by GetAttr().

◆ GetValueAsBool()

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

Definition at line 848 of file fields_grid_table.cpp.

References SCH_FIELD::CanAutoplace(), FDC_ALLOW_AUTOPLACE, FDC_BOLD, FDC_ITALIC, FDC_PRIVATE, FDC_SHOW_NAME, FDC_SHOWN, getField(), GetNumberRows(), EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), SCH_FIELD::IsNameShown(), SCH_ITEM::IsPrivate(), and EDA_TEXT::IsVisible().

◆ getVisibleRowCount()

int FIELDS_GRID_TABLE::getVisibleRowCount ( ) const
protected

Definition at line 485 of file fields_grid_table.cpp.

References SCH_ITEM::IsPrivate(), and privateFieldsAreHidden().

Referenced by getFieldIndex(), and GetNumberRows().

◆ 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.

◆ InheritedFrom()

const wxString & FIELDS_GRID_TABLE::InheritedFrom ( size_t aRow) const
Returns
the name of the ancestor symbol the row inherits from.

Definition at line 1148 of file fields_grid_table.cpp.

References getFieldIndex(), and m_inheritance.

◆ initGrid()

void FIELDS_GRID_TABLE::initGrid ( WX_GRID * aGrid)
protected

Definition at line 243 of file fields_grid_table.cpp.

References _, AddFileExtListToFilter(), DEFAULT_FONT_NAME, FDC_VALUE, Fontconfig(), fonts, GetField(), PROJECT::GetProjectFile(), KICAD_FONT_NAME, FILEEXT::KiCadSchematicFileExtension, LIB_SYMBOL_T, m_boolAttr, m_colorAttr, m_curdir, m_dialog, m_eval, m_fieldNameAttr, m_fieldNameValidator, m_filepathAttr, m_filepathValidator, m_filesStack, m_fontAttr, m_footprintAttr, m_frame, m_hAlignAttr, m_netclassAttr, m_nonUrlAttr, m_nonUrlValidator, m_orientationAttr, m_parentType, m_part, m_readOnlyAttr, m_referenceAttr, m_referenceValidator, m_symbolNetlist, m_urlAttr, m_urlValidator, m_vAlignAttr, m_valueAttr, m_valueValidator, name, PROJECT_FILE::NetSettings(), SCH_FIELD::OnScintillaCharAdded(), onUnitsChanged(), Pgm(), KIWAY_HOLDER::Prj(), PROJECT_SCH::SchSearchS(), WX_GRID::SetupColumnAutosizer(), GRID_CELL_TEXT_EDITOR::SetValidator(), and VALUE.

Referenced by FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), and FIELDS_GRID_TABLE().

◆ IsEmptyCell()

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

Definition at line 108 of file fields_grid_table.h.

◆ IsInherited()

bool FIELDS_GRID_TABLE::IsInherited ( size_t aRow) const
Returns
true if the row still shows its ancestor's value rather than an override.

Definition at line 1128 of file fields_grid_table.cpp.

References getFieldIndex(), FIELDS_GRID_TABLE::INHERITANCE::m_derived, m_inheritance, and FIELDS_GRID_TABLE::INHERITANCE::m_parentField.

Referenced by GetAttr().

◆ onUnitsChanged()

void FIELDS_GRID_TABLE::onUnitsChanged ( wxCommandEvent & aEvent)
protected

Definition at line 431 of file fields_grid_table.cpp.

Referenced by initGrid(), and ~FIELDS_GRID_TABLE().

◆ ParentField()

const SCH_FIELD & FIELDS_GRID_TABLE::ParentField ( size_t aRow) const

Definition at line 1142 of file fields_grid_table.cpp.

References getFieldIndex(), and m_inheritance.

◆ privateFieldsAreHidden()

bool FIELDS_GRID_TABLE::privateFieldsAreHidden ( ) const
protected

Definition at line 454 of file fields_grid_table.cpp.

References FRAME_SCH, FRAME_SCH_VIEWER, and m_frame.

Referenced by getFieldIndex(), GetFieldRow(), GetMandatoryRowCount(), and getVisibleRowCount().

◆ push_back()

void FIELDS_GRID_TABLE::push_back ( const SCH_FIELD & field)

Definition at line 235 of file fields_grid_table.cpp.

References m_inheritance.

Referenced by AddInheritedField(), and emplace_back().

◆ 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().

◆ SetFieldInherited()

void FIELDS_GRID_TABLE::SetFieldInherited ( size_t aFieldIndex,
const SCH_FIELD & aParent,
const wxString & aSource )

Record the ancestor field that aFieldIndex resolves against.

A field the symbol does not override (an empty mandatory field or a row already showing an ancestor's value) takes on the ancestor's content so the grid shows what the symbol resolves to.

Definition at line 1163 of file fields_grid_table.cpp.

References SCH_FIELD::GetText(), SCH_FIELD::IsMandatory(), FIELDS_GRID_TABLE::INHERITANCE::m_derived, FIELDS_GRID_TABLE::INHERITANCE::m_hasParent, m_inheritance, FIELDS_GRID_TABLE::INHERITANCE::m_parentField, FIELDS_GRID_TABLE::INHERITANCE::m_source, and EDA_ITEM::SetParent().

Referenced by AddInheritedField().

◆ SetValue()

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

Definition at line 868 of file fields_grid_table.cpp.

References _, ANGLE_HORIZONTAL, ANGLE_VERTICAL, BoolFromString(), ConvertPathToFileUri(), CTX_LIBID, DEFAULT_FONT_NAME, EnsureFileExtension(), EscapeString(), FDC_ALLOW_AUTOPLACE, FDC_BOLD, FDC_COLOR, FDC_FONT, FDC_H_ALIGN, FDC_ITALIC, FDC_NAME, FDC_ORIENTATION, FDC_POSX, FDC_POSY, FDC_PRIVATE, FDC_SHOW_NAME, FDC_SHOWN, FDC_TEXT_SIZE, FDC_V_ALIGN, FDC_VALUE, getField(), KIFONT::FONT::GetFont(), SCH_FIELD::GetId(), GetNumberRows(), EDA_TEXT::GetTextPos(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_TOP, EDA_TEXT::IsBold(), SCH_FIELD::IsHorizJustifyFlipped(), EDA_TEXT::IsItalic(), SCH_FIELD::IsVertJustifyFlipped(), KICAD_FONT_NAME, FILEEXT::KiCadSchematicFileExtension, LIB_SYMBOL_T, m_dialog, m_eval, m_evalOriginal, m_frame, m_parentType, EDA_TEXT::MapHorizJustify(), EDA_TEXT::MapVertJustify(), SCH_SHEET_T, EDA_TEXT::SetBold(), SCH_FIELD::SetCanAutoplace(), EDA_TEXT::SetFont(), EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetItalic(), SCH_FIELD::SetName(), SCH_FIELD::SetNameShown(), SCH_ITEM::SetPrivate(), SCH_FIELD::SetText(), EDA_TEXT::SetTextAngle(), EDA_TEXT::SetTextColor(), EDA_TEXT::SetTextPos(), EDA_TEXT::SetTextSize(), EDA_TEXT::SetVertJustify(), EDA_TEXT::SetVisible(), SHEET_FILENAME, UnescapeString(), VALUE, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ SetValueAsBool()

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

Definition at line 1031 of file fields_grid_table.cpp.

References FDC_ALLOW_AUTOPLACE, FDC_BOLD, FDC_ITALIC, FDC_PRIVATE, FDC_SHOW_NAME, FDC_SHOWN, getField(), GetNumberRows(), m_dialog, EDA_TEXT::SetBold(), SCH_FIELD::SetCanAutoplace(), EDA_TEXT::SetItalic(), SCH_FIELD::SetNameShown(), SCH_ITEM::SetPrivate(), and EDA_TEXT::SetVisible().

◆ StringFromBool()

wxString FIELDS_GRID_TABLE::StringFromBool ( bool aValue) const

Definition at line 1071 of file fields_grid_table.cpp.

Referenced by GetValue().

◆ SwapRows()

void FIELDS_GRID_TABLE::SwapRows ( size_t a,
size_t b )

Definition at line 1210 of file fields_grid_table.cpp.

References getFieldIndex(), and m_inheritance.

Member Data Documentation

◆ elements

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

STL member.

◆ m_boolAttr

wxGridCellAttr* FIELDS_GRID_TABLE::m_boolAttr
private

Definition at line 205 of file fields_grid_table.h.

Referenced by GetAttr(), initGrid(), and ~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_colorAttr

wxGridCellAttr* FIELDS_GRID_TABLE::m_colorAttr
private

Definition at line 211 of file fields_grid_table.h.

Referenced by GetAttr(), initGrid(), and ~FIELDS_GRID_TABLE().

◆ m_curdir

wxString FIELDS_GRID_TABLE::m_curdir
private

Definition at line 188 of file fields_grid_table.h.

Referenced by initGrid().

◆ m_dialog

DIALOG_SHIM* FIELDS_GRID_TABLE::m_dialog
private

Definition at line 178 of file fields_grid_table.h.

Referenced by FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), initGrid(), SetValue(), and SetValueAsBool().

◆ m_eval

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

Definition at line 223 of file fields_grid_table.h.

Referenced by initGrid(), and SetValue().

◆ m_evalOriginal

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

Definition at line 224 of file fields_grid_table.h.

Referenced by GetValue(), and SetValue().

◆ m_fieldNameAttr

wxGridCellAttr* FIELDS_GRID_TABLE::m_fieldNameAttr
private

Definition at line 198 of file fields_grid_table.h.

Referenced by GetAttr(), initGrid(), and ~FIELDS_GRID_TABLE().

◆ m_fieldNameValidator

FIELD_VALIDATOR FIELDS_GRID_TABLE::m_fieldNameValidator
private

Definition at line 190 of file fields_grid_table.h.

Referenced by FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), and initGrid().

◆ m_filepathAttr

wxGridCellAttr* FIELDS_GRID_TABLE::m_filepathAttr
private

Definition at line 204 of file fields_grid_table.h.

Referenced by GetAttr(), initGrid(), and ~FIELDS_GRID_TABLE().

◆ m_filepathValidator

FIELD_VALIDATOR FIELDS_GRID_TABLE::m_filepathValidator
private

Definition at line 195 of file fields_grid_table.h.

Referenced by FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), and initGrid().

◆ m_filesStack

std::vector<EMBEDDED_FILES*> FIELDS_GRID_TABLE::m_filesStack
private

Definition at line 186 of file fields_grid_table.h.

Referenced by FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), GetEmbeddedFilesStack(), and initGrid().

◆ m_fontAttr

wxGridCellAttr* FIELDS_GRID_TABLE::m_fontAttr
private

Definition at line 210 of file fields_grid_table.h.

Referenced by GetAttr(), initGrid(), and ~FIELDS_GRID_TABLE().

◆ m_footprintAttr

wxGridCellAttr* FIELDS_GRID_TABLE::m_footprintAttr
private

Definition at line 201 of file fields_grid_table.h.

Referenced by GetAttr(), initGrid(), and ~FIELDS_GRID_TABLE().

◆ m_frame

SCH_BASE_FRAME* FIELDS_GRID_TABLE::m_frame
private

Definition at line 177 of file fields_grid_table.h.

Referenced by FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), GetAttr(), getColumnCount(), GetValue(), initGrid(), privateFieldsAreHidden(), SetValue(), and ~FIELDS_GRID_TABLE().

◆ m_hAlignAttr

wxGridCellAttr* FIELDS_GRID_TABLE::m_hAlignAttr
private

Definition at line 207 of file fields_grid_table.h.

Referenced by GetAttr(), initGrid(), and ~FIELDS_GRID_TABLE().

◆ m_inheritance

std::vector<INHERITANCE> FIELDS_GRID_TABLE::m_inheritance
private

Definition at line 221 of file fields_grid_table.h.

Referenced by AddInheritedField(), DetachFields(), EraseRow(), InheritedFrom(), IsInherited(), ParentField(), push_back(), SetFieldInherited(), SwapRows(), and ~FIELDS_GRID_TABLE().

◆ m_netclassAttr

wxGridCellAttr* FIELDS_GRID_TABLE::m_netclassAttr
private

Definition at line 209 of file fields_grid_table.h.

Referenced by GetAttr(), initGrid(), and ~FIELDS_GRID_TABLE().

◆ m_nonUrlAttr

wxGridCellAttr* FIELDS_GRID_TABLE::m_nonUrlAttr
private

Definition at line 203 of file fields_grid_table.h.

Referenced by GetAttr(), initGrid(), and ~FIELDS_GRID_TABLE().

◆ m_nonUrlValidator

FIELD_VALIDATOR FIELDS_GRID_TABLE::m_nonUrlValidator
private

Definition at line 194 of file fields_grid_table.h.

Referenced by FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), and initGrid().

◆ m_orientationAttr

wxGridCellAttr* FIELDS_GRID_TABLE::m_orientationAttr
private

Definition at line 208 of file fields_grid_table.h.

Referenced by GetAttr(), initGrid(), and ~FIELDS_GRID_TABLE().

◆ m_ownedPart

std::unique_ptr<LIB_SYMBOL> FIELDS_GRID_TABLE::m_ownedPart
private

Definition at line 184 of file fields_grid_table.h.

◆ m_parentType

KICAD_T FIELDS_GRID_TABLE::m_parentType
private

Definition at line 179 of file fields_grid_table.h.

Referenced by FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), GetAttr(), GetValue(), initGrid(), and SetValue().

◆ m_part

LIB_SYMBOL* FIELDS_GRID_TABLE::m_part
private

Definition at line 185 of file fields_grid_table.h.

Referenced by AddInheritedField(), FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), GetAttr(), and initGrid().

◆ m_readOnlyAttr

wxGridCellAttr* FIELDS_GRID_TABLE::m_readOnlyAttr
private

Definition at line 197 of file fields_grid_table.h.

Referenced by GetAttr(), initGrid(), and ~FIELDS_GRID_TABLE().

◆ m_referenceAttr

wxGridCellAttr* FIELDS_GRID_TABLE::m_referenceAttr
private

Definition at line 199 of file fields_grid_table.h.

Referenced by GetAttr(), initGrid(), and ~FIELDS_GRID_TABLE().

◆ m_referenceValidator

FIELD_VALIDATOR FIELDS_GRID_TABLE::m_referenceValidator
private

Definition at line 191 of file fields_grid_table.h.

Referenced by FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), and initGrid().

◆ m_symbolNetlist

wxString FIELDS_GRID_TABLE::m_symbolNetlist
private

Definition at line 187 of file fields_grid_table.h.

Referenced by FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), and initGrid().

◆ m_urlAttr

wxGridCellAttr* FIELDS_GRID_TABLE::m_urlAttr
private

Definition at line 202 of file fields_grid_table.h.

Referenced by GetAttr(), initGrid(), and ~FIELDS_GRID_TABLE().

◆ m_urlValidator

FIELD_VALIDATOR FIELDS_GRID_TABLE::m_urlValidator
private

Definition at line 193 of file fields_grid_table.h.

Referenced by FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), and initGrid().

◆ m_vAlignAttr

wxGridCellAttr* FIELDS_GRID_TABLE::m_vAlignAttr
private

Definition at line 206 of file fields_grid_table.h.

Referenced by GetAttr(), initGrid(), and ~FIELDS_GRID_TABLE().

◆ m_valueAttr

wxGridCellAttr* FIELDS_GRID_TABLE::m_valueAttr
private

Definition at line 200 of file fields_grid_table.h.

Referenced by GetAttr(), initGrid(), and ~FIELDS_GRID_TABLE().

◆ m_valueValidator

FIELD_VALIDATOR FIELDS_GRID_TABLE::m_valueValidator
private

Definition at line 192 of file fields_grid_table.h.

Referenced by FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE(), and initGrid().

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