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.
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, int aFlags=0) const
virtual void	Format (OUTPUTFORMATTER *aFormatter) const
	Output the object to aFormatter in s-expression form.

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 ) const

virtual

Output the object to aFormatter in s-expression form.

Parameters

aFormatter

The OUTPUTFORMATTER object to write to.

Exceptions

IO_ERROR

on 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()

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

inline

Definition at line 107 of file title_block.h.

References COMMENT1_IDX, and getTbText().

Referenced by BOOST_AUTO_TEST_CASE(), Format(), SCH_IO_KICAD_LEGACY::Format(), API_HANDLER_PCB::handleGetTitleBlockInfo(), SCH_EDIT_FRAME::InitSheet(), NETLIST_EXPORTER_XML::makeDesignHeader(), DIALOG_EESCHEMA_PAGE_SETTINGS::onSavePageSettings(), BOARD::operator==(), TextVarResolver(), and DIALOG_PAGES_SETTINGS::TransferDataToWindow().

GetCompany()

const wxString & TITLE_BLOCK::GetCompany ( ) const

inline

Definition at line 96 of file title_block.h.

References COMPANY_IDX, and getTbText().

Referenced by Format(), SCH_IO_KICAD_LEGACY::Format(), API_HANDLER_PCB::handleGetTitleBlockInfo(), SCH_EDIT_FRAME::InitSheet(), NETLIST_EXPORTER_XML::makeDesignHeader(), DIALOG_EESCHEMA_PAGE_SETTINGS::onSavePageSettings(), TextVarResolver(), and DIALOG_PAGES_SETTINGS::TransferDataToWindow().

GetContextualTextVars()

void TITLE_BLOCK::GetContextualTextVars ( wxArrayString *  aVars )

static

Definition at line 73 of file title_block.cpp.

References alg::contains().

Referenced by SCH_SHEET::GetContextualTextVars(), SCHEMATIC::GetContextualTextVars(), BOARD::GetContextualTextVars(), DS_DRAW_ITEM_LIST::GetTextVars(), and BOARD::operator==().

GetDate()

const wxString & TITLE_BLOCK::GetDate ( ) const

inline

Definition at line 76 of file title_block.h.

References DATE_IDX, and getTbText().

Referenced by GENCAD_EXPORTER::CreateHeaderInfoData(), Format(), SCH_IO_KICAD_LEGACY::Format(), API_HANDLER_PCB::handleGetTitleBlockInfo(), SCH_EDIT_FRAME::InitSheet(), NETLIST_EXPORTER_XML::makeDesignHeader(), DIALOG_EESCHEMA_PAGE_SETTINGS::onSavePageSettings(), TextVarResolver(), and DIALOG_PAGES_SETTINGS::TransferDataToWindow().

GetRevision()

const wxString & TITLE_BLOCK::GetRevision ( ) const

inline

Definition at line 86 of file title_block.h.

References getTbText(), and REVISION_IDX.

Referenced by AddGerberX2Header(), GERBER_JOBFILE_WRITER::addJSONGeneralSpecs(), GENCAD_EXPORTER::CreateHeaderInfoData(), Format(), SCH_IO_KICAD_LEGACY::Format(), API_HANDLER_PCB::handleGetTitleBlockInfo(), SCH_EDIT_FRAME::InitSheet(), NETLIST_EXPORTER_XML::makeDesignHeader(), DIALOG_EESCHEMA_PAGE_SETTINGS::onSavePageSettings(), TextVarResolver(), and DIALOG_PAGES_SETTINGS::TransferDataToWindow().

getTbText()

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

inlineprivate

Definition at line 140 of file title_block.h.

References m_tbTexts.

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

GetTitle()

const wxString & TITLE_BLOCK::GetTitle ( ) const

inline

Definition at line 63 of file title_block.h.

References getTbText(), and TITLE_IDX.

Referenced by BOOST_AUTO_TEST_CASE(), SCH_PLOTTER::createPDFFile(), Format(), SCH_IO_KICAD_LEGACY::Format(), API_HANDLER_PCB::handleGetTitleBlockInfo(), SCH_EDIT_FRAME::InitSheet(), NETLIST_EXPORTER_XML::makeDesignHeader(), DIALOG_EESCHEMA_PAGE_SETTINGS::onSavePageSettings(), DIALOG_PLOT::Plot(), TextVarResolver(), and DIALOG_PAGES_SETTINGS::TransferDataToWindow().

SetComment()

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

inline

Definition at line 101 of file title_block.h.

References COMMENT1_IDX, and setTbText().

Referenced by SCH_EDIT_FRAME::InitSheet(), SCH_IO_KICAD_LEGACY::loadPageSettings(), PCB_IO_KICAD_LEGACY::loadSHEET(), DIALOG_PAGES_SETTINGS::OnComment1TextUpdated(), DIALOG_PAGES_SETTINGS::OnComment2TextUpdated(), DIALOG_PAGES_SETTINGS::OnComment3TextUpdated(), DIALOG_PAGES_SETTINGS::OnComment4TextUpdated(), DIALOG_PAGES_SETTINGS::OnComment5TextUpdated(), DIALOG_PAGES_SETTINGS::OnComment6TextUpdated(), DIALOG_PAGES_SETTINGS::OnComment7TextUpdated(), DIALOG_PAGES_SETTINGS::OnComment8TextUpdated(), DIALOG_PAGES_SETTINGS::OnComment9TextUpdated(), DIALOG_EESCHEMA_PAGE_SETTINGS::onSavePageSettings(), PCB_IO_KICAD_SEXPR_PARSER::parseTITLE_BLOCK(), SCH_IO_KICAD_SEXPR_PARSER::parseTITLE_BLOCK(), DIALOG_PAGES_SETTINGS::SavePageSettings(), and TitleBlockFixture::TitleBlockFixture().

SetCompany()

void TITLE_BLOCK::SetCompany ( const wxString &  aCompany )

inline

Definition at line 91 of file title_block.h.

References COMPANY_IDX, and setTbText().

Referenced by SCH_EDIT_FRAME::InitSheet(), SCH_IO_KICAD_LEGACY::loadPageSettings(), PCB_IO_KICAD_LEGACY::loadSHEET(), DIALOG_PAGES_SETTINGS::OnCompanyTextUpdated(), DIALOG_EESCHEMA_PAGE_SETTINGS::onSavePageSettings(), PCB_IO_KICAD_SEXPR_PARSER::parseTITLE_BLOCK(), SCH_IO_KICAD_SEXPR_PARSER::parseTITLE_BLOCK(), DIALOG_PAGES_SETTINGS::SavePageSettings(), and TitleBlockFixture::TitleBlockFixture().

SetDate()

void TITLE_BLOCK::SetDate ( const wxString &  aDate )

inline

Set the date field, and defaults to the current time and date.

Definition at line 71 of file title_block.h.

References DATE_IDX, and setTbText().

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), PANEL_PCBNEW_COLOR_SETTINGS::createPreviewItems(), SCH_EDIT_FRAME::InitSheet(), SCH_IO_KICAD_LEGACY::loadPageSettings(), PCB_IO_KICAD_LEGACY::loadSHEET(), DIALOG_PAGES_SETTINGS::OnDateTextUpdated(), DIALOG_EESCHEMA_PAGE_SETTINGS::onSavePageSettings(), PCB_IO_KICAD_SEXPR_PARSER::parseTITLE_BLOCK(), SCH_IO_KICAD_SEXPR_PARSER::parseTITLE_BLOCK(), DIALOG_PAGES_SETTINGS::SavePageSettings(), and TitleBlockFixture::TitleBlockFixture().

SetRevision()

void TITLE_BLOCK::SetRevision ( const wxString &  aRevision )

inline

Definition at line 81 of file title_block.h.

References REVISION_IDX, and setTbText().

Referenced by SCH_EDIT_FRAME::InitSheet(), SCH_IO_KICAD_LEGACY::loadPageSettings(), PCB_IO_KICAD_LEGACY::loadSHEET(), DIALOG_PAGES_SETTINGS::OnRevisionTextUpdated(), DIALOG_EESCHEMA_PAGE_SETTINGS::onSavePageSettings(), PCB_IO_KICAD_SEXPR_PARSER::parseTITLE_BLOCK(), SCH_IO_KICAD_SEXPR_PARSER::parseTITLE_BLOCK(), and DIALOG_PAGES_SETTINGS::SavePageSettings().

setTbText()

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

inlineprivate

Definition at line 132 of file title_block.h.

References m_tbTexts.

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

SetTitle()

void TITLE_BLOCK::SetTitle ( const wxString &  aTitle )

inline

Definition at line 58 of file title_block.h.

References setTbText(), and TITLE_IDX.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), PANEL_PCBNEW_COLOR_SETTINGS::createPreviewItems(), SCH_EDIT_FRAME::InitSheet(), SCH_IO_KICAD_LEGACY::loadPageSettings(), PCB_IO_KICAD_LEGACY::loadSHEET(), DIALOG_EESCHEMA_PAGE_SETTINGS::onSavePageSettings(), DIALOG_PAGES_SETTINGS::OnTitleTextUpdated(), PCB_IO_KICAD_SEXPR_PARSER::parseTITLE_BLOCK(), SCH_IO_KICAD_SEXPR_PARSER::parseTITLE_BLOCK(), DIALOG_PAGES_SETTINGS::SavePageSettings(), and TitleBlockFixture::TitleBlockFixture().

TextVarResolver()

bool TITLE_BLOCK::TextVarResolver	(	wxString *	aToken,
		const PROJECT *	aProject,
		int	aFlags = 0
	)		const

Definition at line 95 of file title_block.cpp.

References ExpandTextVars(), GetComment(), GetCompany(), GetDate(), GetRevision(), and GetTitle().

Referenced by SCH_SHEET::ResolveTextVar(), and SCHEMATIC::ResolveTextVar().

Member Data Documentation

m_tbTexts

wxArrayString TITLE_BLOCK::m_tbTexts

private

Definition at line 130 of file title_block.h.

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

---

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

• title_block.h
• title_block.cpp