2006-10-07 21:02:04 -04:00
|
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Name: wx/aboutdlg.h
|
|
|
|
// Purpose: declaration of wxAboutDialog class
|
|
|
|
// Author: Vadim Zeitlin
|
|
|
|
// Created: 2006-10-07
|
|
|
|
// RCS-ID: $Id$
|
|
|
|
// Copyright: (c) 2006 Vadim Zeitlin <vadim@wxwindows.org>
|
|
|
|
// Licence: wxWindows licence
|
|
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
|
|
|
#ifndef _WX_ABOUTDLG_H_
|
|
|
|
#define _WX_ABOUTDLG_H_
|
|
|
|
|
|
|
|
#include "wx/defs.h"
|
|
|
|
|
|
|
|
#if wxUSE_ABOUTDLG
|
|
|
|
|
|
|
|
#include "wx/app.h"
|
|
|
|
#include "wx/icon.h"
|
|
|
|
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// wxAboutDialogInfo: information shown by the standard "About" dialog
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
class WXDLLIMPEXP_CORE wxAboutDialogInfo
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
// all fields are initially uninitialized
|
|
|
|
wxAboutDialogInfo() { }
|
|
|
|
|
|
|
|
// accessors for various simply fields
|
|
|
|
// -----------------------------------
|
|
|
|
|
|
|
|
// name of the program, if not used defaults wxApp::GetAppName()
|
|
|
|
void SetName(const wxString& name) { m_name = name; }
|
|
|
|
wxString GetName() const
|
|
|
|
{ return m_name.empty() ? wxTheApp->GetAppName() : m_name; }
|
|
|
|
|
|
|
|
// version of the program, in free format (but without "version" word)
|
|
|
|
void SetVersion(const wxString& version) { m_version = version; }
|
|
|
|
bool HasVersion() const { return !m_version.empty(); }
|
|
|
|
wxString GetVersion() const { return m_version; }
|
|
|
|
|
|
|
|
// brief, but possibly multiline, description of the program
|
|
|
|
void SetDescription(const wxString& desc) { m_description = desc; }
|
|
|
|
bool HasDescription() const { return !m_description.empty(); }
|
|
|
|
wxString GetDescription() const { return m_description; }
|
|
|
|
|
|
|
|
// short string containing the program copyright information
|
|
|
|
void SetCopyright(const wxString& copyright) { m_copyright = copyright; }
|
|
|
|
bool HasCopyright() const { return !m_copyright.empty(); }
|
|
|
|
wxString GetCopyright() const { return m_copyright; }
|
|
|
|
|
|
|
|
// long, multiline string containing the text of the program licence
|
|
|
|
void SetLicence(const wxString& licence) { m_licence = licence; }
|
|
|
|
void SetLicense(const wxString& licence) { m_licence = licence; }
|
|
|
|
bool HasLicence() const { return !m_licence.empty(); }
|
|
|
|
wxString GetLicence() const { return m_licence; }
|
|
|
|
|
|
|
|
// icon to be shown in the dialog, defaults to the main frame icon
|
|
|
|
void SetIcon(const wxIcon& icon) { m_icon = icon; }
|
|
|
|
bool HasIcon() const { return m_icon.Ok(); }
|
2006-10-08 09:08:51 -04:00
|
|
|
wxIcon GetIcon() const;
|
2006-10-07 21:02:04 -04:00
|
|
|
|
|
|
|
// web site for the program and its description (defaults to URL itself if
|
|
|
|
// empty)
|
|
|
|
void SetWebSite(const wxString& url, const wxString& desc = wxEmptyString)
|
|
|
|
{
|
|
|
|
m_url = url;
|
|
|
|
m_urlDesc = desc.empty() ? url : desc;
|
|
|
|
}
|
|
|
|
|
|
|
|
bool HasWebSite() const { return !m_url.empty(); }
|
|
|
|
|
|
|
|
wxString GetWebSiteURL() const { return m_url; }
|
|
|
|
wxString GetWebSiteDescription() const { return m_urlDesc; }
|
|
|
|
|
|
|
|
// accessors for the arrays
|
|
|
|
// ------------------------
|
|
|
|
|
|
|
|
// the list of developers of the program
|
|
|
|
void SetDevelopers(const wxArrayString& developers)
|
|
|
|
{ m_developers = developers; }
|
|
|
|
void AddDeveloper(const wxString& developer)
|
|
|
|
{ m_developers.push_back(developer); }
|
|
|
|
|
|
|
|
bool HasDevelopers() const { return !m_developers.empty(); }
|
|
|
|
const wxArrayString& GetDevelopers() const { return m_developers; }
|
|
|
|
|
|
|
|
// the list of documentation writers
|
|
|
|
void SetDocWriters(const wxArrayString& docwriters)
|
|
|
|
{ m_docwriters = docwriters; }
|
|
|
|
void AddDocWriter(const wxString& docwriter)
|
|
|
|
{ m_docwriters.push_back(docwriter); }
|
|
|
|
|
|
|
|
bool HasDocWriters() const { return !m_docwriters.empty(); }
|
|
|
|
const wxArrayString& GetDocWriters() const { return m_docwriters; }
|
|
|
|
|
|
|
|
// the list of artists for the program art
|
|
|
|
void SetArtists(const wxArrayString& artists)
|
|
|
|
{ m_artists = artists; }
|
|
|
|
void AddArtist(const wxString& artist)
|
|
|
|
{ m_artists.push_back(artist); }
|
|
|
|
|
|
|
|
bool HasArtists() const { return !m_artists.empty(); }
|
|
|
|
const wxArrayString& GetArtists() const { return m_artists; }
|
|
|
|
|
|
|
|
// the list of translators
|
|
|
|
void SetTranslators(const wxArrayString& translators)
|
|
|
|
{ m_translators = translators; }
|
|
|
|
void AddTranslator(const wxString& translator)
|
|
|
|
{ m_translators.push_back(translator); }
|
|
|
|
|
|
|
|
bool HasTranslators() const { return !m_translators.empty(); }
|
|
|
|
const wxArrayString& GetTranslators() const { return m_translators; }
|
|
|
|
|
2006-10-08 08:07:03 -04:00
|
|
|
|
|
|
|
// implementation only
|
|
|
|
// -------------------
|
|
|
|
|
|
|
|
// "simple" about dialog shows only textual information (with possibly
|
|
|
|
// default icon but without hyperlink nor any long texts such as the
|
|
|
|
// licence text)
|
|
|
|
bool IsSimple() const
|
|
|
|
{ return !HasWebSite() && !HasIcon() && !HasLicence(); }
|
|
|
|
|
|
|
|
// get the description and credits (i.e. all of developers, doc writers,
|
|
|
|
// artists and translators) as a one long multiline string
|
|
|
|
wxString GetDescriptionAndCredits() const;
|
|
|
|
|
2006-10-07 21:02:04 -04:00
|
|
|
private:
|
|
|
|
wxString m_name,
|
|
|
|
m_version,
|
|
|
|
m_description,
|
|
|
|
m_copyright,
|
|
|
|
m_licence;
|
|
|
|
|
|
|
|
wxIcon m_icon;
|
|
|
|
|
|
|
|
wxString m_url,
|
|
|
|
m_urlDesc;
|
|
|
|
|
|
|
|
wxArrayString m_developers,
|
|
|
|
m_docwriters,
|
|
|
|
m_artists,
|
|
|
|
m_translators;
|
|
|
|
};
|
|
|
|
|
|
|
|
// functions to show the about dialog box
|
|
|
|
WXDLLIMPEXP_CORE void wxAboutBox(const wxAboutDialogInfo& info);
|
|
|
|
|
|
|
|
#endif // wxUSE_ABOUTDLG
|
|
|
|
|
|
|
|
#endif // _WX_ABOUTDLG_H_
|
|
|
|
|