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)
 

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

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

96  {
97  rowName = aRowName;
98  id = aId;
99  color = aColor;
100  state = aState;
101  tooltip = aTooltip;
102  changeable = aChangeable;
103  }
bool changeable
if true, the state can be changed
Definition: layer_widget.h:92
bool state
initial wxCheckBox state
Definition: layer_widget.h:90
wxString tooltip
if not empty, use this tooltip on row
Definition: layer_widget.h:91
COLOR4D color
COLOR4D::UNSPECIFIED if none.
Definition: layer_widget.h:89
wxString rowName
the prompt or layername
Definition: layer_widget.h:87

Member Data Documentation

bool LAYER_WIDGET::ROW::changeable

if true, the state can be changed

Definition at line 92 of file layer_widget.h.

Referenced by LAYER_WIDGET::insertRenderRow().

COLOR4D LAYER_WIDGET::ROW::color
int LAYER_WIDGET::ROW::id
wxString LAYER_WIDGET::ROW::rowName

the prompt or layername

Definition at line 87 of file layer_widget.h.

Referenced by LAYER_WIDGET::insertLayerRow(), 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 91 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: