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

Public Member Functions

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

Static Public Member Functions

 Format (*args)
 
 HasIllegalChars (aLibItemName)
 
 FixIllegalChars (aLibItemName, aLib)
 
 FindIllegalLibraryNameChar (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 7817 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

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

Member Function Documentation

◆ __eq__()

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

Definition at line 7914 of file pcbnew.py.

◆ __gt__()

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

Definition at line 7910 of file pcbnew.py.

◆ __lt__()

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

Definition at line 7906 of file pcbnew.py.

◆ __ne__()

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

Definition at line 7918 of file pcbnew.py.

◆ clear()

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

Definition at line 7894 of file pcbnew.py.

◆ compare()

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

Definition at line 7902 of file pcbnew.py.

◆ empty()

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

Definition at line 7898 of file pcbnew.py.

◆ FindIllegalLibraryNameChar()

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

Definition at line 7933 of file pcbnew.py.

◆ FixIllegalChars()

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

Definition at line 7928 of file pcbnew.py.

◆ Format()

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

Definition at line 7879 of file pcbnew.py.

◆ GetFullLibraryName()

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

Definition at line 7870 of file pcbnew.py.

◆ GetLibItemName()

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

Definition at line 7846 of file pcbnew.py.

◆ GetLibNickname()

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

Definition at line 7834 of file pcbnew.py.

◆ GetSubLibraryName()

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

Definition at line 7858 of file pcbnew.py.

◆ GetUniStringLibId()

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

Definition at line 7874 of file pcbnew.py.

◆ GetUniStringLibItemName()

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

Definition at line 7850 of file pcbnew.py.

◆ GetUniStringLibNickname()

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

Definition at line 7838 of file pcbnew.py.

◆ GetUniStringSubLibraryName()

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

Definition at line 7866 of file pcbnew.py.

◆ HasIllegalChars()

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

Definition at line 7923 of file pcbnew.py.

◆ IsLegacy()

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

Definition at line 7890 of file pcbnew.py.

◆ IsValid()

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

Definition at line 7886 of file pcbnew.py.

◆ Parse()

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

Definition at line 7830 of file pcbnew.py.

◆ SetLibItemName()

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

Definition at line 7854 of file pcbnew.py.

◆ SetLibNickname()

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

Definition at line 7842 of file pcbnew.py.

◆ SetSubLibraryName()

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

Definition at line 7862 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 7820 of file pcbnew.py.


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