KiCad PCB EDA Suite
Loading...
Searching...
No Matches
TITLE_BLOCK Class Reference

Hold the information shown in the lower right corner of a plot, printout, or editing view. More...

#include <title_block.h>

Public Member Functions

 TITLE_BLOCK ()
 
virtual ~TITLE_BLOCK ()
 
void SetTitle (const wxString &aTitle)
 
const wxString & GetTitle () const
 
void SetDate (const wxString &aDate)
 Set the date field, and defaults to the current time and date. More...
 
const wxString & GetDate () const
 
void SetRevision (const wxString &aRevision)
 
const wxString & GetRevision () const
 
void SetCompany (const wxString &aCompany)
 
const wxString & GetCompany () const
 
void SetComment (int aIdx, const wxString &aComment)
 
const wxString & GetComment (int aIdx) const
 
void Clear ()
 
bool TextVarResolver (wxString *aToken, const PROJECT *aProject) const
 
virtual void Format (OUTPUTFORMATTER *aFormatter, int aNestLevel, int aControlBits) const
 Output the object to aFormatter in s-expression form. More...
 

Static Public Member Functions

static void GetContextualTextVars (wxArrayString *aVars)
 

Private Types

enum  TEXTS_IDX {
  TITLE_IDX = 0 , DATE_IDX , REVISION_IDX , COMPANY_IDX ,
  COMMENT1_IDX
}
 

Private Member Functions

void setTbText (int aIdx, const wxString &aText)
 
const wxString & getTbText (int aIdx) const
 

Private Attributes

wxArrayString m_tbTexts
 

Detailed Description

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

Definition at line 40 of file title_block.h.

Member Enumeration Documentation

◆ TEXTS_IDX

enum TITLE_BLOCK::TEXTS_IDX
private
Enumerator
TITLE_IDX 
DATE_IDX 
REVISION_IDX 
COMPANY_IDX 
COMMENT1_IDX 

Definition at line 44 of file title_block.h.

Constructor & Destructor Documentation

◆ TITLE_BLOCK()

TITLE_BLOCK::TITLE_BLOCK ( )
inline

Definition at line 54 of file title_block.h.

◆ ~TITLE_BLOCK()

virtual TITLE_BLOCK::~TITLE_BLOCK ( )
inlinevirtual

Definition at line 55 of file title_block.h.

Member Function Documentation

◆ Clear()

void TITLE_BLOCK::Clear ( )
inline

Definition at line 113 of file title_block.h.

References m_tbTexts.

Referenced by SCH_SCREEN::Clear().

◆ Format()

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

Output the object to aFormatter in s-expression form.

Parameters
aFormatterThe OUTPUTFORMATTER object to write to.
aNestLevelThe indentation next level.
aControlBitsThe control bit definition for object specific formatting.
Exceptions
IO_ERRORon write error.

Definition at line 30 of file title_block.cpp.

References GetComment(), GetCompany(), GetDate(), GetRevision(), GetTitle(), m_tbTexts, OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().

Referenced by SCH_IO_KICAD_SEXPR::Format(), and PCB_IO_KICAD_SEXPR::formatGeneral().

◆ GetComment()

◆ GetCompany()

◆ GetContextualTextVars()

void TITLE_BLOCK::GetContextualTextVars ( wxArrayString *  aVars)
static

◆ GetDate()

◆ GetRevision()

◆ getTbText()

const wxString & TITLE_BLOCK::getTbText ( int  aIdx) const
inlineprivate

Definition at line 142 of file title_block.h.

References m_tbTexts.

Referenced by GetComment(), GetCompany(), GetDate(), GetRevision(), and GetTitle().

◆ GetTitle()

◆ SetComment()

◆ SetCompany()

◆ SetDate()

◆ SetRevision()

◆ setTbText()

void TITLE_BLOCK::setTbText ( int  aIdx,
const wxString &  aText 
)
inlineprivate

Definition at line 134 of file title_block.h.

References m_tbTexts.

Referenced by SetComment(), SetCompany(), SetDate(), SetRevision(), and SetTitle().

◆ SetTitle()

◆ TextVarResolver()

bool TITLE_BLOCK::TextVarResolver ( wxString *  aToken,
const PROJECT aProject 
) const

Member Data Documentation

◆ m_tbTexts

wxArrayString TITLE_BLOCK::m_tbTexts
private

Definition at line 132 of file title_block.h.

Referenced by Clear(), Format(), getTbText(), and setTbText().


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