KiCad PCB EDA Suite
LAYER_WIDGET::ROW Struct Reference

Provide 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, const COLOR4D &aColor=COLOR4D::UNSPECIFIED, const wxString &aTooltip=wxEmptyString, bool aState=true, bool aChangeable=true, const 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

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

Constructor & Destructor Documentation

◆ ROW() [1/2]

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

Definition at line 95 of file layer_widget.h.

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

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

◆ ROW() [2/2]

LAYER_WIDGET::ROW::ROW ( )
inline

Definition at line 109 of file layer_widget.h.

110  {
111  id = 0;
112  color = COLOR4D::UNSPECIFIED;
113  state = true;
114  changeable = true;
115  spacer = true;
116  defaultColor = COLOR4D::UNSPECIFIED;
117  }
COLOR4D defaultColor
The default color for the row.
Definition: layer_widget.h:93
bool spacer
if true, this row is a spacer
Definition: layer_widget.h:92
bool changeable
if true, the state can be changed
Definition: layer_widget.h:91
bool state
initial wxCheckBox state
Definition: layer_widget.h:89
COLOR4D color
COLOR4D::UNSPECIFIED if none.
Definition: layer_widget.h:88

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 91 of file layer_widget.h.

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

◆ color

COLOR4D LAYER_WIDGET::ROW::color

COLOR4D::UNSPECIFIED if none.

Definition at line 88 of file layer_widget.h.

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

◆ defaultColor

COLOR4D LAYER_WIDGET::ROW::defaultColor

The default color for the row.

Definition at line 93 of file layer_widget.h.

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

◆ id

int LAYER_WIDGET::ROW::id

either a layer or "visible element" id

Definition at line 87 of file layer_widget.h.

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

◆ rowName

wxString LAYER_WIDGET::ROW::rowName

the prompt or layername

Definition at line 86 of file layer_widget.h.

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

◆ spacer

bool LAYER_WIDGET::ROW::spacer

if true, this row is a spacer

Definition at line 92 of file layer_widget.h.

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

◆ state

bool LAYER_WIDGET::ROW::state

initial wxCheckBox state

Definition at line 89 of file layer_widget.h.

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

◆ tooltip

wxString LAYER_WIDGET::ROW::tooltip

if not empty, use this tooltip on row

Definition at line 90 of file layer_widget.h.

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


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