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

#include <wx_grid.h>

Inheritance diagram for WX_GRID_TABLE_BASE:
ALT_PIN_DATA_MODEL FIELDS_GRID_TABLE FIELDS_TABLE_DATA_MODEL_BASE LAYERS_GRID_TABLE LAYER_PROPERTIES_GRID_TABLE LIB_TABLE_GRID_DATA_MODEL PCB_FIELDS_GRID_TABLE PIN_TABLE_DATA_MODEL SCH_PIN_TABLE_DATA_MODEL VIEW_CONTROLS_GRID_DATA_MODEL

Public Member Functions

 ~WX_GRID_TABLE_BASE () override
 
void SetColAttr (wxGridCellAttr *aAttr, int aCol) override
 
wxGridCellAttr * GetAttr (int aRow, int aCol, wxGridCellAttr::wxAttrKind aKind) override
 
virtual bool IsExpanderColumn (int aCol) const
 
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
 

Protected Member Functions

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

Protected Attributes

std::map< int, wxGridCellAttr * > m_colAttrs
 

Detailed Description

Definition at line 57 of file wx_grid.h.

Constructor & Destructor Documentation

◆ ~WX_GRID_TABLE_BASE()

WX_GRID_TABLE_BASE::~WX_GRID_TABLE_BASE ( )
inlineoverride

Definition at line 60 of file wx_grid.h.

References m_colAttrs.

Member Function Documentation

◆ Clear()

void WX_GRID_TABLE_BASE::Clear ( )
inlineoverride

Definition at line 97 of file wx_grid.h.

◆ enhanceAttr()

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

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 * WX_GRID_TABLE_BASE::GetAttr ( int aRow,
int aCol,
wxGridCellAttr::wxAttrKind aKind )
inlineoverride

Definition at line 72 of file wx_grid.h.

References enhanceAttr(), and m_colAttrs.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr(), and SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr().

◆ GetRowState()

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

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 84 of file wx_grid.h.

References ROW_STATE::ROW_STATE.

Referenced by FIELDS_TABLE_DATA_MODEL_BASE::Export().

◆ HasUndoStateSerialization()

virtual bool WX_GRID_TABLE_BASE::HasUndoStateSerialization ( ) const
inlinevirtual

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 93 of file wx_grid.h.

◆ IsExpanderColumn()

virtual bool WX_GRID_TABLE_BASE::IsExpanderColumn ( int aCol) const
inlinevirtual

Reimplemented in FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 83 of file wx_grid.h.

◆ RestoreUndoState()

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

Reimplemented in FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 95 of file wx_grid.h.

◆ SerializeUndoState()

virtual wxString WX_GRID_TABLE_BASE::SerializeUndoState ( ) const
inlinevirtual

Reimplemented in FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 94 of file wx_grid.h.

◆ SetColAttr()

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

Definition at line 66 of file wx_grid.h.

References m_colAttrs.

Referenced by DIALOG_FIELDS_TABLE::SetupColumnProperties().

Member Data Documentation

◆ m_colAttrs

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

Definition at line 108 of file wx_grid.h.

Referenced by GetAttr(), SetColAttr(), and ~WX_GRID_TABLE_BASE().

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