KiCAD pcbnew scripting
Public Member Functions | Public Attributes | 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 SetComment1 (self, aComment)
 
def SetComment2 (self, aComment)
 
def SetComment3 (self, aComment)
 
def SetComment4 (self, aComment)
 
def GetComment1 (self)
 
def GetComment2 (self)
 
def GetComment3 (self)
 
def GetComment4 (self)
 
def Clear (self)
 
def Format (self, aFormatter, aNestLevel, aControlBits)
 

Public Attributes

 this
 

Detailed Description

Class TITLE_BLOCK holds the information shown in the lower right
corner of a plot, printout, or editing view.

Dick Hollenbeck

C++ includes: class_title_block.h 

Definition at line 2846 of file pcbnew.py.

Constructor & Destructor Documentation

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

TITLE_BLOCK::TITLE_BLOCK() 

Definition at line 2863 of file pcbnew.py.

Member Function Documentation

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

void TITLE_BLOCK::Clear()

Definition at line 3060 of file pcbnew.py.

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

void
TITLE_BLOCK::Format(OUTPUTFORMATTER *aFormatter, int aNestLevel, int
aControlBits) const

Function Format outputs the object to aFormatter in s-expression form.

Parameters:
-----------

aFormatter:  The OUTPUTFORMATTER object to write to.

aNestLevel:  The indentation next level.

aControlBits:  The control bit definition for object specific
formatting.

Parameters:
-----------

???:  on write error. 

Definition at line 3070 of file pcbnew.py.

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

const wxString&
TITLE_BLOCK::GetComment(int aIdx) const 

Definition at line 2970 of file pcbnew.py.

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

const wxString&
TITLE_BLOCK::GetComment1() const 

Definition at line 3020 of file pcbnew.py.

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

const wxString&
TITLE_BLOCK::GetComment2() const 

Definition at line 3030 of file pcbnew.py.

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

const wxString&
TITLE_BLOCK::GetComment3() const 

Definition at line 3040 of file pcbnew.py.

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

const wxString&
TITLE_BLOCK::GetComment4() const 

Definition at line 3050 of file pcbnew.py.

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

const wxString&
TITLE_BLOCK::GetCompany() const 

Definition at line 2950 of file pcbnew.py.

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

const wxString&
TITLE_BLOCK::GetDate() const 

Definition at line 2910 of file pcbnew.py.

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

const wxString&
TITLE_BLOCK::GetRevision() const 

Definition at line 2930 of file pcbnew.py.

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

const wxString&
TITLE_BLOCK::GetTitle() const 

Definition at line 2887 of file pcbnew.py.

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

void
TITLE_BLOCK::SetComment(int aIdx, const wxString &aComment) 

Definition at line 2960 of file pcbnew.py.

def pcbnew.TITLE_BLOCK.SetComment1 (   self,
  aComment 
)
SetComment1(TITLE_BLOCK self, wxString aComment)

void
TITLE_BLOCK::SetComment1(const wxString &aComment) 

Definition at line 2980 of file pcbnew.py.

def pcbnew.TITLE_BLOCK.SetComment2 (   self,
  aComment 
)
SetComment2(TITLE_BLOCK self, wxString aComment)

void
TITLE_BLOCK::SetComment2(const wxString &aComment) 

Definition at line 2990 of file pcbnew.py.

def pcbnew.TITLE_BLOCK.SetComment3 (   self,
  aComment 
)
SetComment3(TITLE_BLOCK self, wxString aComment)

void
TITLE_BLOCK::SetComment3(const wxString &aComment) 

Definition at line 3000 of file pcbnew.py.

def pcbnew.TITLE_BLOCK.SetComment4 (   self,
  aComment 
)
SetComment4(TITLE_BLOCK self, wxString aComment)

void
TITLE_BLOCK::SetComment4(const wxString &aComment) 

Definition at line 3010 of file pcbnew.py.

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

void
TITLE_BLOCK::SetCompany(const wxString &aCompany) 

Definition at line 2940 of file pcbnew.py.

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

void
TITLE_BLOCK::SetDate(const wxString &aDate)

Function SetDate sets the date field, and defaults to the current time
and date. 

Definition at line 2897 of file pcbnew.py.

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

void
TITLE_BLOCK::SetRevision(const wxString &aRevision) 

Definition at line 2920 of file pcbnew.py.

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

void
TITLE_BLOCK::SetTitle(const wxString &aTitle) 

Definition at line 2877 of file pcbnew.py.

Member Data Documentation

pcbnew.TITLE_BLOCK.this

Definition at line 2873 of file pcbnew.py.


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