HelpSystem.h

Go to the documentation of this file.

/**********************************************************************
 
  Audacity: A Digital Audio Editor
 
  HelpSystem.h
 
  Jimmy Johnson
  James Crook
 
  was merged with LinkingHtmlWindow.h
 
  Vaughan Johnson
  Dominic Mazzoni
 
  utility fn and
  descendant of HtmlWindow that opens links in the user's
  default browser
 
**********************************************************************/
 
#ifndef __AUDACITY_HELPSYSTEM__
#define __AUDACITY_HELPSYSTEM__
 
 
 
#include <wx/defs.h>
#include "wxPanelWrapper.h" // to inherit
#include "HelpText.h"
 
class AudacityProject;
 
class WX_INIT_API HelpSystem
{
public:
   static void ShowInfoDialog( wxWindow *parent,
                     const TranslatableString &dlogTitle,
                     const TranslatableString &shortMsg,
                     const wxString &message, 
                     const int xSize, const int ySize);
 
   static void ShowHtmlText( wxWindow * pParent, 
                   const TranslatableString &Title,
                   const wxString &HtmlText,
                   bool bIsFile = false,
                   bool bModal = false);
 
   static void ShowHelp(wxWindow *parent,
                     const FilePath &localFileName,
                     const URLString &remoteURL,
                     bool bModal = false,
                     bool alwaysDefaultBrowser = false);
 
   static void ShowHelp(wxWindow *parent,
                     const ManualPageID &PageName,
                     bool bModal = false);
 
   static const wxString HelpHostname;
 
   static const wxString HelpServerHomeDir;
 
   static const wxString HelpServerManDir;
 
   static const wxString LocalHelpManDir;
 
};
 
class ShuttleGui;
 
#include "HtmlWindow.h" // to inherit
 
WX_INIT_API void OpenInDefaultBrowser(const URLString& link);
 
 
class WX_INIT_API LinkingHtmlWindow final : public HtmlWindow
{
 public:
   LinkingHtmlWindow(wxWindow *parent, wxWindowID id = -1,
                     const wxPoint& pos = wxDefaultPosition,
                     const wxSize& size = wxDefaultSize,
                     long style = wxHW_SCROLLBAR_AUTO);
   void OnLinkClicked(const wxHtmlLinkInfo& link) override;
   //void OnSetTitle(const wxString& title) override;
 
};
 
 
class BrowserDialog /* not final */ : public wxDialogWrapper
{
public:
   enum { ID = 0 };
   BrowserDialog(wxWindow *pParent, const TranslatableString &title);
 
   void OnForward(wxCommandEvent & event);
   void OnBackward(wxCommandEvent & event);
   void OnClose(wxCommandEvent & event);
   void OnKeyDown(wxKeyEvent & event);
 
   void UpdateButtons();
   //void SetLabel(const wxString& label) override;
 
 
   HtmlWindow * mpHtml;
   bool mDismissed{};
   DECLARE_EVENT_TABLE()
};
 
extern WX_INIT_API ChoiceSetting
     GUIManualLocation
;
 
#endif // __AUDACITY_HELPSYSTEM__