mirror of
https://github.com/cookiengineer/audacity
synced 2026-02-08 20:52:09 +01:00
re-organise the Help System functions into a class as static methods for future utility
This commit is contained in:
@@ -18,25 +18,34 @@
|
||||
|
||||
class AudacityProject;
|
||||
|
||||
/// Displays cutable information in a text ctrl, with an OK button.
|
||||
void ShowInfoDialog( wxWindow *parent,
|
||||
/** @brief Class which contains static methods and data needed for implementing
|
||||
* help buttons
|
||||
*
|
||||
* This class should be the only place in the codebase where the location of
|
||||
* the online copy of the Audacity manual is stored, so that it can be
|
||||
* changed if required
|
||||
*/
|
||||
class HelpSystem
|
||||
{
|
||||
public:
|
||||
/// Displays cutable information in a text ctrl, with an OK button.
|
||||
static void ShowInfoDialog( wxWindow *parent,
|
||||
const wxString &dlogTitle,
|
||||
const wxString &shortMsg,
|
||||
const wxString &message,
|
||||
const int xSize, const int ySize);
|
||||
|
||||
/// Displays a new window with wxHTML help.
|
||||
void ShowHtmlText( wxWindow * pParent,
|
||||
/// Displays a new window with wxHTML help.
|
||||
static void ShowHtmlText( wxWindow * pParent,
|
||||
const wxString &Title,
|
||||
const wxString &HtmlText,
|
||||
bool bIsFile, bool bModal);
|
||||
|
||||
/// Displays a file in your browser, if it's available locally,
|
||||
/// OR else links to the internet.
|
||||
void ShowHelpDialog(wxWindow *parent,
|
||||
/// Displays a file in your browser, if it's available locally,
|
||||
/// OR else links to the internet.
|
||||
static void ShowHelpDialog(wxWindow *parent,
|
||||
const wxString &localFileName,
|
||||
const wxString &remoteURL);
|
||||
|
||||
|
||||
};
|
||||
|
||||
#endif // __AUDACITY_HELPSYSTEM__
|
||||
|
||||
Reference in New Issue
Block a user