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 &aExtra=wxEmptyString, const wxString &aUrl=wxEmptyString, const wxString &aCategory=wxEmptyString, wxBitmap *aIcon=NULL)
 
 CONTRIBUTOR (const wxString &aName, const wxString &aCategory, wxBitmap *aIcon)
 
virtual ~CONTRIBUTOR ()
 
wxString & GetName ()
 
wxString & GetExtra ()
 
wxString & GetUrl ()
 
wxString & GetCategory ()
 
wxBitmap * GetIcon ()
 
void SetChecked (bool status)
 
bool IsChecked ()
 

Private Attributes

wxString m_name
 
wxString m_extra
 
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:

  • Extra identifying information
  • A category
  • A category specific icon

Definition at line 160 of file aboutinfo.h.

Constructor & Destructor Documentation

◆ CONTRIBUTOR() [1/2]

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

Definition at line 163 of file aboutinfo.h.

168  {
169  m_checked = false;
170  m_name = aName;
171  m_url = aUrl,
172  m_extra = aExtra;
173  m_category = aCategory;
174  m_icon = aIcon;
175  }
wxString m_category
Definition: aboutinfo.h:203
bool m_checked
Definition: aboutinfo.h:205
wxBitmap * m_icon
Definition: aboutinfo.h:204
wxString m_name
Definition: aboutinfo.h:200
wxString m_url
Definition: aboutinfo.h:202
wxString m_extra
Definition: aboutinfo.h:201

References m_category, m_checked, m_extra, m_icon, m_name, and m_url.

◆ CONTRIBUTOR() [2/2]

CONTRIBUTOR::CONTRIBUTOR ( const wxString &  aName,
const wxString &  aCategory,
wxBitmap *  aIcon 
)
inline

Definition at line 177 of file aboutinfo.h.

180  {
181  m_checked = false;
182  m_name = aName;
183  m_url = wxEmptyString,
184  m_extra = wxEmptyString;
185  m_category = aCategory;
186  m_icon = aIcon;
187  }
wxString m_category
Definition: aboutinfo.h:203
bool m_checked
Definition: aboutinfo.h:205
wxBitmap * m_icon
Definition: aboutinfo.h:204
wxString m_name
Definition: aboutinfo.h:200
wxString m_url
Definition: aboutinfo.h:202
wxString m_extra
Definition: aboutinfo.h:201

References m_category, m_checked, m_extra, m_icon, m_name, and m_url.

◆ ~CONTRIBUTOR()

virtual CONTRIBUTOR::~CONTRIBUTOR ( )
inlinevirtual

Definition at line 189 of file aboutinfo.h.

189 {}

Member Function Documentation

◆ GetCategory()

wxString& CONTRIBUTOR::GetCategory ( )
inline

Definition at line 194 of file aboutinfo.h.

194 { return m_category; }
wxString m_category
Definition: aboutinfo.h:203

References m_category.

Referenced by DIALOG_ABOUT::createNotebookPageByCategory().

◆ GetExtra()

wxString& CONTRIBUTOR::GetExtra ( )
inline

Definition at line 192 of file aboutinfo.h.

192 { return m_extra; }
wxString m_extra
Definition: aboutinfo.h:201

References m_extra.

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

◆ GetIcon()

wxBitmap* CONTRIBUTOR::GetIcon ( )
inline

Definition at line 195 of file aboutinfo.h.

195 { return m_icon; }
wxBitmap * m_icon
Definition: aboutinfo.h:204

References m_icon.

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

◆ GetName()

wxString& CONTRIBUTOR::GetName ( void  )
inline

Definition at line 191 of file aboutinfo.h.

191 { return m_name; }
wxString m_name
Definition: aboutinfo.h:200

References m_name.

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

◆ GetUrl()

wxString& CONTRIBUTOR::GetUrl ( )
inline

Definition at line 193 of file aboutinfo.h.

193 { return m_url; }
wxString m_url
Definition: aboutinfo.h:202

References m_url.

Referenced by DIALOG_ABOUT::createNotebookPageByCategory().

◆ IsChecked()

bool CONTRIBUTOR::IsChecked ( )
inline

Definition at line 197 of file aboutinfo.h.

197 { return m_checked; }
bool m_checked
Definition: aboutinfo.h:205

References m_checked.

Referenced by DIALOG_ABOUT::createNotebookPageByCategory().

◆ SetChecked()

void CONTRIBUTOR::SetChecked ( bool  status)
inline

Definition at line 196 of file aboutinfo.h.

196 { m_checked = status; }
bool m_checked
Definition: aboutinfo.h:205

References m_checked.

Referenced by DIALOG_ABOUT::createNotebookPageByCategory().

Member Data Documentation

◆ m_category

wxString CONTRIBUTOR::m_category
private

Definition at line 203 of file aboutinfo.h.

Referenced by CONTRIBUTOR(), and GetCategory().

◆ m_checked

bool CONTRIBUTOR::m_checked
private

Definition at line 205 of file aboutinfo.h.

Referenced by CONTRIBUTOR(), IsChecked(), and SetChecked().

◆ m_extra

wxString CONTRIBUTOR::m_extra
private

Definition at line 201 of file aboutinfo.h.

Referenced by CONTRIBUTOR(), and GetExtra().

◆ m_icon

wxBitmap* CONTRIBUTOR::m_icon
private

Definition at line 204 of file aboutinfo.h.

Referenced by CONTRIBUTOR(), and GetIcon().

◆ m_name

wxString CONTRIBUTOR::m_name
private

Definition at line 200 of file aboutinfo.h.

Referenced by CONTRIBUTOR(), and GetName().

◆ m_url

wxString CONTRIBUTOR::m_url
private

Definition at line 202 of file aboutinfo.h.

Referenced by CONTRIBUTOR(), and GetUrl().


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