KiCad PCB EDA Suite
CONTRIBUTOR Class Reference

A contributor, a person which was involved in the development of the application or which has contributed in any kind somehow to the project. More...

#include <aboutinfo.h>

Public Member Functions

 CONTRIBUTOR (const wxString &aName, const wxString &aEmail=wxEmptyString, const wxString &aUrl=wxEmptyString, const wxString &aCategory=wxEmptyString, wxBitmap *aIcon=NULL)
 
virtual ~CONTRIBUTOR ()
 
wxString & GetName ()
 
wxString & GetEMail ()
 
wxString & GetUrl ()
 
wxString & GetCategory ()
 
wxBitmap * GetIcon ()
 
void SetChecked (bool status)
 
bool IsChecked ()
 

Private Attributes

wxString m_name
 
wxString m_email
 
wxString m_url
 
wxString m_category
 
wxBitmap * m_icon
 
bool m_checked
 

Detailed Description

A contributor, a person which was involved in the development of the application or which has contributed in any kind somehow to the project.

A contributor consists of the following mandatory information:

  • Name

Each contributor can have optional information assigned like:

  • EMail address
  • A category
  • A category specific icon

Definition at line 148 of file aboutinfo.h.

Constructor & Destructor Documentation

CONTRIBUTOR::CONTRIBUTOR ( const wxString &  aName,
const wxString &  aEmail = wxEmptyString,
const wxString &  aUrl = wxEmptyString,
const wxString &  aCategory = wxEmptyString,
wxBitmap *  aIcon = NULL 
)
inline

Definition at line 151 of file aboutinfo.h.

156  {
157  m_checked = false;
158  m_name = aName;
159  m_url = aUrl,
160  m_email = aEmail;
161  m_category = aCategory;
162  m_icon = aIcon;
163  }
wxString m_category
Definition: aboutinfo.h:179
wxString m_email
Definition: aboutinfo.h:177
bool m_checked
Definition: aboutinfo.h:181
wxBitmap * m_icon
Definition: aboutinfo.h:180
wxString m_name
Definition: aboutinfo.h:176
wxString m_url
Definition: aboutinfo.h:178
virtual CONTRIBUTOR::~CONTRIBUTOR ( )
inlinevirtual

Definition at line 165 of file aboutinfo.h.

165 {}

Member Function Documentation

wxString& CONTRIBUTOR::GetCategory ( )
inline

Definition at line 170 of file aboutinfo.h.

Referenced by DIALOG_ABOUT::createNotebookPageByCategory().

170 { return m_category; }
wxString m_category
Definition: aboutinfo.h:179
wxString& CONTRIBUTOR::GetEMail ( )
inline

Definition at line 168 of file aboutinfo.h.

Referenced by DIALOG_ABOUT::createNotebookPage(), and DIALOG_ABOUT::createNotebookPageByCategory().

168 { return m_email; }
wxString m_email
Definition: aboutinfo.h:177
wxBitmap* CONTRIBUTOR::GetIcon ( )
inline

Definition at line 171 of file aboutinfo.h.

Referenced by DIALOG_ABOUT::createNotebookPage(), and DIALOG_ABOUT::createNotebookPageByCategory().

171 { return m_icon; }
wxBitmap * m_icon
Definition: aboutinfo.h:180
wxString& CONTRIBUTOR::GetName ( void  )
inline

Definition at line 167 of file aboutinfo.h.

Referenced by DIALOG_ABOUT::createNotebookPage(), and DIALOG_ABOUT::createNotebookPageByCategory().

167 { return m_name; }
wxString m_name
Definition: aboutinfo.h:176
wxString& CONTRIBUTOR::GetUrl ( )
inline

Definition at line 169 of file aboutinfo.h.

Referenced by DIALOG_ABOUT::createNotebookPageByCategory().

169 { return m_url; }
wxString m_url
Definition: aboutinfo.h:178
bool CONTRIBUTOR::IsChecked ( )
inline

Definition at line 173 of file aboutinfo.h.

Referenced by DIALOG_ABOUT::createNotebookPageByCategory().

173 { return m_checked; }
bool m_checked
Definition: aboutinfo.h:181
void CONTRIBUTOR::SetChecked ( bool  status)
inline

Definition at line 172 of file aboutinfo.h.

Referenced by DIALOG_ABOUT::createNotebookPageByCategory().

172 { m_checked = status; }
bool m_checked
Definition: aboutinfo.h:181

Member Data Documentation

wxString CONTRIBUTOR::m_category
private

Definition at line 179 of file aboutinfo.h.

bool CONTRIBUTOR::m_checked
private

Definition at line 181 of file aboutinfo.h.

wxString CONTRIBUTOR::m_email
private

Definition at line 177 of file aboutinfo.h.

wxBitmap* CONTRIBUTOR::m_icon
private

Definition at line 180 of file aboutinfo.h.

wxString CONTRIBUTOR::m_name
private

Definition at line 176 of file aboutinfo.h.

wxString CONTRIBUTOR::m_url
private

Definition at line 178 of file aboutinfo.h.


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