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)
 
"void" SetTitle (self, "wxString" aTitle)
 
"wxString const &" GetTitle (self)
 
"void" SetDate (self, "wxString" aDate)
 
"wxString const &" GetDate (self)
 
"void" SetRevision (self, "wxString" aRevision)
 
"wxString const &" GetRevision (self)
 
"void" SetCompany (self, "wxString" aCompany)
 
"wxString const &" GetCompany (self)
 
"void" SetComment (self, "int" aIdx, "wxString" aComment)
 
"wxString const &" GetComment (self, "int" aIdx)
 
"void" Clear (self)
 
"bool" TextVarResolver (self, "wxString" aToken, "PROJECT const *" aProject)
 
"void" Format (self, "OUTPUTFORMATTER" aFormatter, "int" aNestLevel, "int" aControlBits)
 

Static Public Member Functions

"void" GetContextualTextVars ("wxArrayString *" 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 2095 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 2101 of file pcbnew.py.

Member Function Documentation

◆ Clear()

"void" pcbnew.TITLE_BLOCK.Clear (   self)
Clear(TITLE_BLOCK self)

Definition at line 2146 of file pcbnew.py.

◆ Format()

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

Definition at line 2159 of file pcbnew.py.

◆ GetComment()

"wxString const &" pcbnew.TITLE_BLOCK.GetComment (   self,
"int"  aIdx 
)
GetComment(TITLE_BLOCK self, int aIdx) -> wxString

Definition at line 2142 of file pcbnew.py.

◆ GetCompany()

"wxString const &" pcbnew.TITLE_BLOCK.GetCompany (   self)
GetCompany(TITLE_BLOCK self) -> wxString

Definition at line 2134 of file pcbnew.py.

◆ GetContextualTextVars()

"void" pcbnew.TITLE_BLOCK.GetContextualTextVars ( "wxArrayString *"  aVars)
static
GetContextualTextVars(wxArrayString * aVars)

Definition at line 2151 of file pcbnew.py.

◆ GetDate()

"wxString const &" pcbnew.TITLE_BLOCK.GetDate (   self)
GetDate(TITLE_BLOCK self) -> wxString

Definition at line 2118 of file pcbnew.py.

◆ GetRevision()

"wxString const &" pcbnew.TITLE_BLOCK.GetRevision (   self)
GetRevision(TITLE_BLOCK self) -> wxString

Definition at line 2126 of file pcbnew.py.

◆ GetTitle()

"wxString const &" pcbnew.TITLE_BLOCK.GetTitle (   self)
GetTitle(TITLE_BLOCK self) -> wxString

Definition at line 2110 of file pcbnew.py.

◆ SetComment()

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

Definition at line 2138 of file pcbnew.py.

◆ SetCompany()

"void" pcbnew.TITLE_BLOCK.SetCompany (   self,
"wxString"  aCompany 
)
SetCompany(TITLE_BLOCK self, wxString aCompany)

Definition at line 2130 of file pcbnew.py.

◆ SetDate()

"void" pcbnew.TITLE_BLOCK.SetDate (   self,
"wxString"  aDate 
)
SetDate(TITLE_BLOCK self, wxString aDate)

Definition at line 2114 of file pcbnew.py.

◆ SetRevision()

"void" pcbnew.TITLE_BLOCK.SetRevision (   self,
"wxString"  aRevision 
)
SetRevision(TITLE_BLOCK self, wxString aRevision)

Definition at line 2122 of file pcbnew.py.

◆ SetTitle()

"void" pcbnew.TITLE_BLOCK.SetTitle (   self,
"wxString"  aTitle 
)
SetTitle(TITLE_BLOCK self, wxString aTitle)

Definition at line 2106 of file pcbnew.py.

◆ TextVarResolver()

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

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


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