wxHtmlHelpController made compatible with other controllers

[wxWidgets.git] / samples / help / demo.cpp

diff --git a/samples/help/demo.cpp b/samples/help/demo.cpp
index a2233f7fa715f76ad6daa879bc73508f88f0c6ef..35778a46949399045fc404e18e8780fa2d3c30e1 100644 (file)
--- a/samples/help/demo.cpp
+++ b/samples/help/demo.cpp
@@ -30,13 +30,22 @@
 #   include "wx/wx.h"
 #endif
 
 #   include "wx/wx.h"
 #endif
 

+#   include "wx/image.h"
+#   include "wx/help.h"
+

 // define this to 1 to use HTML help even under Windows (by default, Windows
 // define this to 1 to use HTML help even under Windows (by default, Windows

-// version will HLP-based help)
+// version will use WinHelp).
+// Please also see samples/html/helpview for a more complex help viewer.
+

 #define USE_HTML_HELP 1
 #define USE_HTML_HELP 1

+
+#if !wxUSE_HTML
+#undef USE_HTML_HELP
+#define USE_HTML_HELP 0
+#endif
+

 #if USE_HTML_HELP
 #if USE_HTML_HELP

-#   include "wx/helpbase.h"
-#else
-#   include "wx/help.h"
+#   include "wx/generic/helpwxht.h"

 #endif
 
 // ----------------------------------------------------------------------------
 #endif
 
 // ----------------------------------------------------------------------------


@@ -71,12 +80,23 @@ public:
     // ctor(s)
     MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size);
 
     // ctor(s)
     MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size);
 

+    wxHelpController& GetHelpController() { return m_help; }
+
+#if USE_HTML_HELP
+    wxHelpControllerHtml& GetHtmlHelpController() { return m_htmlHelp; }
+#endif
+

     // event handlers (these functions should _not_ be virtual)
     void OnQuit(wxCommandEvent& event);
     void OnHelp(wxCommandEvent& event);
     // event handlers (these functions should _not_ be virtual)
     void OnQuit(wxCommandEvent& event);
     void OnHelp(wxCommandEvent& event);

+    void OnHtmlHelp(wxCommandEvent& event);

 
 private:
 
 private:

-   wxHelpController m_help;
+   wxHelpController         m_help;
+
+#if USE_HTML_HELP
+   wxHelpControllerHtml     m_htmlHelp;
+#endif

 
     // any class wishing to process wxWindows events must use this macro
    DECLARE_EVENT_TABLE()
 
     // any class wishing to process wxWindows events must use this macro
    DECLARE_EVENT_TABLE()


@@ -95,12 +115,19 @@ enum
     HelpDemo_Help_Classes,
     HelpDemo_Help_Functions,
     HelpDemo_Help_Help,
     HelpDemo_Help_Classes,
     HelpDemo_Help_Functions,
     HelpDemo_Help_Help,

+    HelpDemo_Help_Search,
+
+    HelpDemo_Html_Help_Index,
+    HelpDemo_Html_Help_Classes,
+    HelpDemo_Html_Help_Functions,
+    HelpDemo_Html_Help_Help,
+    HelpDemo_Html_Help_Search,
+

     HelpDemo_Help_KDE,
     HelpDemo_Help_GNOME,
     HelpDemo_Help_Netscape,
     HelpDemo_Help_KDE,
     HelpDemo_Help_GNOME,
     HelpDemo_Help_Netscape,

-    HelpDemo_Help_Search,

     // controls start here (the numbers are, of course, arbitrary)
     // controls start here (the numbers are, of course, arbitrary)

-    HelpDemo_Text = 1000,
+    HelpDemo_Text = 1000

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -116,10 +143,17 @@ BEGIN_EVENT_TABLE(MyFrame, wxFrame)
     EVT_MENU(HelpDemo_Help_Classes, MyFrame::OnHelp)
     EVT_MENU(HelpDemo_Help_Functions, MyFrame::OnHelp)
     EVT_MENU(HelpDemo_Help_Help, MyFrame::OnHelp)
     EVT_MENU(HelpDemo_Help_Classes, MyFrame::OnHelp)
     EVT_MENU(HelpDemo_Help_Functions, MyFrame::OnHelp)
     EVT_MENU(HelpDemo_Help_Help, MyFrame::OnHelp)

+    EVT_MENU(HelpDemo_Help_Search, MyFrame::OnHelp)
+
+    EVT_MENU(HelpDemo_Html_Help_Index, MyFrame::OnHtmlHelp)
+    EVT_MENU(HelpDemo_Html_Help_Classes, MyFrame::OnHtmlHelp)
+    EVT_MENU(HelpDemo_Html_Help_Functions, MyFrame::OnHtmlHelp)
+    EVT_MENU(HelpDemo_Html_Help_Help, MyFrame::OnHtmlHelp)
+    EVT_MENU(HelpDemo_Html_Help_Search, MyFrame::OnHtmlHelp)
+

     EVT_MENU(HelpDemo_Help_KDE, MyFrame::OnHelp)
     EVT_MENU(HelpDemo_Help_GNOME, MyFrame::OnHelp)
     EVT_MENU(HelpDemo_Help_Netscape, MyFrame::OnHelp)
     EVT_MENU(HelpDemo_Help_KDE, MyFrame::OnHelp)
     EVT_MENU(HelpDemo_Help_GNOME, MyFrame::OnHelp)
     EVT_MENU(HelpDemo_Help_Netscape, MyFrame::OnHelp)

-    EVT_MENU(HelpDemo_Help_Search, MyFrame::OnHelp)

 END_EVENT_TABLE()
 
 // Create a new application object: this macro will allow wxWindows to create
 END_EVENT_TABLE()
 
 // Create a new application object: this macro will allow wxWindows to create


@@ -140,6 +174,13 @@ IMPLEMENT_APP(MyApp)
 // `Main program' equivalent: the program execution "starts" here
 bool MyApp::OnInit()
 {
 // `Main program' equivalent: the program execution "starts" here
 bool MyApp::OnInit()
 {

+#if wxUSE_HTML
+#if wxUSE_GIF
+    // Required for images in the online documentation
+    wxImage::AddHandler(new wxGIFHandler);
+#endif
+#endif
+

     // Create the main application window
     MyFrame *frame = new MyFrame("HelpDemo wxWindows App",
                                  wxPoint(50, 50), wxSize(450, 340));
     // Create the main application window
     MyFrame *frame = new MyFrame("HelpDemo wxWindows App",
                                  wxPoint(50, 50), wxSize(450, 340));


@@ -147,9 +188,27 @@ bool MyApp::OnInit()
     frame->Show(TRUE);
     SetTopWindow(frame);
 
     frame->Show(TRUE);
     SetTopWindow(frame);
 

-    // success: wxApp::OnRun() will be called which will enter the main message
-    // loop and the application will run. If we returned FALSE here, the
-    // application would exit immediately.
+    // initialise the help system: this means that we'll use doc.hlp file under
+    // Windows and that the HTML docs are in the subdirectory doc for platforms
+    // using HTML help
+    if ( !frame->GetHelpController().Initialize("doc") )
+    {
+        wxLogError("Cannot initialize the help system, aborting.");
+
+        return FALSE;
+    }
+
+#if USE_HTML_HELP
+    // initialise the help system: this means that the HTML docs are in the
+    // subdirectory doc for platforms using HTML help
+    if ( !frame->GetHtmlHelpController().Initialize("doc") )
+    {
+        wxLogError("Cannot initialize the HTML help system, aborting.");
+
+        return FALSE;
+    }
+#endif
+

     return TRUE;
 }
 
     return TRUE;
 }
 


@@ -173,8 +232,18 @@ MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size)
     menuFile->Append(HelpDemo_Help_Help, "&About Help Demo...");
     menuFile->AppendSeparator();
     menuFile->Append(HelpDemo_Help_Search, "&Search help...");
     menuFile->Append(HelpDemo_Help_Help, "&About Help Demo...");
     menuFile->AppendSeparator();
     menuFile->Append(HelpDemo_Help_Search, "&Search help...");

+#if USE_HTML_HELP
+    menuFile->AppendSeparator();
+    menuFile->Append(HelpDemo_Html_Help_Index, "HTML &Help Index...");
+    menuFile->Append(HelpDemo_Html_Help_Classes, "HTML &Help on Classes...");
+    menuFile->Append(HelpDemo_Html_Help_Functions, "HTML &Help on Functions...");
+    menuFile->Append(HelpDemo_Html_Help_Help, "HTML &About Help Demo...");
+    menuFile->AppendSeparator();
+    menuFile->Append(HelpDemo_Html_Help_Search, "HTML &Search help...");
+#endif
+

 #ifndef __WXMSW__
 #ifndef __WXMSW__

-#ifndef wxUSE_HTML
+#if !wxUSE_HTML

     menuFile->AppendSeparator();
     menuFile->Append(HelpDemo_Help_KDE, "Use &KDE");
     menuFile->Append(HelpDemo_Help_GNOME, "Use &GNOME");
     menuFile->AppendSeparator();
     menuFile->Append(HelpDemo_Help_KDE, "Use &KDE");
     menuFile->Append(HelpDemo_Help_GNOME, "Use &GNOME");


@@ -203,11 +272,6 @@ MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size)
 
     // and a static control whose parent is the panel
     (void)new wxStaticText(panel, -1, "Hello, world!", wxPoint(10, 10));
 
     // and a static control whose parent is the panel
     (void)new wxStaticText(panel, -1, "Hello, world!", wxPoint(10, 10));

-
-    // initialise the help system: this means that we'll use doc.hlp file under
-    // Windows and that the HTML docs are in the subdirectory doc for platforms
-    // using HTML help
-    m_help.Initialize("doc");

 }
 
 
 }
 
 


@@ -224,17 +288,18 @@ void MyFrame::OnHelp(wxCommandEvent& event)
    switch(event.GetId())
    {
 
    switch(event.GetId())
    {
 

-   // Note: these DisplaySection calls use ids that are specific to wxExtHelpController
-   // (on Unix). For WinHelp, we'd need to use different context ids.
+   // Note: For WinHelp, these ids are specified in the map session, mapping
+   // topic names to numbers.
+   // For HTML and external help, a wxhelp.map file is used.

 
    case HelpDemo_Help_Classes:
 
    case HelpDemo_Help_Classes:

-      m_help.DisplaySection(1);
+      m_help.DisplaySection(2);

       break;
    case HelpDemo_Help_Functions:
       break;
    case HelpDemo_Help_Functions:

-      m_help.DisplaySection(4);
+      m_help.DisplaySection(1);

       break;
    case HelpDemo_Help_Help:
       break;
    case HelpDemo_Help_Help:

-      m_help.DisplaySection(5);
+      m_help.DisplaySection(3);

       break;
 
    // These three calls are only used by wxExtHelpController
       break;
 
    // These three calls are only used by wxExtHelpController


@@ -266,3 +331,37 @@ void MyFrame::OnHelp(wxCommandEvent& event)
    }
 }
 
    }
 }
 

+void MyFrame::OnHtmlHelp(wxCommandEvent& event)
+{
+#if USE_HTML_HELP
+   switch(event.GetId())
+   {
+
+   case HelpDemo_Html_Help_Classes:
+      m_htmlHelp.DisplaySection(2);
+      break;
+   case HelpDemo_Html_Help_Functions:
+      m_htmlHelp.DisplaySection(1);
+      break;
+   case HelpDemo_Html_Help_Help:
+      m_htmlHelp.DisplaySection(3);
+      break;
+
+   case HelpDemo_Html_Help_Search:
+   {
+      wxString key = wxGetTextFromUser("Search for?",
+                                       "Search help for keyword",
+                                       "",
+                                       this);
+      if(! key.IsEmpty())
+         m_htmlHelp.KeywordSearch(key);
+   }
+   break;
+   case HelpDemo_Html_Help_Index:
+   default:
+      m_htmlHelp.DisplayContents();
+      break;
+   }
+#endif
+}
+