Audacity  2.2.0
HelpSystem.h
Go to the documentation of this file.
1 /**********************************************************************
2 
3  Audacity: A Digital Audio Editor
4 
5  ErrorDialog.h
6 
7  Jimmy Johnson
8  James Crook
9 
10 **********************************************************************/
11 
12 #ifndef __AUDACITY_HELPSYSTEM__
13 #define __AUDACITY_HELPSYSTEM__
14 
15 #include "../Audacity.h"
16 #include <wx/defs.h>
17 #include <wx/window.h>
18 
19 class AudacityProject;
20 
29 {
30 public:
32  static void ShowInfoDialog( wxWindow *parent,
33  const wxString &dlogTitle,
34  const wxString &shortMsg,
35  const wxString &message,
36  const int xSize, const int ySize);
37 
45  static void ShowHtmlText( wxWindow * pParent,
46  const wxString &Title,
47  const wxString &HtmlText,
48  bool bIsFile = false,
49  bool bModal = false);
50 
62  static void ShowHelp(wxWindow *parent,
63  const wxString &localFileName,
64  const wxString &remoteURL,
65  bool bModal = false,
66  bool alwaysDefaultBrowser = false);
67 
75  static void ShowHelp(wxWindow *parent,
76  const wxString &PageName,
77  bool bModal = false);
78 
81  static const wxString HelpHostname;
82 
86  static const wxString HelpServerHomeDir;
87 
91  static const wxString HelpServerManDir;
92 
96  static const wxString LocalHelpManDir;
97 
100  static const wxString ReleaseSuffix;
101 
102 };
103 
104 #endif // __AUDACITY_HELPSYSTEM__
static void ShowInfoDialog(wxWindow *parent, const wxString &dlogTitle, const wxString &shortMsg, const wxString &message, const int xSize, const int ySize)
Displays cutable information in a text ctrl, with an OK button.
Definition: HelpSystem.cpp:54
static const wxString LocalHelpManDir
Definition: HelpSystem.h:96
static const wxString HelpServerHomeDir
Definition: HelpSystem.h:86
static const wxString HelpHostname
Definition: HelpSystem.h:81
static void ShowHtmlText(wxWindow *pParent, const wxString &Title, const wxString &HtmlText, bool bIsFile=false, bool bModal=false)
Definition: HelpSystem.cpp:95
AudacityProject provides the main window, with tools and tracks contained within it.
Definition: Project.h:161
Class which contains static methods and data needed for implementing help buttons.
Definition: HelpSystem.h:28
static void ShowHelp(wxWindow *parent, const wxString &localFileName, const wxString &remoteURL, bool bModal=false, bool alwaysDefaultBrowser=false)
Definition: HelpSystem.cpp:201
static const wxString ReleaseSuffix
Definition: HelpSystem.h:100
static const wxString HelpServerManDir
Definition: HelpSystem.h:91