KiCad PCB EDA Suite
ABOUT_APP_INFO Class Reference

An object of this class is meant to be used to store application specific information like who has contributed in which area of the application, the license, copyright and other descriptive information. More...

#include <aboutinfo.h>

Public Member Functions

 ABOUT_APP_INFO ()
 
virtual ~ABOUT_APP_INFO ()
 
void AddDeveloper (const CONTRIBUTOR *developer)
 
void AddDocWriter (const CONTRIBUTOR *docwriter)
 
void AddLibrarian (const CONTRIBUTOR *aLibrarian)
 
void AddArtist (const CONTRIBUTOR *artist)
 
void AddTranslator (const CONTRIBUTOR *translator)
 
void AddPackager (const CONTRIBUTOR *packager)
 
CONTRIBUTORS GetDevelopers ()
 
CONTRIBUTORS GetDocWriters ()
 
CONTRIBUTORS GetLibrarians ()
 
CONTRIBUTORS GetArtists ()
 
CONTRIBUTORS GetTranslators ()
 
CONTRIBUTORS GetPackagers ()
 
void SetDescription (const wxString &text)
 
wxString & GetDescription ()
 
void SetLicense (const wxString &text)
 
wxString & GetLicense ()
 
void SetCopyright (const wxString &text)
 
wxString GetCopyright ()
 
void SetAppName (const wxString &name)
 
wxString & GetAppName ()
 
void SetBuildVersion (const wxString &version)
 
wxString & GetBuildVersion ()
 
void SetBuildDate (const wxString &date)
 
wxString & GetBuildDate ()
 
void SetLibVersion (const wxString &version)
 
wxString & GetLibVersion ()
 
void SetAppIcon (const wxIcon &aIcon)
 
wxIcon & GetAppIcon ()
 Wrapper to manage memory allocation for bitmaps. More...
 
wxBitmap * CreateKiBitmap (BITMAPS aBitmap)
 

Private Attributes

CONTRIBUTORS mDevelopers
 
CONTRIBUTORS mDocWriters
 
CONTRIBUTORS mLibrarians
 
CONTRIBUTORS mArtists
 
CONTRIBUTORS mTranslators
 
CONTRIBUTORS mPackagers
 
wxString description
 
wxString license
 
wxString copyright
 
wxString appName
 
wxString buildVersion
 
wxString buildDate
 
wxString libVersion
 
wxIcon m_appIcon
 Bitmaps to be freed when the dialog is closed. More...
 
std::vector< std::unique_ptr< wxBitmap > > m_bitmaps
 

Detailed Description

An object of this class is meant to be used to store application specific information like who has contributed in which area of the application, the license, copyright and other descriptive information.

Definition at line 44 of file aboutinfo.h.

Constructor & Destructor Documentation

◆ ABOUT_APP_INFO()

ABOUT_APP_INFO::ABOUT_APP_INFO ( )
inline

Definition at line 47 of file aboutinfo.h.

47 {};

◆ ~ABOUT_APP_INFO()

virtual ABOUT_APP_INFO::~ABOUT_APP_INFO ( )
inlinevirtual

Definition at line 48 of file aboutinfo.h.

48 {};

Member Function Documentation

◆ AddArtist()

void ABOUT_APP_INFO::AddArtist ( const CONTRIBUTOR artist)
inline

Definition at line 68 of file aboutinfo.h.

69  {
70  if( artist != NULL )
71  mArtists.Add( artist );
72  }
#define NULL
CONTRIBUTORS mArtists
Definition: aboutinfo.h:128

References mArtists, and NULL.

Referenced by buildKicadAboutBanner().

◆ AddDeveloper()

void ABOUT_APP_INFO::AddDeveloper ( const CONTRIBUTOR developer)
inline

Definition at line 50 of file aboutinfo.h.

51  {
52  if( developer != NULL )
53  mDevelopers.Add( developer );
54  }
CONTRIBUTORS mDevelopers
Definition: aboutinfo.h:125
#define NULL

References mDevelopers, and NULL.

Referenced by buildKicadAboutBanner().

◆ AddDocWriter()

void ABOUT_APP_INFO::AddDocWriter ( const CONTRIBUTOR docwriter)
inline

Definition at line 56 of file aboutinfo.h.

57  {
58  if( docwriter != NULL )
59  mDocWriters.Add( docwriter );
60  }
CONTRIBUTORS mDocWriters
Definition: aboutinfo.h:126
#define NULL

References mDocWriters, and NULL.

Referenced by buildKicadAboutBanner().

◆ AddLibrarian()

void ABOUT_APP_INFO::AddLibrarian ( const CONTRIBUTOR aLibrarian)
inline

Definition at line 62 of file aboutinfo.h.

63  {
64  if( aLibrarian )
65  mLibrarians.Add( aLibrarian );
66  }
CONTRIBUTORS mLibrarians
Definition: aboutinfo.h:127

References mLibrarians.

Referenced by buildKicadAboutBanner().

◆ AddPackager()

void ABOUT_APP_INFO::AddPackager ( const CONTRIBUTOR packager)
inline

Definition at line 80 of file aboutinfo.h.

81  {
82  if( packager != NULL )
83  mPackagers.Add( packager );
84  }
CONTRIBUTORS mPackagers
Definition: aboutinfo.h:130
#define NULL

References mPackagers, and NULL.

Referenced by buildKicadAboutBanner().

◆ AddTranslator()

void ABOUT_APP_INFO::AddTranslator ( const CONTRIBUTOR translator)
inline

Definition at line 74 of file aboutinfo.h.

75  {
76  if( translator != NULL )
77  mTranslators.Add( translator );
78  }
#define NULL
CONTRIBUTORS mTranslators
Definition: aboutinfo.h:129

References mTranslators, and NULL.

Referenced by buildKicadAboutBanner().

◆ CreateKiBitmap()

wxBitmap* ABOUT_APP_INFO::CreateKiBitmap ( BITMAPS  aBitmap)
inline

Definition at line 118 of file aboutinfo.h.

119  {
120  m_bitmaps.emplace_back( KiBitmapNew( aBitmap ) );
121  return m_bitmaps.back().get();
122  }
std::vector< std::unique_ptr< wxBitmap > > m_bitmaps
Definition: aboutinfo.h:144
wxBitmap * KiBitmapNew(BITMAPS aBitmap)
Allocate a wxBitmap on heap from a memory record, held in a BITMAPS.
Definition: bitmap.cpp:196

References KiBitmapNew(), and m_bitmaps.

Referenced by buildKicadAboutBanner().

◆ GetAppIcon()

wxIcon& ABOUT_APP_INFO::GetAppIcon ( )
inline

Wrapper to manage memory allocation for bitmaps.

Definition at line 115 of file aboutinfo.h.

References m_appIcon.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT().

◆ GetAppName()

wxString& ABOUT_APP_INFO::GetAppName ( )
inline

Definition at line 103 of file aboutinfo.h.

103 { return appName; }
wxString appName
Definition: aboutinfo.h:136

References appName.

◆ GetArtists()

CONTRIBUTORS ABOUT_APP_INFO::GetArtists ( )
inline

Definition at line 89 of file aboutinfo.h.

89 { return mArtists; }
CONTRIBUTORS mArtists
Definition: aboutinfo.h:128

References mArtists.

Referenced by DIALOG_ABOUT::createNotebooks().

◆ GetBuildDate()

wxString& ABOUT_APP_INFO::GetBuildDate ( )
inline

Definition at line 109 of file aboutinfo.h.

109 { return buildDate; }
wxString buildDate
Definition: aboutinfo.h:138

References buildDate.

◆ GetBuildVersion()

wxString& ABOUT_APP_INFO::GetBuildVersion ( )
inline

Definition at line 106 of file aboutinfo.h.

106 { return buildVersion; }
wxString buildVersion
Definition: aboutinfo.h:137

References buildVersion.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT().

◆ GetCopyright()

wxString ABOUT_APP_INFO::GetCopyright ( )
inline

Definition at line 100 of file aboutinfo.h.

100 { return copyright; }
wxString copyright
Definition: aboutinfo.h:135

References copyright.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT().

◆ GetDescription()

wxString& ABOUT_APP_INFO::GetDescription ( )
inline

Definition at line 94 of file aboutinfo.h.

94 { return description; }
wxString description
Definition: aboutinfo.h:132

References description.

Referenced by DIALOG_ABOUT::createNotebooks().

◆ GetDevelopers()

CONTRIBUTORS ABOUT_APP_INFO::GetDevelopers ( )
inline

Definition at line 86 of file aboutinfo.h.

86 { return mDevelopers; }
CONTRIBUTORS mDevelopers
Definition: aboutinfo.h:125

References mDevelopers.

Referenced by DIALOG_ABOUT::createNotebooks().

◆ GetDocWriters()

CONTRIBUTORS ABOUT_APP_INFO::GetDocWriters ( )
inline

Definition at line 87 of file aboutinfo.h.

87 { return mDocWriters; }
CONTRIBUTORS mDocWriters
Definition: aboutinfo.h:126

References mDocWriters.

Referenced by DIALOG_ABOUT::createNotebooks().

◆ GetLibrarians()

CONTRIBUTORS ABOUT_APP_INFO::GetLibrarians ( )
inline

Definition at line 88 of file aboutinfo.h.

88 { return mLibrarians; }
CONTRIBUTORS mLibrarians
Definition: aboutinfo.h:127

References mLibrarians.

Referenced by DIALOG_ABOUT::createNotebooks().

◆ GetLibVersion()

wxString& ABOUT_APP_INFO::GetLibVersion ( )
inline

Definition at line 112 of file aboutinfo.h.

112 { return libVersion; }
wxString libVersion
Definition: aboutinfo.h:139

References libVersion.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT().

◆ GetLicense()

wxString& ABOUT_APP_INFO::GetLicense ( )
inline

Definition at line 97 of file aboutinfo.h.

97 { return license; }
wxString license
Definition: aboutinfo.h:133

References license.

Referenced by DIALOG_ABOUT::createNotebooks().

◆ GetPackagers()

CONTRIBUTORS ABOUT_APP_INFO::GetPackagers ( )
inline

Definition at line 91 of file aboutinfo.h.

91 { return mPackagers; }
CONTRIBUTORS mPackagers
Definition: aboutinfo.h:130

References mPackagers.

Referenced by DIALOG_ABOUT::createNotebooks().

◆ GetTranslators()

CONTRIBUTORS ABOUT_APP_INFO::GetTranslators ( )
inline

Definition at line 90 of file aboutinfo.h.

90 { return mTranslators; }
CONTRIBUTORS mTranslators
Definition: aboutinfo.h:129

References mTranslators.

Referenced by DIALOG_ABOUT::createNotebooks().

◆ SetAppIcon()

void ABOUT_APP_INFO::SetAppIcon ( const wxIcon &  aIcon)
inline

Definition at line 114 of file aboutinfo.h.

114 { m_appIcon = aIcon; }
wxIcon m_appIcon
Bitmaps to be freed when the dialog is closed.
Definition: aboutinfo.h:141

References m_appIcon.

Referenced by buildKicadAboutBanner().

◆ SetAppName()

void ABOUT_APP_INFO::SetAppName ( const wxString &  name)
inline

Definition at line 102 of file aboutinfo.h.

102 { appName = name; }
wxString appName
Definition: aboutinfo.h:136
const char * name
Definition: DXF_plotter.cpp:59

References appName, and name.

Referenced by buildKicadAboutBanner().

◆ SetBuildDate()

void ABOUT_APP_INFO::SetBuildDate ( const wxString &  date)
inline

Definition at line 108 of file aboutinfo.h.

108 { buildDate = date; }
wxString buildDate
Definition: aboutinfo.h:138

References buildDate.

Referenced by buildKicadAboutBanner().

◆ SetBuildVersion()

void ABOUT_APP_INFO::SetBuildVersion ( const wxString &  version)
inline

Definition at line 105 of file aboutinfo.h.

105 { buildVersion = version; }
wxString buildVersion
Definition: aboutinfo.h:137

References buildVersion.

Referenced by buildKicadAboutBanner().

◆ SetCopyright()

void ABOUT_APP_INFO::SetCopyright ( const wxString &  text)
inline

Definition at line 99 of file aboutinfo.h.

99 { copyright = text; }
wxString copyright
Definition: aboutinfo.h:135

References copyright, and text.

Referenced by buildKicadAboutBanner().

◆ SetDescription()

void ABOUT_APP_INFO::SetDescription ( const wxString &  text)
inline

Definition at line 93 of file aboutinfo.h.

93 { description = text; }
wxString description
Definition: aboutinfo.h:132

References description, and text.

Referenced by buildKicadAboutBanner().

◆ SetLibVersion()

void ABOUT_APP_INFO::SetLibVersion ( const wxString &  version)
inline

Definition at line 111 of file aboutinfo.h.

111 { libVersion = version; }
wxString libVersion
Definition: aboutinfo.h:139

References libVersion.

Referenced by buildKicadAboutBanner().

◆ SetLicense()

void ABOUT_APP_INFO::SetLicense ( const wxString &  text)
inline

Definition at line 96 of file aboutinfo.h.

96 { license = text; }
wxString license
Definition: aboutinfo.h:133

References license, and text.

Referenced by buildKicadAboutBanner().

Member Data Documentation

◆ appName

wxString ABOUT_APP_INFO::appName
private

Definition at line 136 of file aboutinfo.h.

Referenced by GetAppName(), and SetAppName().

◆ buildDate

wxString ABOUT_APP_INFO::buildDate
private

Definition at line 138 of file aboutinfo.h.

Referenced by GetBuildDate(), and SetBuildDate().

◆ buildVersion

wxString ABOUT_APP_INFO::buildVersion
private

Definition at line 137 of file aboutinfo.h.

Referenced by GetBuildVersion(), and SetBuildVersion().

◆ copyright

wxString ABOUT_APP_INFO::copyright
private

Definition at line 135 of file aboutinfo.h.

Referenced by GetCopyright(), and SetCopyright().

◆ description

wxString ABOUT_APP_INFO::description
private

Definition at line 132 of file aboutinfo.h.

Referenced by GetDescription(), and SetDescription().

◆ libVersion

wxString ABOUT_APP_INFO::libVersion
private

Definition at line 139 of file aboutinfo.h.

Referenced by GetLibVersion(), and SetLibVersion().

◆ license

wxString ABOUT_APP_INFO::license
private

Definition at line 133 of file aboutinfo.h.

Referenced by GetLicense(), and SetLicense().

◆ m_appIcon

wxIcon ABOUT_APP_INFO::m_appIcon
private

Bitmaps to be freed when the dialog is closed.

Definition at line 141 of file aboutinfo.h.

Referenced by GetAppIcon(), and SetAppIcon().

◆ m_bitmaps

std::vector<std::unique_ptr<wxBitmap> > ABOUT_APP_INFO::m_bitmaps
private

Definition at line 144 of file aboutinfo.h.

Referenced by CreateKiBitmap().

◆ mArtists

CONTRIBUTORS ABOUT_APP_INFO::mArtists
private

Definition at line 128 of file aboutinfo.h.

Referenced by AddArtist(), and GetArtists().

◆ mDevelopers

CONTRIBUTORS ABOUT_APP_INFO::mDevelopers
private

Definition at line 125 of file aboutinfo.h.

Referenced by AddDeveloper(), and GetDevelopers().

◆ mDocWriters

CONTRIBUTORS ABOUT_APP_INFO::mDocWriters
private

Definition at line 126 of file aboutinfo.h.

Referenced by AddDocWriter(), and GetDocWriters().

◆ mLibrarians

CONTRIBUTORS ABOUT_APP_INFO::mLibrarians
private

Definition at line 127 of file aboutinfo.h.

Referenced by AddLibrarian(), and GetLibrarians().

◆ mPackagers

CONTRIBUTORS ABOUT_APP_INFO::mPackagers
private

Definition at line 130 of file aboutinfo.h.

Referenced by AddPackager(), and GetPackagers().

◆ mTranslators

CONTRIBUTORS ABOUT_APP_INFO::mTranslators
private

Definition at line 129 of file aboutinfo.h.

Referenced by AddTranslator(), and GetTranslators().


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