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

Public Member Functions

def __init__ (self, *args)
 
def Parse (self, aId, aFix=False)
 
def GetLibNickname (self)
 
def GetUniStringLibNickname (self)
 
def SetLibNickname (self, aLibNickname)
 
def GetLibItemName (self)
 
def GetUniStringLibItemName (self)
 
def SetLibItemName (self, aLibItemName)
 
def GetSubLibraryName (self)
 
def SetSubLibraryName (self, aName)
 
def GetUniStringSubLibraryName (self)
 
def GetFullLibraryName (self)
 
def GetUniStringLibId (self)
 
def IsValid (self)
 
def IsLegacy (self)
 
def clear (self)
 
def empty (self)
 
def compare (self, aLibId)
 
def __lt__ (self, aLibId)
 
def __gt__ (self, aLibId)
 
def __eq__ (self, aLibId)
 
def __ne__ (self, aLibId)
 

Static Public Member Functions

def Format (*args)
 
def HasIllegalChars (aLibItemName)
 
def FixIllegalChars (aLibItemName, aLib)
 
def FindIllegalLibraryNameChar (aLibraryName)
 

Properties

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

Detailed Description

Proxy of C++ LIB_ID class.

Definition at line 7572 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.LIB_ID.__init__ (   self,
args 
)
    __init__(LIB_ID self) -> LIB_ID
    __init__(LIB_ID self, wxString aLibraryName, wxString aItemName) -> LIB_ID

Definition at line 7578 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ __eq__()

def pcbnew.LIB_ID.__eq__ (   self,
  aLibId 
)
__eq__(LIB_ID self, LIB_ID aLibId) -> bool

Definition at line 7669 of file pcbnew.py.

◆ __gt__()

def pcbnew.LIB_ID.__gt__ (   self,
  aLibId 
)
__gt__(LIB_ID self, LIB_ID aLibId) -> bool

Definition at line 7665 of file pcbnew.py.

◆ __lt__()

def pcbnew.LIB_ID.__lt__ (   self,
  aLibId 
)
__lt__(LIB_ID self, LIB_ID aLibId) -> bool

Definition at line 7661 of file pcbnew.py.

◆ __ne__()

def pcbnew.LIB_ID.__ne__ (   self,
  aLibId 
)
__ne__(LIB_ID self, LIB_ID aLibId) -> bool

Definition at line 7673 of file pcbnew.py.

◆ clear()

def pcbnew.LIB_ID.clear (   self)
clear(LIB_ID self)

Definition at line 7649 of file pcbnew.py.

◆ compare()

def pcbnew.LIB_ID.compare (   self,
  aLibId 
)
compare(LIB_ID self, LIB_ID aLibId) -> int

Definition at line 7657 of file pcbnew.py.

◆ empty()

def pcbnew.LIB_ID.empty (   self)
empty(LIB_ID self) -> bool

Definition at line 7653 of file pcbnew.py.

◆ FindIllegalLibraryNameChar()

def pcbnew.LIB_ID.FindIllegalLibraryNameChar (   aLibraryName)
static
FindIllegalLibraryNameChar(UTF8 aLibraryName) -> unsigned int

Definition at line 7688 of file pcbnew.py.

◆ FixIllegalChars()

def pcbnew.LIB_ID.FixIllegalChars (   aLibItemName,
  aLib 
)
static
FixIllegalChars(UTF8 aLibItemName, bool aLib) -> UTF8

Definition at line 7683 of file pcbnew.py.

◆ Format()

def pcbnew.LIB_ID.Format ( args)
static
    Format() -> UTF8
    Format(UTF8 aLibraryName, UTF8 aLibItemName) -> UTF8

Definition at line 7634 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetFullLibraryName()

def pcbnew.LIB_ID.GetFullLibraryName (   self)
GetFullLibraryName(LIB_ID self) -> wxString

Definition at line 7625 of file pcbnew.py.

◆ GetLibItemName()

def pcbnew.LIB_ID.GetLibItemName (   self)
GetLibItemName(LIB_ID self) -> UTF8

Definition at line 7601 of file pcbnew.py.

◆ GetLibNickname()

def pcbnew.LIB_ID.GetLibNickname (   self)
GetLibNickname(LIB_ID self) -> UTF8

Definition at line 7589 of file pcbnew.py.

◆ GetSubLibraryName()

def pcbnew.LIB_ID.GetSubLibraryName (   self)
GetSubLibraryName(LIB_ID self) -> UTF8

Definition at line 7613 of file pcbnew.py.

◆ GetUniStringLibId()

def pcbnew.LIB_ID.GetUniStringLibId (   self)
GetUniStringLibId(LIB_ID self) -> wxString

Definition at line 7629 of file pcbnew.py.

◆ GetUniStringLibItemName()

def pcbnew.LIB_ID.GetUniStringLibItemName (   self)
GetUniStringLibItemName(LIB_ID self) -> wxString

Definition at line 7605 of file pcbnew.py.

◆ GetUniStringLibNickname()

def pcbnew.LIB_ID.GetUniStringLibNickname (   self)
GetUniStringLibNickname(LIB_ID self) -> wxString

Definition at line 7593 of file pcbnew.py.

◆ GetUniStringSubLibraryName()

def pcbnew.LIB_ID.GetUniStringSubLibraryName (   self)
GetUniStringSubLibraryName(LIB_ID self) -> wxString

Definition at line 7621 of file pcbnew.py.

◆ HasIllegalChars()

def pcbnew.LIB_ID.HasIllegalChars (   aLibItemName)
static
HasIllegalChars(UTF8 aLibItemName) -> int

Definition at line 7678 of file pcbnew.py.

◆ IsLegacy()

def pcbnew.LIB_ID.IsLegacy (   self)
IsLegacy(LIB_ID self) -> bool

Definition at line 7645 of file pcbnew.py.

◆ IsValid()

def pcbnew.LIB_ID.IsValid (   self)
IsValid(LIB_ID self) -> bool

Definition at line 7641 of file pcbnew.py.

◆ Parse()

def pcbnew.LIB_ID.Parse (   self,
  aId,
  aFix = False 
)
Parse(LIB_ID self, UTF8 aId, bool aFix=False) -> int

Definition at line 7585 of file pcbnew.py.

◆ SetLibItemName()

def pcbnew.LIB_ID.SetLibItemName (   self,
  aLibItemName 
)
SetLibItemName(LIB_ID self, UTF8 aLibItemName) -> int

Definition at line 7609 of file pcbnew.py.

◆ SetLibNickname()

def pcbnew.LIB_ID.SetLibNickname (   self,
  aLibNickname 
)
SetLibNickname(LIB_ID self, UTF8 aLibNickname) -> int

Definition at line 7597 of file pcbnew.py.

◆ SetSubLibraryName()

def pcbnew.LIB_ID.SetSubLibraryName (   self,
  aName 
)
SetSubLibraryName(LIB_ID self, UTF8 aName)

Definition at line 7617 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 7575 of file pcbnew.py.


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