KiCAD pcbnew scripting
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
pcbnew.COLORS_DESIGN_SETTINGS Class Reference
Inheritance diagram for pcbnew.COLORS_DESIGN_SETTINGS:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, aFrameType)
 
def Load (self, aConfig)
 
def Save (self, aConfig)
 
def GetLayerColor (self, aLayer)
 
def SetLayerColor (self, aLayer, aColor)
 
def GetItemColor (self, aItemIdx)
 
def SetItemColor (self, aItemIdx, aColor)
 
def SetAllColorsAs (self, aColor)
 
def SetLegacyMode (self, aMode)
 

Public Attributes

 this
 

Static Public Attributes

tuple m_LayersColors = _swig_property(_pcbnew.COLORS_DESIGN_SETTINGS_m_LayersColors_get, _pcbnew.COLORS_DESIGN_SETTINGS_m_LayersColors_set)
 

Detailed Description

Class COLORS_DESIGN_SETTINGS is a list of color settings for designs
in Pcbnew.

C++ includes: class_colors_design_settings.h 

Definition at line 3271 of file pcbnew.py.

Constructor & Destructor Documentation

def pcbnew.COLORS_DESIGN_SETTINGS.__init__ (   self,
  aFrameType 
)
__init__(COLORS_DESIGN_SETTINGS self, FRAME_T aFrameType) -> COLORS_DESIGN_SETTINGS

COLORS_DESIGN_SETTINGS::COLORS_DESIGN_SETTINGS(FRAME_T aFrameType)

Definition at line 3290 of file pcbnew.py.

Member Function Documentation

def pcbnew.COLORS_DESIGN_SETTINGS.GetItemColor (   self,
  aItemIdx 
)
GetItemColor(COLORS_DESIGN_SETTINGS self, int aItemIdx) -> COLOR4D

COLOR4D
COLORS_DESIGN_SETTINGS::GetItemColor(int aItemIdx) const

Function GetItemColor.

the color for an item which is one of the item indices given in enum
PCB_LAYER_ID 

Definition at line 3352 of file pcbnew.py.

def pcbnew.COLORS_DESIGN_SETTINGS.GetLayerColor (   self,
  aLayer 
)
GetLayerColor(COLORS_DESIGN_SETTINGS self, LAYER_NUM aLayer) -> COLOR4D

COLOR4D
COLORS_DESIGN_SETTINGS::GetLayerColor(LAYER_NUM aLayer) const

Function GetLayerColor.

the color for aLayer which 

Definition at line 3325 of file pcbnew.py.

def pcbnew.COLORS_DESIGN_SETTINGS.Load (   self,
  aConfig 
)
Load(COLORS_DESIGN_SETTINGS self, wxConfigBase * aConfig)

void
COLORS_DESIGN_SETTINGS::Load(wxConfigBase *aConfig) override 

Definition at line 3305 of file pcbnew.py.

def pcbnew.COLORS_DESIGN_SETTINGS.Save (   self,
  aConfig 
)
Save(COLORS_DESIGN_SETTINGS self, wxConfigBase * aConfig)

void
COLORS_DESIGN_SETTINGS::Save(wxConfigBase *aConfig) override 

Definition at line 3315 of file pcbnew.py.

def pcbnew.COLORS_DESIGN_SETTINGS.SetAllColorsAs (   self,
  aColor 
)
SetAllColorsAs(COLORS_DESIGN_SETTINGS self, COLOR4D aColor)

void
COLORS_DESIGN_SETTINGS::SetAllColorsAs(COLOR4D aColor)

Function SetAllColorsAs sets alls colors to aColor Usefull to create a
monochrome color selection for printing purpose. 

Definition at line 3380 of file pcbnew.py.

def pcbnew.COLORS_DESIGN_SETTINGS.SetItemColor (   self,
  aItemIdx,
  aColor 
)
SetItemColor(COLORS_DESIGN_SETTINGS self, int aItemIdx, COLOR4D aColor)

void
COLORS_DESIGN_SETTINGS::SetItemColor(int aItemIdx, COLOR4D aColor)

Function SetItemColor sets the color for an item which is one of the
item indices given in enum PCB_LAYER_ID. 

Definition at line 3367 of file pcbnew.py.

def pcbnew.COLORS_DESIGN_SETTINGS.SetLayerColor (   self,
  aLayer,
  aColor 
)
SetLayerColor(COLORS_DESIGN_SETTINGS self, LAYER_NUM aLayer, COLOR4D aColor)

void
COLORS_DESIGN_SETTINGS::SetLayerColor(LAYER_NUM aLayer, COLOR4D
aColor)

Function SetLayerColor sets the color for aLayer. 

Definition at line 3339 of file pcbnew.py.

def pcbnew.COLORS_DESIGN_SETTINGS.SetLegacyMode (   self,
  aMode 
)
SetLegacyMode(COLORS_DESIGN_SETTINGS self, bool aMode)

void
COLORS_DESIGN_SETTINGS::SetLegacyMode(bool aMode)

Enables or disables legacy color mode.

When enabled, all colors will be quantized to the legacy color palette
when returned from GetItemColor and GetLayerColor (but the underlying
color will not be changed, and can still be set to arbitrary colors).

Definition at line 3393 of file pcbnew.py.

Member Data Documentation

tuple pcbnew.COLORS_DESIGN_SETTINGS.m_LayersColors = _swig_property(_pcbnew.COLORS_DESIGN_SETTINGS_m_LayersColors_get, _pcbnew.COLORS_DESIGN_SETTINGS_m_LayersColors_set)
static

Definition at line 3288 of file pcbnew.py.

pcbnew.COLORS_DESIGN_SETTINGS.this

Definition at line 3301 of file pcbnew.py.


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