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

Public Member Functions

def __init__ (self)
 
def SetTitle (self, aTitle)
 
def GetTitle (self)
 
def SetDate (self, aDate)
 
def GetDate (self)
 
def SetRevision (self, aRevision)
 
def GetRevision (self)
 
def SetCompany (self, aCompany)
 
def GetCompany (self)
 
def SetComment (self, aIdx, aComment)
 
def GetComment (self, aIdx)
 
def Clear (self)
 
def TextVarResolver (self, aToken, aProject)
 
def Format (self, aFormatter, aNestLevel, aControlBits)
 

Static Public Member Functions

def GetContextualTextVars (aVars)
 

Properties

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

Detailed Description

Proxy of C++ TITLE_BLOCK class.

Definition at line 2224 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.TITLE_BLOCK.__init__ (   self)
__init__(TITLE_BLOCK self) -> TITLE_BLOCK

Definition at line 2230 of file pcbnew.py.

Member Function Documentation

◆ Clear()

def pcbnew.TITLE_BLOCK.Clear (   self)
Clear(TITLE_BLOCK self)

Definition at line 2275 of file pcbnew.py.

◆ Format()

def pcbnew.TITLE_BLOCK.Format (   self,
  aFormatter,
  aNestLevel,
  aControlBits 
)
Format(TITLE_BLOCK self, OUTPUTFORMATTER aFormatter, int aNestLevel, int aControlBits)

Definition at line 2288 of file pcbnew.py.

◆ GetComment()

def pcbnew.TITLE_BLOCK.GetComment (   self,
  aIdx 
)
GetComment(TITLE_BLOCK self, int aIdx) -> wxString

Definition at line 2271 of file pcbnew.py.

◆ GetCompany()

def pcbnew.TITLE_BLOCK.GetCompany (   self)
GetCompany(TITLE_BLOCK self) -> wxString

Definition at line 2263 of file pcbnew.py.

◆ GetContextualTextVars()

def pcbnew.TITLE_BLOCK.GetContextualTextVars (   aVars)
static
GetContextualTextVars(wxArrayString * aVars)

Definition at line 2280 of file pcbnew.py.

◆ GetDate()

def pcbnew.TITLE_BLOCK.GetDate (   self)
GetDate(TITLE_BLOCK self) -> wxString

Definition at line 2247 of file pcbnew.py.

◆ GetRevision()

def pcbnew.TITLE_BLOCK.GetRevision (   self)
GetRevision(TITLE_BLOCK self) -> wxString

Definition at line 2255 of file pcbnew.py.

◆ GetTitle()

def pcbnew.TITLE_BLOCK.GetTitle (   self)
GetTitle(TITLE_BLOCK self) -> wxString

Definition at line 2239 of file pcbnew.py.

◆ SetComment()

def pcbnew.TITLE_BLOCK.SetComment (   self,
  aIdx,
  aComment 
)
SetComment(TITLE_BLOCK self, int aIdx, wxString aComment)

Definition at line 2267 of file pcbnew.py.

◆ SetCompany()

def pcbnew.TITLE_BLOCK.SetCompany (   self,
  aCompany 
)
SetCompany(TITLE_BLOCK self, wxString aCompany)

Definition at line 2259 of file pcbnew.py.

◆ SetDate()

def pcbnew.TITLE_BLOCK.SetDate (   self,
  aDate 
)
SetDate(TITLE_BLOCK self, wxString aDate)

Definition at line 2243 of file pcbnew.py.

◆ SetRevision()

def pcbnew.TITLE_BLOCK.SetRevision (   self,
  aRevision 
)
SetRevision(TITLE_BLOCK self, wxString aRevision)

Definition at line 2251 of file pcbnew.py.

◆ SetTitle()

def pcbnew.TITLE_BLOCK.SetTitle (   self,
  aTitle 
)
SetTitle(TITLE_BLOCK self, wxString aTitle)

Definition at line 2235 of file pcbnew.py.

◆ TextVarResolver()

def pcbnew.TITLE_BLOCK.TextVarResolver (   self,
  aToken,
  aProject 
)
TextVarResolver(TITLE_BLOCK self, wxString aToken, PROJECT const * aProject) -> bool

Definition at line 2284 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 2227 of file pcbnew.py.


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