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

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

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

Definition at line 97 of file layer_widget.h.

99  {
100  rowName = aRowName;
101  id = aId;
102  color = aColor;
103  state = aState;
104  tooltip = aTooltip;
105  changeable = aChangeable;
106  spacer = false;
107  }
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
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  }
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

Member Data Documentation

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

COLOR4D LAYER_WIDGET::ROW::color
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().

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(), and PCB_LAYER_WIDGET::ReFillRender().

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(), and PCB_LAYER_WIDGET::ReFillRender().

bool LAYER_WIDGET::ROW::state
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(), and PCB_LAYER_WIDGET::ReFillRender().


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