KiCad PCB EDA Suite
LAYER_WIDGET::ROW Struct Reference

Struct ROW provides all the data needed to add a row to a LAYER_WIDGET. More...

#include <layer_widget.h>

Public Member Functions

 ROW (const wxString &aRowName, int aId, COLOR4D aColor=COLOR4D::UNSPECIFIED, const wxString &aTooltip=wxEmptyString, bool aState=true, bool aChangeable=true, COLOR4D aDefaultColor=COLOR4D::UNSPECIFIED)
 
 ROW ()
 

Public Attributes

wxString rowName
 the prompt or layername More...
 
int id
 either a layer or "visible element" id More...
 
COLOR4D color
 COLOR4D::UNSPECIFIED if none. More...
 
bool state
 initial wxCheckBox state More...
 
wxString tooltip
 if not empty, use this tooltip on row More...
 
bool changeable
 if true, the state can be changed More...
 
bool spacer
 if true, this row is a spacer More...
 
COLOR4D defaultColor
 The default color for the row. More...
 

Detailed Description

Struct ROW provides all the data needed to add a row to a LAYER_WIDGET.

This is part of the public API for a LAYER_WIDGET.

Definition at line 87 of file layer_widget.h.

Constructor & Destructor Documentation

◆ ROW() [1/2]

LAYER_WIDGET::ROW::ROW ( const wxString &  aRowName,
int  aId,
COLOR4D  aColor = COLOR4D::UNSPECIFIED,
const wxString &  aTooltip = wxEmptyString,
bool  aState = true,
bool  aChangeable = true,
COLOR4D  aDefaultColor = COLOR4D::UNSPECIFIED 
)
inline

Definition at line 98 of file layer_widget.h.

101  {
102  rowName = aRowName;
103  id = aId;
104  color = aColor;
105  state = aState;
106  tooltip = aTooltip;
107  changeable = aChangeable;
108  spacer = false;
109  defaultColor = aDefaultColor;
110  }
COLOR4D defaultColor
The default color for the row.
Definition: layer_widget.h:96
bool spacer
if true, this row is a spacer
Definition: layer_widget.h:95
bool changeable
if true, the state can be changed
Definition: layer_widget.h:94
bool state
initial wxCheckBox state
Definition: layer_widget.h:92
wxString tooltip
if not empty, use this tooltip on row
Definition: layer_widget.h:93
COLOR4D color
COLOR4D::UNSPECIFIED if none.
Definition: layer_widget.h:91
wxString rowName
the prompt or layername
Definition: layer_widget.h:89

References changeable, color, defaultColor, rowName, spacer, state, and tooltip.

◆ ROW() [2/2]

LAYER_WIDGET::ROW::ROW ( )
inline

Definition at line 112 of file layer_widget.h.

113  {
114  id = 0;
115  color = COLOR4D::UNSPECIFIED;
116  state = true;
117  changeable = true;
118  spacer = true;
119  defaultColor = COLOR4D::UNSPECIFIED;
120  }
COLOR4D defaultColor
The default color for the row.
Definition: layer_widget.h:96
bool spacer
if true, this row is a spacer
Definition: layer_widget.h:95
bool changeable
if true, the state can be changed
Definition: layer_widget.h:94
bool state
initial wxCheckBox state
Definition: layer_widget.h:92
COLOR4D color
COLOR4D::UNSPECIFIED if none.
Definition: layer_widget.h:91

References changeable, color, defaultColor, spacer, and state.

Member Data Documentation

◆ changeable

bool LAYER_WIDGET::ROW::changeable

if true, the state can be changed

Definition at line 94 of file layer_widget.h.

Referenced by LAYER_WIDGET::insertRenderRow(), and ROW().

◆ color

COLOR4D LAYER_WIDGET::ROW::color

◆ defaultColor

COLOR4D LAYER_WIDGET::ROW::defaultColor

The default color for the row.

Definition at line 96 of file layer_widget.h.

Referenced by LAYER_WIDGET::insertLayerRow(), LAYER_WIDGET::insertRenderRow(), PCB_LAYER_WIDGET::ReFillRender(), and ROW().

◆ id

int LAYER_WIDGET::ROW::id

either a layer or "visible element" id

Definition at line 90 of file layer_widget.h.

Referenced by LAYER_WIDGET::insertLayerRow(), LAYER_WIDGET::insertRenderRow(), and PCB_LAYER_WIDGET::ReFillRender().

◆ rowName

wxString LAYER_WIDGET::ROW::rowName

the prompt or layername

Definition at line 89 of file layer_widget.h.

Referenced by LAYER_WIDGET::insertLayerRow(), LAYER_WIDGET::insertRenderRow(), PCB_LAYER_WIDGET::ReFillRender(), and ROW().

◆ spacer

bool LAYER_WIDGET::ROW::spacer

if true, this row is a spacer

Definition at line 95 of file layer_widget.h.

Referenced by LAYER_WIDGET::insertRenderRow(), PCB_LAYER_WIDGET::ReFillRender(), and ROW().

◆ state

bool LAYER_WIDGET::ROW::state

◆ tooltip

wxString LAYER_WIDGET::ROW::tooltip

if not empty, use this tooltip on row

Definition at line 93 of file layer_widget.h.

Referenced by LAYER_WIDGET::insertLayerRow(), LAYER_WIDGET::insertRenderRow(), PCB_LAYER_WIDGET::ReFillRender(), and ROW().


The documentation for this struct was generated from the following file: