Version: 3.0.4
wxGenericAboutDialog Class Reference

#include <wx/generic/aboutdlgg.h>

Detailed Description

This class defines a customizable About dialog.

Note that if you don't need customization, you should use the global wxAboutBox() function that is both easier to use and shows the native dialog if available.

To use this class, you need to derive your own class from it and override the virtual method DoAddCustomControls().

To instantiate an object from your wxGenericAboutDialog-based class, you can use either the default constructor followed by a call to Create(), or directly using the alternate constructor. In either case, you have to prepare a wxAboutDialogInfo containing standard informations to display in an about-box.

Example of usage, MyAboutDlg being a class derived from wxGenericAboutDialog:

void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
{
wxAboutDialogInfo aboutInfo;
aboutInfo.SetName("MyApp");
aboutInfo.SetVersion(MY_APP_VERSION_STRING);
aboutInfo.SetDescription(_("My wxWidgets-based application!"));
aboutInfo.SetCopyright("(C) 1992-2012");
aboutInfo.SetWebSite("http://myapp.org");
aboutInfo.AddDeveloper("My Self");
MyAboutDlg dlgAbout(aboutInfo, this);
dlgAbout.ShowModal();
}

Library:  wxAdvanced
Category:  Common Dialogs
See also
wxAboutDialogInfo

Public Member Functions

 wxGenericAboutDialog ()
 Default constructor, Create() must be called later. More...
 
 wxGenericAboutDialog (const wxAboutDialogInfo &info, wxWindow *parent=NULL)
 Creates the dialog and initializes it with the given information. More...
 
bool Create (const wxAboutDialogInfo &info, wxWindow *parent=NULL)
 Initializes the dialog created using the default constructor. More...
 

Protected Member Functions

virtual void DoAddCustomControls ()
 This virtual method may be overridden to add more controls to the dialog. More...
 
void AddControl (wxWindow *win, const wxSizerFlags &flags)
 Add arbitrary control to the sizer content with the specified flags. More...
 
void AddControl (wxWindow *win)
 Add arbitrary control to the sizer content and centre it. More...
 
void AddText (const wxString &text)
 Add the given (not empty) text to the sizer content. More...
 
void AddCollapsiblePane (const wxString &title, const wxString &text)
 Add a wxCollapsiblePane containing the given text. More...
 

Constructor & Destructor Documentation

wxGenericAboutDialog::wxGenericAboutDialog ( )

Default constructor, Create() must be called later.

wxGenericAboutDialog::wxGenericAboutDialog ( const wxAboutDialogInfo info,
wxWindow parent = NULL 
)

Creates the dialog and initializes it with the given information.

Member Function Documentation

void wxGenericAboutDialog::AddCollapsiblePane ( const wxString title,
const wxString text 
)
protected

Add a wxCollapsiblePane containing the given text.

void wxGenericAboutDialog::AddControl ( wxWindow win,
const wxSizerFlags flags 
)
protected

Add arbitrary control to the sizer content with the specified flags.

For example, here is how to add an expandable line with a border of 3 pixels, then a line of text:

AddControl(new wxStaticLine(this), wxSizerFlags().Expand().Border(wxALL, 3));
AddText(_("This line is just an example of custom text."));
void wxGenericAboutDialog::AddControl ( wxWindow win)
protected

Add arbitrary control to the sizer content and centre it.

void wxGenericAboutDialog::AddText ( const wxString text)
protected

Add the given (not empty) text to the sizer content.

bool wxGenericAboutDialog::Create ( const wxAboutDialogInfo info,
wxWindow parent = NULL 
)

Initializes the dialog created using the default constructor.

virtual void wxGenericAboutDialog::DoAddCustomControls ( )
inlineprotectedvirtual

This virtual method may be overridden to add more controls to the dialog.

Use the protected AddControl(), AddText() and AddCollapsiblePane() methods to add custom controls.

This method is called during the dialog creation and you don't need to call it, only to override it.