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 AddArtist (const CONTRIBUTOR *artist)
 
void AddTranslator (const CONTRIBUTOR *translator)
 
void AddPackager (const CONTRIBUTOR *packager)
 
CONTRIBUTORS GetDevelopers ()
 
CONTRIBUTORS GetDocWriters ()
 
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 ()
 
wxBitmap * CreateKiBitmap (BITMAP_DEF aBitmap)
 

Wrapper to manage memory allocation for bitmaps

More...
 

Private Attributes

CONTRIBUTORS developers
 
CONTRIBUTORS docwriters
 
CONTRIBUTORS artists
 
CONTRIBUTORS translators
 
CONTRIBUTORS packagers
 
wxString description
 
wxString license
 
wxString copyright
 
wxString appName
 
wxString buildVersion
 
wxString buildDate
 
wxString libVersion
 
wxIcon m_appIcon
 
std::vector< std::unique_ptr< wxBitmap > > m_bitmaps
 

Bitmaps to be freed when the dialog is closed

More...
 

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 62 of file aboutinfo.h.

63  {
64  if( artist != NULL )
65  artists.Add( artist );
66  }
#define NULL
CONTRIBUTORS artists
Definition: aboutinfo.h:120

References artists, 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  developers.Add( developer );
54  }
#define NULL
CONTRIBUTORS developers
Definition: aboutinfo.h:118

References developers, 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  docwriters.Add( docwriter );
60  }
CONTRIBUTORS docwriters
Definition: aboutinfo.h:119
#define NULL

References docwriters, and NULL.

Referenced by buildKicadAboutBanner().

◆ AddPackager()

void ABOUT_APP_INFO::AddPackager ( const CONTRIBUTOR packager)
inline

Definition at line 74 of file aboutinfo.h.

75  {
76  if( packager != NULL )
77  packagers.Add( packager );
78  }
#define NULL
CONTRIBUTORS packagers
Definition: aboutinfo.h:122

References NULL, and packagers.

Referenced by buildKicadAboutBanner().

◆ AddTranslator()

void ABOUT_APP_INFO::AddTranslator ( const CONTRIBUTOR translator)
inline

Definition at line 68 of file aboutinfo.h.

69  {
70  if( translator != NULL )
71  translators.Add( translator );
72  }
#define NULL
CONTRIBUTORS translators
Definition: aboutinfo.h:121

References NULL, and translators.

Referenced by buildKicadAboutBanner().

◆ CreateKiBitmap()

wxBitmap* ABOUT_APP_INFO::CreateKiBitmap ( BITMAP_DEF  aBitmap)
inline

Wrapper to manage memory allocation for bitmaps

Definition at line 111 of file aboutinfo.h.

112  {
113  m_bitmaps.emplace_back( KiBitmapNew( aBitmap ) );
114  return m_bitmaps.back().get();
115  }
wxBitmap * KiBitmapNew(BITMAP_DEF aBitmap)
Allocate a wxBitmap on heap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:167
std::vector< std::unique_ptr< wxBitmap > > m_bitmaps
Bitmaps to be freed when the dialog is closed
Definition: aboutinfo.h:136

References KiBitmapNew(), and m_bitmaps.

Referenced by buildKicadAboutBanner().

◆ GetAppIcon()

wxIcon& ABOUT_APP_INFO::GetAppIcon ( )
inline

Definition at line 108 of file aboutinfo.h.

108 { return m_appIcon; }
wxIcon m_appIcon
Definition: aboutinfo.h:133

References m_appIcon.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT().

◆ GetAppName()

wxString& ABOUT_APP_INFO::GetAppName ( )
inline

Definition at line 96 of file aboutinfo.h.

96 { return appName; }
wxString appName
Definition: aboutinfo.h:128

References appName.

◆ GetArtists()

CONTRIBUTORS ABOUT_APP_INFO::GetArtists ( )
inline

Definition at line 82 of file aboutinfo.h.

82 { return artists; }
CONTRIBUTORS artists
Definition: aboutinfo.h:120

References artists.

Referenced by DIALOG_ABOUT::createNotebooks().

◆ GetBuildDate()

wxString& ABOUT_APP_INFO::GetBuildDate ( )
inline

Definition at line 102 of file aboutinfo.h.

102 { return buildDate; }
wxString buildDate
Definition: aboutinfo.h:130

References buildDate.

◆ GetBuildVersion()

wxString& ABOUT_APP_INFO::GetBuildVersion ( )
inline

Definition at line 99 of file aboutinfo.h.

99 { return buildVersion; }
wxString buildVersion
Definition: aboutinfo.h:129

References buildVersion.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT().

◆ GetCopyright()

wxString ABOUT_APP_INFO::GetCopyright ( )
inline

Definition at line 93 of file aboutinfo.h.

93 { return copyright; }
wxString copyright
Definition: aboutinfo.h:127

References copyright.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT().

◆ GetDescription()

wxString& ABOUT_APP_INFO::GetDescription ( )
inline

Definition at line 87 of file aboutinfo.h.

87 { return description; }
wxString description
Definition: aboutinfo.h:124

References description.

Referenced by DIALOG_ABOUT::createNotebooks().

◆ GetDevelopers()

CONTRIBUTORS ABOUT_APP_INFO::GetDevelopers ( )
inline

Definition at line 80 of file aboutinfo.h.

80 { return developers; }
CONTRIBUTORS developers
Definition: aboutinfo.h:118

References developers.

Referenced by DIALOG_ABOUT::createNotebooks().

◆ GetDocWriters()

CONTRIBUTORS ABOUT_APP_INFO::GetDocWriters ( )
inline

Definition at line 81 of file aboutinfo.h.

81 { return docwriters; }
CONTRIBUTORS docwriters
Definition: aboutinfo.h:119

References docwriters.

Referenced by DIALOG_ABOUT::createNotebooks().

◆ GetLibVersion()

wxString& ABOUT_APP_INFO::GetLibVersion ( )
inline

Definition at line 105 of file aboutinfo.h.

105 { return libVersion; }
wxString libVersion
Definition: aboutinfo.h:131

References libVersion.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT().

◆ GetLicense()

wxString& ABOUT_APP_INFO::GetLicense ( )
inline

Definition at line 90 of file aboutinfo.h.

90 { return license; }
wxString license
Definition: aboutinfo.h:125

References license.

Referenced by DIALOG_ABOUT::createNotebooks().

◆ GetPackagers()

CONTRIBUTORS ABOUT_APP_INFO::GetPackagers ( )
inline

Definition at line 84 of file aboutinfo.h.

84 { return packagers; }
CONTRIBUTORS packagers
Definition: aboutinfo.h:122

References packagers.

Referenced by DIALOG_ABOUT::createNotebooks().

◆ GetTranslators()

CONTRIBUTORS ABOUT_APP_INFO::GetTranslators ( )
inline

Definition at line 83 of file aboutinfo.h.

83 { return translators; }
CONTRIBUTORS translators
Definition: aboutinfo.h:121

References translators.

Referenced by DIALOG_ABOUT::createNotebooks().

◆ SetAppIcon()

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

Definition at line 107 of file aboutinfo.h.

107 { m_appIcon = aIcon; }
wxIcon m_appIcon
Definition: aboutinfo.h:133

References m_appIcon.

Referenced by buildKicadAboutBanner().

◆ SetAppName()

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

Definition at line 95 of file aboutinfo.h.

95 { appName = name; }
wxString appName
Definition: aboutinfo.h:128
const char * name
Definition: DXF_plotter.cpp:60

References appName, and name.

Referenced by buildKicadAboutBanner().

◆ SetBuildDate()

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

Definition at line 101 of file aboutinfo.h.

101 { buildDate = date; }
wxString buildDate
Definition: aboutinfo.h:130

References buildDate.

Referenced by buildKicadAboutBanner().

◆ SetBuildVersion()

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

Definition at line 98 of file aboutinfo.h.

98 { buildVersion = version; }
wxString buildVersion
Definition: aboutinfo.h:129

References buildVersion.

Referenced by buildKicadAboutBanner().

◆ SetCopyright()

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

Definition at line 92 of file aboutinfo.h.

92 { copyright = text; }
wxString copyright
Definition: aboutinfo.h:127

References copyright.

Referenced by buildKicadAboutBanner().

◆ SetDescription()

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

Definition at line 86 of file aboutinfo.h.

86 { description = text; }
wxString description
Definition: aboutinfo.h:124

References description.

Referenced by buildKicadAboutBanner().

◆ SetLibVersion()

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

Definition at line 104 of file aboutinfo.h.

104 { libVersion = version; }
wxString libVersion
Definition: aboutinfo.h:131

References libVersion.

Referenced by buildKicadAboutBanner().

◆ SetLicense()

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

Definition at line 89 of file aboutinfo.h.

89 { license = text; }
wxString license
Definition: aboutinfo.h:125

References license.

Referenced by buildKicadAboutBanner().

Member Data Documentation

◆ appName

wxString ABOUT_APP_INFO::appName
private

Definition at line 128 of file aboutinfo.h.

Referenced by GetAppName(), and SetAppName().

◆ artists

CONTRIBUTORS ABOUT_APP_INFO::artists
private

Definition at line 120 of file aboutinfo.h.

Referenced by AddArtist(), and GetArtists().

◆ buildDate

wxString ABOUT_APP_INFO::buildDate
private

Definition at line 130 of file aboutinfo.h.

Referenced by GetBuildDate(), and SetBuildDate().

◆ buildVersion

wxString ABOUT_APP_INFO::buildVersion
private

Definition at line 129 of file aboutinfo.h.

Referenced by GetBuildVersion(), and SetBuildVersion().

◆ copyright

wxString ABOUT_APP_INFO::copyright
private

Definition at line 127 of file aboutinfo.h.

Referenced by GetCopyright(), and SetCopyright().

◆ description

wxString ABOUT_APP_INFO::description
private

Definition at line 124 of file aboutinfo.h.

Referenced by GetDescription(), and SetDescription().

◆ developers

CONTRIBUTORS ABOUT_APP_INFO::developers
private

Definition at line 118 of file aboutinfo.h.

Referenced by AddDeveloper(), and GetDevelopers().

◆ docwriters

CONTRIBUTORS ABOUT_APP_INFO::docwriters
private

Definition at line 119 of file aboutinfo.h.

Referenced by AddDocWriter(), and GetDocWriters().

◆ libVersion

wxString ABOUT_APP_INFO::libVersion
private

Definition at line 131 of file aboutinfo.h.

Referenced by GetLibVersion(), and SetLibVersion().

◆ license

wxString ABOUT_APP_INFO::license
private

Definition at line 125 of file aboutinfo.h.

Referenced by GetLicense(), and SetLicense().

◆ m_appIcon

wxIcon ABOUT_APP_INFO::m_appIcon
private

Definition at line 133 of file aboutinfo.h.

Referenced by GetAppIcon(), and SetAppIcon().

◆ m_bitmaps

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

Bitmaps to be freed when the dialog is closed

Definition at line 136 of file aboutinfo.h.

Referenced by CreateKiBitmap().

◆ packagers

CONTRIBUTORS ABOUT_APP_INFO::packagers
private

Definition at line 122 of file aboutinfo.h.

Referenced by AddPackager(), and GetPackagers().

◆ translators

CONTRIBUTORS ABOUT_APP_INFO::translators
private

Definition at line 121 of file aboutinfo.h.

Referenced by AddTranslator(), and GetTranslators().


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