AboutDialog_main.cpp File Reference

#include <boost/version.hpp>
#include <wx/aboutdlg.h>
#include <wx/arrimpl.cpp>
#include <wx/textctrl.h>
#include <wx/utils.h>
#include <bitmaps.h>
#include <build_version.h>
#include <common.h>
#include <kiplatform/app.h>
#include <pgm_base.h>
#include <eda_base_frame.h>
#include "aboutinfo.h"
#include "dialog_about.h"

Go to the source code of this file.

Macros
#define	ADD_DEV(name, category)   aInfo.AddDeveloper( new CONTRIBUTOR( name, category ) )
#define	LEAD_DEV   _( "Lead Development Team" )
#define	FORMER_DEV   _( "Lead Development Alumni" )
#define	CONTRIB_DEV   _( "Additional Contributions By")
#define	DOC_TEAM   _( "Documentation Team" )
#define	ADD_WRITER(name, category)   aInfo.AddDocWriter( new CONTRIBUTOR( name, category ) )
#define	ADD_TRANSLATOR(name, category)   aInfo.AddTranslator( new CONTRIBUTOR( name, category ) )
#define	LIBRARIANS   _( "Librarian Team" )
#define	ADD_LIBRARIAN(name)   aInfo.AddLibrarian( new CONTRIBUTOR( name, LIBRARIANS ) )
#define	MODELS_3D_CONTRIBUTION   _( "3D models" )
#define	SYMBOL_LIB_CONTRIBUTION   _( "Symbols" )
#define	FOOTPRINT_LIB_CONTRIBUTION   _( "Footprints" )
#define	ICON_CONTRIBUTION   _( "Icons" )
#define	PACKAGE_DEVS   _( "Package Developers" )

Functions
static wxString	HtmlHyperlink (const wxString &aUrl, const wxString &aDescription)
	Helper functions.
static wxString	HtmlNewline (const unsigned int aCount)
	Create an HTML newline character sequence of aCount.
static void	buildKicadAboutBanner (EDA_BASE_FRAME *aParent, ABOUT_APP_INFO &aInfo)
	Initializes the ABOUT_APP_INFO object with application specific information.
void	ShowAboutDialog (EDA_BASE_FRAME *aParent)

Macro Definition Documentation

ADD_DEV

#define ADD_DEV	(		name,
			category
	)		aInfo.AddDeveloper( new CONTRIBUTOR( name, category ) )

ADD_LIBRARIAN

#define ADD_LIBRARIAN

(

name

)

aInfo.AddLibrarian( new CONTRIBUTOR( name, LIBRARIANS ) )

ADD_TRANSLATOR

#define ADD_TRANSLATOR	(		name,
			category
	)		aInfo.AddTranslator( new CONTRIBUTOR( name, category ) )

ADD_WRITER

#define ADD_WRITER	(		name,
			category
	)		aInfo.AddDocWriter( new CONTRIBUTOR( name, category ) )

CONTRIB_DEV

#define CONTRIB_DEV   _( "Additional Contributions By")

DOC_TEAM

#define DOC_TEAM   _( "Documentation Team" )

FOOTPRINT_LIB_CONTRIBUTION

#define FOOTPRINT_LIB_CONTRIBUTION   _( "Footprints" )

FORMER_DEV

#define FORMER_DEV   _( "Lead Development Alumni" )

ICON_CONTRIBUTION

#define ICON_CONTRIBUTION   _( "Icons" )

LEAD_DEV

#define LEAD_DEV   _( "Lead Development Team" )

LIBRARIANS

#define LIBRARIANS   _( "Librarian Team" )

MODELS_3D_CONTRIBUTION

#define MODELS_3D_CONTRIBUTION   _( "3D models" )

PACKAGE_DEVS

#define PACKAGE_DEVS   _( "Package Developers" )

SYMBOL_LIB_CONTRIBUTION

#define SYMBOL_LIB_CONTRIBUTION   _( "Symbols" )

Function Documentation

buildKicadAboutBanner()

static void buildKicadAboutBanner ( EDA_BASE_FRAME *  aParent, ABOUT_APP_INFO &  aInfo  )

static

Initializes the ABOUT_APP_INFO object with application specific information.

This is the object which holds all information about the application

Definition at line 58 of file AboutDialog_main.cpp.

References _, ADD_DEV, ADD_LIBRARIAN, ADD_TRANSLATOR, ADD_WRITER, ABOUT_APP_INFO::AddArtist(), ABOUT_APP_INFO::AddLibrarian(), ABOUT_APP_INFO::AddPackager(), CONTRIB_DEV, DOC_TEAM, FOOTPRINT_LIB_CONTRIBUTION, FORMER_DEV, GetBuildDate(), GetBuildVersion(), GetPlatformGetBitnessName(), HtmlHyperlink(), HtmlNewline(), ICON_CONTRIBUTION, KIPLATFORM::APP::IsOperatingSystemUnsupported(), LEAD_DEV, MODELS_3D_CONTRIBUTION, PACKAGE_DEVS, Pgm(), ABOUT_APP_INFO::SetAppIcon(), ABOUT_APP_INFO::SetAppName(), ABOUT_APP_INFO::SetBuildDate(), ABOUT_APP_INFO::SetBuildVersion(), ABOUT_APP_INFO::SetDescription(), ABOUT_APP_INFO::SetLibVersion(), ABOUT_APP_INFO::SetLicense(), and SYMBOL_LIB_CONTRIBUTION.

Referenced by ShowAboutDialog().

HtmlHyperlink()

static wxString HtmlHyperlink ( const wxString &  aUrl, const wxString &  aDescription  )

static

Helper functions.

Wrap aUrl with a HTML anchor tag containing a hyperlink text reference to form a HTML hyperlink.

Parameters

aUrl	the url that will be embedded in an anchor tag containing a hyperlink reference
aDescription	the optional describing text that will be represented as a hyperlink. If not specified the url will be used as hyperlink.

Returns

a HTML conform hyperlink like description

Definition at line 970 of file AboutDialog_main.cpp.

Referenced by buildKicadAboutBanner().

HtmlNewline()

static wxString HtmlNewline ( const unsigned int  aCount )

static

Create an HTML newline character sequence of aCount.

Parameters

aCount

the number of HTML newline tags to concatenate, default is to return just one tag.

Returns

the concatenated amount of HTML newline tag(s)

Definition at line 990 of file AboutDialog_main.cpp.

Referenced by buildKicadAboutBanner().

ShowAboutDialog()

void ShowAboutDialog

(

EDA_BASE_FRAME *

aParent

)

Definition at line 947 of file AboutDialog_main.cpp.

References buildKicadAboutBanner(), and info.

Referenced by COMMON_CONTROL::About(), and EDA_BASE_FRAME::OnKicadAbout().