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

#include <zone_layer_properties_grid.h>

Inheritance diagram for LAYER_PROPERTIES_GRID_TABLE:
WX_GRID_TABLE_BASE

Public Member Functions

 LAYER_PROPERTIES_GRID_TABLE (PCB_BASE_FRAME *aFrame, std::function< LSET()> getLayers)
 
 ~LAYER_PROPERTIES_GRID_TABLE () override
 
int GetNumberRows () override
 
int GetNumberCols () override
 
wxString GetColLabelValue (int aCol) override
 
bool CanGetValueAs (int aRow, int aCol, const wxString &aTypeName) override
 
bool CanSetValueAs (int aRow, int aCol, const wxString &aTypeName) override
 
wxString GetValue (int aRow, int aCol) override
 
void SetValue (int aRow, int aCol, const wxString &aValue) override
 
long GetValueAsLong (int aRow, int aCol) override
 
void SetValueAsLong (int aRow, int aCol, long aValue) override
 
void AddItem (PCB_LAYER_ID aLayer, const ZONE_LAYER_PROPERTIES &aProps)
 
bool AppendRows (size_t aNumRows=1) override
 
bool DeleteRows (size_t aPos, size_t aNumRows) override
 
const std::vector< std::pair< PCB_LAYER_ID, ZONE_LAYER_PROPERTIES > > & GetItems ()
 
void SetColAttr (wxGridCellAttr *aAttr, int aCol) override
 
wxGridCellAttr * GetAttr (int aRow, int aCol, wxGridCellAttr::wxAttrKind aKind) override
 
virtual bool IsExpanderColumn (int aCol) const
 
virtual GROUP_TYPE GetGroupType (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

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
 
std::function< LSET()> m_getLayersFunc
 
std::vector< std::pair< PCB_LAYER_ID, ZONE_LAYER_PROPERTIES > > m_items
 

Detailed Description

Definition at line 35 of file zone_layer_properties_grid.h.

Constructor & Destructor Documentation

◆ LAYER_PROPERTIES_GRID_TABLE()

LAYER_PROPERTIES_GRID_TABLE::LAYER_PROPERTIES_GRID_TABLE ( PCB_BASE_FRAME * aFrame,
std::function< LSET()> getLayers )

Definition at line 397 of file zone_settings.cpp.

References m_frame, m_getLayersFunc, and onUnitsChanged().

◆ ~LAYER_PROPERTIES_GRID_TABLE()

LAYER_PROPERTIES_GRID_TABLE::~LAYER_PROPERTIES_GRID_TABLE ( )
override

Definition at line 405 of file zone_settings.cpp.

References m_frame, and onUnitsChanged().

Member Function Documentation

◆ AddItem()

void LAYER_PROPERTIES_GRID_TABLE::AddItem ( PCB_LAYER_ID aLayer,
const ZONE_LAYER_PROPERTIES & aProps )

Definition at line 463 of file zone_settings.cpp.

References m_items.

Referenced by AppendRows().

◆ AppendRows()

bool LAYER_PROPERTIES_GRID_TABLE::AppendRows ( size_t aNumRows = 1)
override

Definition at line 475 of file zone_settings.cpp.

References AddItem(), m_getLayersFunc, m_items, next(), and UNDEFINED_LAYER.

◆ CanGetValueAs()

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

Definition at line 55 of file zone_layer_properties_grid.h.

Referenced by CanSetValueAs().

◆ CanSetValueAs()

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

Definition at line 66 of file zone_layer_properties_grid.h.

References CanGetValueAs().

◆ Clear()

void WX_GRID_TABLE_BASE::Clear ( )
inlineoverrideinherited

Definition at line 89 of file wx_grid.h.

◆ DeleteRows()

bool LAYER_PROPERTIES_GRID_TABLE::DeleteRows ( size_t aPos,
size_t aNumRows )
override

Definition at line 509 of file zone_settings.cpp.

References m_items.

◆ 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_EDITOR_GRID_DATA_MODEL::GetAttr(), 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 )
inlineoverrideinherited

Definition at line 64 of file wx_grid.h.

References enhanceAttr(), and m_colAttrs.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr().

◆ GetColLabelValue()

wxString LAYER_PROPERTIES_GRID_TABLE::GetColLabelValue ( int aCol)
inlineoverride

Definition at line 44 of file zone_layer_properties_grid.h.

References _.

◆ GetGroupType()

virtual GROUP_TYPE WX_GRID_TABLE_BASE::GetGroupType ( int aRow) const
inlinevirtualinherited

Reimplemented in FIELDS_EDITOR_GRID_DATA_MODEL, and LIB_FIELDS_EDITOR_GRID_DATA_MODEL.

Definition at line 76 of file wx_grid.h.

References GROUP_SINGLETON, and GROUP_TYPE.

◆ GetItems()

const std::vector< std::pair< PCB_LAYER_ID, ZONE_LAYER_PROPERTIES > > & LAYER_PROPERTIES_GRID_TABLE::GetItems ( )
inline

Definition at line 81 of file zone_layer_properties_grid.h.

References m_items.

◆ GetNumberCols()

int LAYER_PROPERTIES_GRID_TABLE::GetNumberCols ( )
inlineoverride

Definition at line 42 of file zone_layer_properties_grid.h.

◆ GetNumberRows()

int LAYER_PROPERTIES_GRID_TABLE::GetNumberRows ( )
inlineoverride

Definition at line 41 of file zone_layer_properties_grid.h.

References m_items.

◆ GetValue()

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

Definition at line 411 of file zone_settings.cpp.

References m_frame, m_items, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ GetValueAsLong()

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

Definition at line 443 of file zone_settings.cpp.

References m_items.

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

Definition at line 85 of file wx_grid.h.

◆ IsExpanderColumn()

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

Reimplemented in FIELDS_EDITOR_GRID_DATA_MODEL, and LIB_FIELDS_EDITOR_GRID_DATA_MODEL.

Definition at line 75 of file wx_grid.h.

◆ onUnitsChanged()

void LAYER_PROPERTIES_GRID_TABLE::onUnitsChanged ( wxCommandEvent & aEvent)
protected

Definition at line 530 of file zone_settings.cpp.

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

◆ RestoreUndoState()

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

Reimplemented in FIELDS_EDITOR_GRID_DATA_MODEL.

Definition at line 87 of file wx_grid.h.

◆ SerializeUndoState()

virtual wxString WX_GRID_TABLE_BASE::SerializeUndoState ( ) const
inlinevirtualinherited

Reimplemented in FIELDS_EDITOR_GRID_DATA_MODEL.

Definition at line 86 of file wx_grid.h.

◆ SetColAttr()

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

Definition at line 58 of file wx_grid.h.

References m_colAttrs.

◆ SetValue()

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

Definition at line 428 of file zone_settings.cpp.

References m_frame, m_items, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ SetValueAsLong()

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

Definition at line 453 of file zone_settings.cpp.

References m_items, and ToLAYER_ID().

Member Data Documentation

◆ m_colAttrs

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

Definition at line 100 of file wx_grid.h.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr(), GetAttr(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::RemoveColumn(), SetColAttr(), and ~WX_GRID_TABLE_BASE().

◆ m_frame

PCB_BASE_FRAME* LAYER_PROPERTIES_GRID_TABLE::m_frame
private

Definition at line 87 of file zone_layer_properties_grid.h.

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

◆ m_getLayersFunc

std::function<LSET()> LAYER_PROPERTIES_GRID_TABLE::m_getLayersFunc
private

Definition at line 88 of file zone_layer_properties_grid.h.

Referenced by AppendRows(), and LAYER_PROPERTIES_GRID_TABLE().

◆ m_items

std::vector<std::pair<PCB_LAYER_ID, ZONE_LAYER_PROPERTIES> > LAYER_PROPERTIES_GRID_TABLE::m_items
private

Definition at line 89 of file zone_layer_properties_grid.h.

Referenced by AddItem(), AppendRows(), DeleteRows(), GetItems(), GetNumberRows(), GetValue(), GetValueAsLong(), SetValue(), and SetValueAsLong().

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