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.

 {
 TITLE_IDX = 0,
 DATE_IDX,
 REVISION_IDX,
 COMPANY_IDX,
 COMMENT1_IDX // idx of the first comment: one can have more than 1 comment
 };

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.

{}; // a virtual dtor seems needed to build

Member Function Documentation

Clear()

void TITLE_BLOCK::Clear ( )

inline

Definition at line 113 of file title_block.h.

 {
 m_tbTexts.Clear();
 }

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

aFormatter	The OUTPUTFORMATTER object to write to.
aNestLevel	The indentation next level.
aControlBits	The control bit definition for object specific formatting.

Exceptions

IO_ERROR

on write error.

Definition at line 30 of file title_block.cpp.

{
 // Don't write the title block information if there is nothing to write.
 bool isempty = true;
 for( unsigned idx = 0; idx < m_tbTexts.GetCount(); idx++ )
 {
 if( ! m_tbTexts[idx].IsEmpty() )
 {
 isempty = false;
 break;
 }
 }
 
 if( !isempty )
 {
 aFormatter->Print( aNestLevel, "(title_block\n" );
 
 if( !GetTitle().IsEmpty() )
 aFormatter->Print( aNestLevel+1, "(title %s)\n",
 aFormatter->Quotew( GetTitle() ).c_str() );
 
 if( !GetDate().IsEmpty() )
 aFormatter->Print( aNestLevel+1, "(date %s)\n",
 aFormatter->Quotew( GetDate() ).c_str() );
 
 if( !GetRevision().IsEmpty() )
 aFormatter->Print( aNestLevel+1, "(rev %s)\n",
 aFormatter->Quotew( GetRevision() ).c_str() );
 
 if( !GetCompany().IsEmpty() )
 aFormatter->Print( aNestLevel+1, "(company %s)\n",
 aFormatter->Quotew( GetCompany() ).c_str() );
 
 for( int ii = 0; ii < 9; ii++ )
 {
 if( !GetComment(ii).IsEmpty() )
 aFormatter->Print( aNestLevel+1, "(comment %d %s)\n", ii+1,
 aFormatter->Quotew( GetComment(ii) ).c_str() );
 }
 
 aFormatter->Print( aNestLevel, ")\n\n" );
 }
}

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

Referenced by SCH_SEXPR_PLUGIN::Format(), and PCB_PLUGIN::formatGeneral().

GetComment()

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

inline

Definition at line 107 of file title_block.h.

 {
 aIdx += COMMENT1_IDX;
 return getTbText( aIdx );
 }

References COMMENT1_IDX, and getTbText().

Referenced by BOOST_AUTO_TEST_CASE(), Format(), SCH_LEGACY_PLUGIN::Format(), NETLIST_EXPORTER_XML::makeDesignHeader(), DIALOG_EESCHEMA_PAGE_SETTINGS::onSavePageSettings(), TextVarResolver(), and DIALOG_PAGES_SETTINGS::TransferDataToWindow().

GetCompany()

const wxString & TITLE_BLOCK::GetCompany ( ) const

inline

Definition at line 96 of file title_block.h.

 {
 return getTbText( COMPANY_IDX );
 }

References COMPANY_IDX, and getTbText().

Referenced by Format(), SCH_LEGACY_PLUGIN::Format(), 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 74 of file title_block.cpp.

{
 if( !alg::contains( *aVars, wxT( "ISSUE_DATE" ) ) )
 {
 aVars->push_back( wxT( "ISSUE_DATE" ) );
 aVars->push_back( wxT( "CURRENT_DATE" ) );
 aVars->push_back( wxT( "REVISION" ) );
 aVars->push_back( wxT( "TITLE" ) );
 aVars->push_back( wxT( "COMPANY" ) );
 aVars->push_back( wxT( "COMMENT1" ) );
 aVars->push_back( wxT( "COMMENT2" ) );
 aVars->push_back( wxT( "COMMENT3" ) );
 aVars->push_back( wxT( "COMMENT4" ) );
 aVars->push_back( wxT( "COMMENT5" ) );
 aVars->push_back( wxT( "COMMENT6" ) );
 aVars->push_back( wxT( "COMMENT7" ) );
 aVars->push_back( wxT( "COMMENT8" ) );
 aVars->push_back( wxT( "COMMENT9" ) );
 }
}

References alg::contains().

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

GetDate()

const wxString & TITLE_BLOCK::GetDate ( ) const

inline

Definition at line 76 of file title_block.h.

 {
 return getTbText( DATE_IDX );
 }

References DATE_IDX, and getTbText().

Referenced by CreateHeaderInfoData(), Format(), SCH_LEGACY_PLUGIN::Format(), 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.

 {
 return getTbText( REVISION_IDX );
 }

References getTbText(), and REVISION_IDX.

Referenced by AddGerberX2Header(), GERBER_JOBFILE_WRITER::addJSONGeneralSpecs(), CreateHeaderInfoData(), Format(), SCH_LEGACY_PLUGIN::Format(), 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 142 of file title_block.h.

 {
 static const wxString m_emptytext;
 
 if( (int)m_tbTexts.GetCount() > aIdx )
 return m_tbTexts[aIdx];
 else
 return m_emptytext;
 }

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.

 {
 return getTbText( TITLE_IDX );
 }

References getTbText(), and TITLE_IDX.

Referenced by BOOST_AUTO_TEST_CASE(), SCH_PLOTTER::createPDFFile(), Format(), SCH_LEGACY_PLUGIN::Format(), NETLIST_EXPORTER_XML::makeDesignHeader(), DIALOG_EESCHEMA_PAGE_SETTINGS::onSavePageSettings(), 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.

 {
 aIdx += COMMENT1_IDX;
 return setTbText( aIdx, aComment );
 }

References COMMENT1_IDX, and setTbText().

Referenced by SCH_LEGACY_PLUGIN::loadPageSettings(), LEGACY_PLUGIN::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_PARSER::parseTITLE_BLOCK(), SCH_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.

 {
 setTbText( COMPANY_IDX, aCompany );
 }

References COMPANY_IDX, and setTbText().

Referenced by SCH_LEGACY_PLUGIN::loadPageSettings(), LEGACY_PLUGIN::loadSHEET(), DIALOG_PAGES_SETTINGS::OnCompanyTextUpdated(), DIALOG_EESCHEMA_PAGE_SETTINGS::onSavePageSettings(), PCB_PARSER::parseTITLE_BLOCK(), SCH_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.

 {
 setTbText( DATE_IDX, aDate );
 }

References DATE_IDX, and setTbText().

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), PANEL_PCBNEW_COLOR_SETTINGS::createPreviewItems(), SCH_LEGACY_PLUGIN::loadPageSettings(), LEGACY_PLUGIN::loadSHEET(), DIALOG_PAGES_SETTINGS::OnDateTextUpdated(), DIALOG_EESCHEMA_PAGE_SETTINGS::onSavePageSettings(), PCB_PARSER::parseTITLE_BLOCK(), SCH_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.

 {
 setTbText( REVISION_IDX, aRevision );
 }

References REVISION_IDX, and setTbText().

Referenced by SCH_LEGACY_PLUGIN::loadPageSettings(), LEGACY_PLUGIN::loadSHEET(), DIALOG_PAGES_SETTINGS::OnRevisionTextUpdated(), DIALOG_EESCHEMA_PAGE_SETTINGS::onSavePageSettings(), PCB_PARSER::parseTITLE_BLOCK(), SCH_SEXPR_PARSER::parseTITLE_BLOCK(), and DIALOG_PAGES_SETTINGS::SavePageSettings().

setTbText()

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

inlineprivate

Definition at line 134 of file title_block.h.

 {
 if( (int)m_tbTexts.GetCount() <= aIdx )
 m_tbTexts.Add( wxEmptyString, aIdx + 1 - m_tbTexts.GetCount() );
 
 m_tbTexts[aIdx] = aText;
 }

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.

 {
 setTbText( TITLE_IDX, aTitle );
 }

References setTbText(), and TITLE_IDX.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), PANEL_PCBNEW_COLOR_SETTINGS::createPreviewItems(), SCH_LEGACY_PLUGIN::loadPageSettings(), LEGACY_PLUGIN::loadSHEET(), DIALOG_EESCHEMA_PAGE_SETTINGS::onSavePageSettings(), DIALOG_PAGES_SETTINGS::OnTitleTextUpdated(), PCB_PARSER::parseTITLE_BLOCK(), SCH_SEXPR_PARSER::parseTITLE_BLOCK(), DIALOG_PAGES_SETTINGS::SavePageSettings(), and TitleBlockFixture::TitleBlockFixture().

TextVarResolver()

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

Definition at line 96 of file title_block.cpp.

{
 bool tokenUpdated = false;
 wxString originalToken = *aToken;
 
 if( aToken->IsSameAs( wxT( "ISSUE_DATE" ) ) )
 {
 *aToken = GetDate();
 tokenUpdated = true;
 }
 else if( aToken->IsSameAs( wxT( "CURRENT_DATE" ) ) )
 {
 // We can choose different formats. Should probably be kept in sync with ISSUE_DATE
 // formatting in DIALOG_PAGES_SETTINGS.
 //
 // *aToken = wxDateTime::Now().Format( wxLocale::GetInfo( wxLOCALE_SHORT_DATE_FMT ) );
 // *aToken = wxDateTime::Now().Format( wxLocale::GetInfo( wxLOCALE_LONG_DATE_FMT ) );
 // *aToken = wxDateTime::Now().Format( wxT("%Y-%b-%d") );
 *aToken = wxDateTime::Now().FormatISODate();
 
 tokenUpdated = true;
 }
 else if( aToken->IsSameAs( wxT( "REVISION" ) ) )
 {
 *aToken = GetRevision();
 tokenUpdated = true;
 }
 else if( aToken->IsSameAs( wxT( "TITLE" ) ) )
 {
 *aToken = GetTitle();
 tokenUpdated = true;
 }
 else if( aToken->IsSameAs( wxT( "COMPANY" ) ) )
 {
 *aToken = GetCompany();
 tokenUpdated = true;
 }
 else if( aToken->Left( aToken->Len() - 1 ).IsSameAs( wxT( "COMMENT" ) ) )
 {
 wxChar c = aToken->Last();
 
 switch( c )
 {
 case '1':
 case '2':
 case '3':
 case '4':
 case '5':
 case '6':
 case '7':
 case '8':
 case '9':
 *aToken = GetComment( c - '1' );
 tokenUpdated = true;
 }
 }
 
 if( tokenUpdated )
 {
 if( aProject )
 *aToken = ExpandTextVars( *aToken, aProject );
 
 // This is the default fallback, so don't claim we resolved it
 if( *aToken == wxT( "${" ) + originalToken + wxT( "}" ) )
 return false;
 
 return true;
 }
 
 return false;
}

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

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

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:

• title_block.h
• title_block.cpp