KiCad Pcbnew Python Scripting
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)
 
"int" Parse (self, "UTF8" aId, "bool" aFix=False)
 
"UTF8 const &" GetLibNickname (self)
 
"int" SetLibNickname (self, "UTF8" aNickname)
 
"UTF8 const &" GetLibItemName (self)
 
"wxString const" GetUniStringLibItemName (self)
 
"int" SetLibItemName (self, "UTF8" aLibItemName)
 
"wxString" GetUniStringLibId (self)
 
"bool" IsValid (self)
 
"bool" IsLegacy (self)
 
"void" clear (self)
 
"bool" empty (self)
 
"int" compare (self, "LIB_ID" aLibId)
 
"bool" __lt__ (self, "LIB_ID" aLibId)
 
"bool" __gt__ (self, "LIB_ID" aLibId)
 
"bool" __eq__ (self, "LIB_ID" aLibId)
 
"bool" __ne__ (self, "LIB_ID" aLibId)
 

Static Public Member Functions

"UTF8" Format (*args)
 
"int" HasIllegalChars ("UTF8" aLibItemName)
 
"UTF8" FixIllegalChars ("UTF8" aLibItemName, "bool" aLib)
 
"unsigned int" FindIllegalLibraryNameChar ("UTF8" aLibraryName)
 

Properties

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

Here is the caller graph for this function:

Member Function Documentation

◆ __eq__()

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

Definition at line 5674 of file pcbnew.py.

◆ __gt__()

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

Definition at line 5670 of file pcbnew.py.

◆ __lt__()

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

Definition at line 5666 of file pcbnew.py.

◆ __ne__()

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

Definition at line 5678 of file pcbnew.py.

◆ clear()

"void" pcbnew.LIB_ID.clear (   self)
clear(LIB_ID self)

Definition at line 5654 of file pcbnew.py.

◆ compare()

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

Definition at line 5662 of file pcbnew.py.

◆ empty()

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

Definition at line 5658 of file pcbnew.py.

◆ FindIllegalLibraryNameChar()

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

Definition at line 5693 of file pcbnew.py.

◆ FixIllegalChars()

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

Definition at line 5688 of file pcbnew.py.

◆ Format()

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

Definition at line 5639 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetLibItemName()

"UTF8 const &" pcbnew.LIB_ID.GetLibItemName (   self)
GetLibItemName(LIB_ID self) -> UTF8

Definition at line 5622 of file pcbnew.py.

◆ GetLibNickname()

"UTF8 const &" pcbnew.LIB_ID.GetLibNickname (   self)
GetLibNickname(LIB_ID self) -> UTF8

Definition at line 5614 of file pcbnew.py.

◆ GetUniStringLibId()

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

Definition at line 5634 of file pcbnew.py.

◆ GetUniStringLibItemName()

"wxString const" pcbnew.LIB_ID.GetUniStringLibItemName (   self)
GetUniStringLibItemName(LIB_ID self) -> wxString

Definition at line 5626 of file pcbnew.py.

◆ HasIllegalChars()

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

Definition at line 5683 of file pcbnew.py.

◆ IsLegacy()

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

Definition at line 5650 of file pcbnew.py.

◆ IsValid()

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

Definition at line 5646 of file pcbnew.py.

◆ Parse()

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

Definition at line 5610 of file pcbnew.py.

◆ SetLibItemName()

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

Definition at line 5630 of file pcbnew.py.

◆ SetLibNickname()

"int" pcbnew.LIB_ID.SetLibNickname (   self,
"UTF8"  aNickname 
)
SetLibNickname(LIB_ID self, UTF8 aNickname) -> int

Definition at line 5618 of file pcbnew.py.

Property Documentation

◆ thisown

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


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