KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
pcbnew.PCB_FIELD Class Reference
Inheritance diagram for pcbnew.PCB_FIELD:

Public Member Functions

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

Static Public Member Functions

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

Properties

 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.PCB_TEXT
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.BOARD_ITEM
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.EDA_ITEM
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
 m_Uuid = property(_pcbnew.EDA_ITEM_m_Uuid_get, doc=)
 
- Properties inherited from pcbnew.EDA_TEXT
 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
 DRC = _pcbnew.BOARD_ITEM_DRC
 
 INSTANCE_TO_INSTANCE = _pcbnew.BOARD_ITEM_INSTANCE_TO_INSTANCE
 

Detailed Description

Proxy of C++ PCB_FIELD class.

Definition at line 17509 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 17515 of file pcbnew.py.

Member Function Documentation

◆ __eq__()

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

Definition at line 17595 of file pcbnew.py.

◆ ClassOf()

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

Reimplemented from pcbnew.PCB_TEXT.

Definition at line 17531 of file pcbnew.py.

◆ CloneField()

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

Definition at line 17567 of file pcbnew.py.

◆ Deserialize()

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

Reimplemented from pcbnew.PCB_TEXT.

Definition at line 17526 of file pcbnew.py.

◆ GetCanonicalName()

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

Definition at line 17575 of file pcbnew.py.

◆ GetClass()

pcbnew.PCB_FIELD.GetClass ( self)
GetClass(PCB_FIELD self) -> wxString

Reimplemented from pcbnew.PCB_TEXT.

Definition at line 17535 of file pcbnew.py.

◆ GetId()

pcbnew.PCB_FIELD.GetId ( self)
GetId(PCB_FIELD self) -> FIELD_T

Definition at line 17583 of file pcbnew.py.

◆ GetName()

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

Definition at line 17571 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetOrdinal()

pcbnew.PCB_FIELD.GetOrdinal ( self)
GetOrdinal(PCB_FIELD self) -> int

Definition at line 17587 of file pcbnew.py.

◆ IsComponentClass()

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

Definition at line 17551 of file pcbnew.py.

◆ IsDatasheet()

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

Definition at line 17547 of file pcbnew.py.

◆ IsHypertext()

pcbnew.PCB_FIELD.IsHypertext ( self)
IsHypertext(PCB_FIELD self) -> bool

Definition at line 17559 of file pcbnew.py.

◆ IsMandatory()

pcbnew.PCB_FIELD.IsMandatory ( self)
IsMandatory(PCB_FIELD self) -> bool

Definition at line 17555 of file pcbnew.py.

◆ IsReference()

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

Definition at line 17539 of file pcbnew.py.

◆ IsValue()

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

Definition at line 17543 of file pcbnew.py.

◆ Serialize()

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

Reimplemented from pcbnew.PCB_TEXT.

Definition at line 17522 of file pcbnew.py.

◆ SetName()

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

Definition at line 17579 of file pcbnew.py.

◆ SetOrdinal()

pcbnew.PCB_FIELD.SetOrdinal ( self,
aOrdinal )
SetOrdinal(PCB_FIELD self, int aOrdinal)

Definition at line 17591 of file pcbnew.py.

◆ ViewGetLOD()

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

Reimplemented from pcbnew.PCB_TEXT.

Definition at line 17563 of file pcbnew.py.

Property Documentation

◆ thisown

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 17512 of file pcbnew.py.


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