KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Properties | List of all members
pcbnew.PCB_FIELD Class Reference
Inheritance diagram for pcbnew.PCB_FIELD:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, *args)
 
def Serialize (self, aContainer)
 
def Deserialize (self, aContainer)
 
def IsReference (self)
 
def IsValue (self)
 
def IsFootprint (self)
 
def IsDatasheet (self)
 
def IsComponentClass (self)
 
def IsMandatoryField (self)
 
def ViewGetLOD (self, aLayer, aView)
 
def CloneField (self)
 
def GetName (self, aUseDefaultName=True)
 
def GetCanonicalName (self)
 
def SetName (self, aName)
 
def GetId (self)
 
def SetId (self, aId)
 
def __eq__ (self, *args)
 
- Public Member Functions inherited from pcbnew.PCB_TEXT
def __init__ (self, *args)
 
def Serialize (self, aContainer)
 
def Deserialize (self, aContainer)
 
def KeepUpright (self)
 
def GetShownText (self, aAllowExtraText, aDepth=0)
 
def TextHitTest (self, *args)
 
def HitTest (self, *args)
 
def TransformTextToPolySet (self, aBuffer, aClearance, aMaxError, aErrorLoc)
 
def TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aMaxError, aErrorLoc, aIgnoreLineWidth=False)
 
def GetEffectiveShape (self, *args)
 
def GetTextTypeDescription (self)
 
def ViewGetLOD (self, aLayer, aView)
 
def __eq__ (self, *args)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM
def __init__ (self, *args, **kwargs)
 
def SetParentGroup (self, aGroup)
 
def GetParentGroup (self)
 
def GetX (self)
 
def GetY (self)
 
def GetCenter (self)
 
def SetX (self, aX)
 
def SetY (self, aY)
 
def IsConnected (self)
 
def Similarity (self, aItem)
 
def __eq__ (self, aItem)
 
def IsOnCopperLayer (self)
 
def HasHole (self)
 
def HasDrilledHole (self)
 
def IsTented (self, aLayer)
 
def GetEffectiveShape (self, *args)
 
def GetEffectiveHoleShape (self)
 
def RunOnChildren (self, aFunction)
 
def RunOnDescendants (self, aFunction, aDepth=0)
 
def GetParent (self)
 
def GetParentFootprint (self)
 
def GetFPRelativePosition (self)
 
def SetFPRelativePosition (self, aPos)
 
def HasLineStroke (self)
 
def GetStroke (self)
 
def SetStroke (self, aStroke)
 
def GetFontMetrics (self)
 
def GetLayer (self)
 
def BoardLayerCount (self)
 
def BoardCopperLayerCount (self)
 
def BoardLayerSet (self)
 
def GetLayerSet (self)
 
def SetLayerSet (self, aLayers)
 
def IsSideSpecific (self)
 
def SetLayer (self, aLayer)
 
def Duplicate (self)
 
def SwapItemData (self, aImage)
 
def IsOnLayer (self, aLayer)
 
def IsKnockout (self)
 
def SetIsKnockout (self, aKnockout)
 
def IsLocked (self)
 
def SetLocked (self, aLocked)
 
def StyleFromSettings (self, settings)
 
def DeleteStructure (self)
 
def Move (self, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre, aFlipDirection)
 
def Mirror (self, aCentre, aFlipDirection)
 
def Normalize (self)
 
def NormalizeForCompare (self)
 
def GetBoard (self, *args)
 
def GetParentAsString (self)
 
def GetLayerName (self)
 
def TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
def Cast (self)
 
def Duplicate (self)
 
def SetPos (self, p)
 
def SetStartEnd (self, start, end)
 
- Public Member Functions inherited from pcbnew.EDA_ITEM
def __init__ (self, *args, **kwargs)
 
def Type (self)
 
def GetParent (self)
 
def SetParent (self, aParent)
 
def IsModified (self)
 
def IsNew (self)
 
def IsMoving (self)
 
def IsSelected (self)
 
def IsEntered (self)
 
def IsBrightened (self)
 
def IsRollover (self)
 
def SetSelected (self)
 
def SetBrightened (self)
 
def ClearSelected (self)
 
def ClearBrightened (self)
 
def SetModified (self)
 
def SetFlags (self, aMask)
 
def XorFlags (self, aMask)
 
def ClearFlags (self, *args)
 
def GetFlags (self)
 
def HasFlag (self, aFlag)
 
def GetEditFlags (self)
 
def ClearEditFlags (self)
 
def GetTempFlags (self)
 
def ClearTempFlags (self)
 
def RenderAsBitmap (self, aWorldScale)
 
def SetIsShownAsBitmap (self, aBitmap)
 
def IsShownAsBitmap (self)
 
def IsType (self, aScanTypes)
 
def SetForceVisible (self, aEnable)
 
def IsForceVisible (self)
 
def GetMsgPanelInfo (self, aFrame, aList)
 
def GetFriendlyName (self)
 
def HitTest (self, *args)
 
def GetBoundingBox (self)
 
def GetPosition (self)
 
def SetPosition (self, aPos)
 
def GetFocusPosition (self)
 
def GetSortPosition (self)
 
def Clone (self)
 
def Visit (self, inspector, testData, aScanTypes)
 
def GetClass (self)
 
def GetTypeDesc (self)
 
def GetItemDescription (self, aUnitsProvider, aFull)
 
def GetMenuImage (self)
 
def Matches (self, aSearchData, aAuxData)
 
def Replace (self, *args)
 
def IsReplaceable (self)
 
def __lt__ (self, aItem)
 
def ViewBBox (self)
 
def ViewGetLayers (self, aLayers, aCount)
 
def GetEmbeddedFiles (self)
 
- Public Member Functions inherited from pcbnew.EDA_TEXT
def __init__ (self, *args)
 
def GetText (self)
 
def GetShownText (self, aAllowExtraText, aDepth=0)
 
def HasTextVars (self)
 
def SetText (self, aText)
 
def SetTextThickness (self, aWidth)
 
def GetTextThickness (self)
 
def GetEffectiveTextPenWidth (self, aDefaultPenWidth=0)
 
def SetTextAngle (self, aAngle)
 
def GetTextAngle (self)
 
def SetTextAngleDegrees (self, aOrientation)
 
def GetTextAngleDegrees (self)
 
def SetItalic (self, aItalic)
 
def SetItalicFlag (self, aItalic)
 
def IsItalic (self)
 
def SetBold (self, aBold)
 
def SetBoldFlag (self, aBold)
 
def IsBold (self)
 
def SetVisible (self, aVisible)
 
def IsVisible (self)
 
def SetMirrored (self, isMirrored)
 
def IsMirrored (self)
 
def SetMultilineAllowed (self, aAllow)
 
def IsMultilineAllowed (self)
 
def SetHorizJustify (self, aType)
 
def GetHorizJustify (self)
 
def SetVertJustify (self, aType)
 
def GetVertJustify (self)
 
def SetKeepUpright (self, aKeepUpright)
 
def IsKeepUpright (self)
 
def FlipHJustify (self)
 
def SwapAttributes (self, aTradingPartner)
 
def SwapText (self, aTradingPartner)
 
def CopyText (self, aSrc)
 
def SetAttributes (self, *args)
 
def GetAttributes (self)
 
def Replace (self, aSearchData)
 
def IsDefaultFormatting (self)
 
def SetFont (self, aFont)
 
def GetFont (self)
 
def GetFontName (self)
 
def SetFontIndex (self, aIdx)
 
def GetFontIndex (self)
 
def SetLineSpacing (self, aLineSpacing)
 
def GetLineSpacing (self)
 
def SetTextSize (self, aNewSize, aEnforceMinTextSize=True)
 
def GetTextSize (self)
 
def SetTextWidth (self, aWidth)
 
def GetTextWidth (self)
 
def SetTextHeight (self, aHeight)
 
def GetTextHeight (self)
 
def SetTextColor (self, aColor)
 
def GetTextColor (self)
 
def SetTextPos (self, aPoint)
 
def GetTextPos (self)
 
def SetTextX (self, aX)
 
def SetTextY (self, aY)
 
def Offset (self, aOffset)
 
def Empty (self)
 
def Print (self, aSettings, aOffset, aColor, aDisplay_mode=FILLED)
 
def GetEffectiveTextShape (self, *args)
 
def TextHitTest (self, *args)
 
def GetTextBox (self, aLine=-1)
 
def GetInterline (self)
 
def GetTextStyleName (self)
 
def GetLinePositions (self, aPositions, aLineCount)
 
def Levenshtein (self, aOther)
 
def Similarity (self, aOther)
 
def Format (self, aFormatter, aNestLevel, aControlBits)
 
def GetDrawRotation (self)
 
def GetDrawPos (self)
 
def ClearRenderCache (self)
 
def ClearBoundingBoxCache (self)
 
def GetRenderCache (self, *args)
 
def SetupRenderCache (self, aResolvedText, aFont, aAngle, aOffset)
 
def AddRenderCacheGlyph (self, aPoly)
 
def Compare (self, aOther)
 
def __eq__ (self, aRhs)
 
def __lt__ (self, aRhs)
 
def __gt__ (self, aRhs)
 
def HasHyperlink (self)
 
def GetHyperlink (self)
 
def SetHyperlink (self, aLink)
 
def RemoveHyperlink (self)
 

Static Public Member Functions

def ClassOf (aItem)
 
def ClassOf (aItem)
 
- Static Public Member Functions inherited from pcbnew.EDA_ITEM
def Sort (aLeft, aRight)
 
- Static Public Member Functions inherited from pcbnew.EDA_TEXT
def MapHorizJustify (aHorizJustify)
 
def MapVertJustify (aVertJustify)
 
def ValidateHyperlink (aURL)
 
def IsGotoPageHref (aHref, aDestination=None)
 
def GotoPageHref (aDestination)
 

Properties

property thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.PCB_TEXT
property thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.BOARD_ITEM
property thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.EDA_ITEM
property thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
property m_Uuid = property(_pcbnew.EDA_ITEM_m_Uuid_get, doc=)
 
- Properties inherited from pcbnew.EDA_TEXT
property thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 

Additional Inherited Members

- Static Public Attributes inherited from pcbnew.BOARD_ITEM
_pcbnew DRC = _pcbnew.BOARD_ITEM_DRC
 

Detailed Description

Proxy of C++ PCB_FIELD class.

Definition at line 16328 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.PCB_FIELD.__init__ (   self,
args 
)
    __init__(PCB_FIELD self, FOOTPRINT aParent, int aFieldId, wxString aName=wxEmptyString) -> PCB_FIELD
    __init__(PCB_FIELD self, PCB_TEXT aText, int aFieldId, wxString aName=wxEmptyString) -> PCB_FIELD

Reimplemented from pcbnew.PCB_TEXT.

Definition at line 16334 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ __eq__()

def pcbnew.PCB_FIELD.__eq__ (   self,
args 
)
    __eq__(PCB_FIELD self, PCB_FIELD aOther) -> bool
    __eq__(PCB_FIELD self, BOARD_ITEM aOther) -> bool

Reimplemented from pcbnew.PCB_TEXT.

Definition at line 16406 of file pcbnew.py.

Here is the caller graph for this function:

◆ ClassOf()

def pcbnew.PCB_FIELD.ClassOf (   aItem)
static
ClassOf(EDA_ITEM aItem) -> bool

Reimplemented from pcbnew.PCB_TEXT.

Definition at line 16350 of file pcbnew.py.

◆ CloneField()

def pcbnew.PCB_FIELD.CloneField (   self)
CloneField(PCB_FIELD self) -> PCB_FIELD

Definition at line 16382 of file pcbnew.py.

◆ Deserialize()

def pcbnew.PCB_FIELD.Deserialize (   self,
  aContainer 
)
Deserialize(PCB_FIELD self, google::protobuf::Any const & aContainer) -> bool

Reimplemented from pcbnew.PCB_TEXT.

Definition at line 16345 of file pcbnew.py.

◆ GetCanonicalName()

def pcbnew.PCB_FIELD.GetCanonicalName (   self)
GetCanonicalName(PCB_FIELD self) -> wxString

Definition at line 16390 of file pcbnew.py.

◆ GetId()

def pcbnew.PCB_FIELD.GetId (   self)
GetId(PCB_FIELD self) -> int

Definition at line 16398 of file pcbnew.py.

◆ GetName()

def pcbnew.PCB_FIELD.GetName (   self,
  aUseDefaultName = True 
)
GetName(PCB_FIELD self, bool aUseDefaultName=True) -> wxString

Definition at line 16386 of file pcbnew.py.

Here is the caller graph for this function:

◆ IsComponentClass()

def pcbnew.PCB_FIELD.IsComponentClass (   self)
IsComponentClass(PCB_FIELD self) -> bool

Definition at line 16370 of file pcbnew.py.

◆ IsDatasheet()

def pcbnew.PCB_FIELD.IsDatasheet (   self)
IsDatasheet(PCB_FIELD self) -> bool

Definition at line 16366 of file pcbnew.py.

◆ IsFootprint()

def pcbnew.PCB_FIELD.IsFootprint (   self)
IsFootprint(PCB_FIELD self) -> bool

Definition at line 16362 of file pcbnew.py.

◆ IsMandatoryField()

def pcbnew.PCB_FIELD.IsMandatoryField (   self)
IsMandatoryField(PCB_FIELD self) -> bool

Definition at line 16374 of file pcbnew.py.

◆ IsReference()

def pcbnew.PCB_FIELD.IsReference (   self)
IsReference(PCB_FIELD self) -> bool

Definition at line 16354 of file pcbnew.py.

◆ IsValue()

def pcbnew.PCB_FIELD.IsValue (   self)
IsValue(PCB_FIELD self) -> bool

Definition at line 16358 of file pcbnew.py.

◆ Serialize()

def pcbnew.PCB_FIELD.Serialize (   self,
  aContainer 
)
Serialize(PCB_FIELD self, google::protobuf::Any & aContainer)

Reimplemented from pcbnew.PCB_TEXT.

Definition at line 16341 of file pcbnew.py.

◆ SetId()

def pcbnew.PCB_FIELD.SetId (   self,
  aId 
)
SetId(PCB_FIELD self, int aId)

Definition at line 16402 of file pcbnew.py.

◆ SetName()

def pcbnew.PCB_FIELD.SetName (   self,
  aName 
)
SetName(PCB_FIELD self, wxString aName)

Definition at line 16394 of file pcbnew.py.

◆ ViewGetLOD()

def pcbnew.PCB_FIELD.ViewGetLOD (   self,
  aLayer,
  aView 
)
ViewGetLOD(PCB_FIELD self, int aLayer, KIGFX::VIEW * aView) -> double

Reimplemented from pcbnew.PCB_TEXT.

Definition at line 16378 of file pcbnew.py.

Property Documentation

◆ thisown

property pcbnew.PCB_FIELD.thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
static

Definition at line 16331 of file pcbnew.py.


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