// define this to 1 to use HTML help even under Windows (by default, Windows
// version will use WinHelp).
-// Please also see samples/html/helpview for a more complex help viewer.
+// Please also see samples/html/helpview.
#define USE_HTML_HELP 1
#endif
#if USE_HTML_HELP
-# include "wx/generic/helpwxht.h"
+
+#include <wx/filesys.h>
+#include <wx/fs_zip.h>
+
+#include "wx/generic/helpwxht.h"
+#include "wx/html/helpctrl.h"
#endif
// ----------------------------------------------------------------------------
#if USE_HTML_HELP
wxHelpControllerHtml& GetHtmlHelpController() { return m_htmlHelp; }
+ wxHtmlHelpController& GetAdvancedHtmlHelpController() { return m_advancedHtmlHelp; }
#endif
// event handlers (these functions should _not_ be virtual)
void OnQuit(wxCommandEvent& event);
void OnHelp(wxCommandEvent& event);
void OnHtmlHelp(wxCommandEvent& event);
+ void OnAdvancedHtmlHelp(wxCommandEvent& event);
+
+ void ShowHelp(int commandId, wxHelpControllerBase& helpController);
private:
wxHelpController m_help;
#if USE_HTML_HELP
wxHelpControllerHtml m_htmlHelp;
+ wxHtmlHelpController m_advancedHtmlHelp;
#endif
// any class wishing to process wxWindows events must use this macro
HelpDemo_Html_Help_Help,
HelpDemo_Html_Help_Search,
+ HelpDemo_Advanced_Html_Help_Index,
+ HelpDemo_Advanced_Html_Help_Classes,
+ HelpDemo_Advanced_Html_Help_Functions,
+ HelpDemo_Advanced_Html_Help_Help,
+ HelpDemo_Advanced_Html_Help_Search,
+
HelpDemo_Help_KDE,
HelpDemo_Help_GNOME,
HelpDemo_Help_Netscape,
EVT_MENU(HelpDemo_Html_Help_Help, MyFrame::OnHtmlHelp)
EVT_MENU(HelpDemo_Html_Help_Search, MyFrame::OnHtmlHelp)
+ EVT_MENU(HelpDemo_Advanced_Html_Help_Index, MyFrame::OnAdvancedHtmlHelp)
+ EVT_MENU(HelpDemo_Advanced_Html_Help_Classes, MyFrame::OnAdvancedHtmlHelp)
+ EVT_MENU(HelpDemo_Advanced_Html_Help_Functions, MyFrame::OnAdvancedHtmlHelp)
+ EVT_MENU(HelpDemo_Advanced_Html_Help_Help, MyFrame::OnAdvancedHtmlHelp)
+ EVT_MENU(HelpDemo_Advanced_Html_Help_Search, MyFrame::OnAdvancedHtmlHelp)
+
EVT_MENU(HelpDemo_Help_KDE, MyFrame::OnHelp)
EVT_MENU(HelpDemo_Help_GNOME, MyFrame::OnHelp)
EVT_MENU(HelpDemo_Help_Netscape, MyFrame::OnHelp)
#if wxUSE_GIF
// Required for images in the online documentation
wxImage::AddHandler(new wxGIFHandler);
+
+ // Required for advanced HTML help
+#if wxUSE_STREAMS && wxUSE_ZIPSTREAM && wxUSE_ZLIB
+ wxFileSystem::AddHandler(new wxZipFSHandler);
+#endif
+
#endif
#endif
}
#if USE_HTML_HELP
- // initialise the help system: this means that the HTML docs are in the
+ // initialise the standard HTML help system: this means that the HTML docs are in the
// subdirectory doc for platforms using HTML help
if ( !frame->GetHtmlHelpController().Initialize("doc") )
{
return FALSE;
}
+
+ // initialise the advanced HTML help system: this means that the HTML docs are in .htb
+ // (zipped) form
+ if ( !frame->GetAdvancedHtmlHelpController().Initialize("doc") )
+ {
+ wxLogError("Cannot initialize the advanced HTML help system, aborting.");
+
+ return FALSE;
+ }
#endif
return TRUE;
menuFile->Append(HelpDemo_Help_Classes, "&Help on Classes...");
menuFile->Append(HelpDemo_Help_Functions, "&Help on Functions...");
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_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...");
+ menuFile->AppendSeparator();
+ menuFile->Append(HelpDemo_Advanced_Html_Help_Index, "Advanced HTML &Help Index...");
+ menuFile->Append(HelpDemo_Advanced_Html_Help_Classes, "Advanced HTML &Help on Classes...");
+ menuFile->Append(HelpDemo_Advanced_Html_Help_Functions, "Advanced HTML &Help on Functions...");
+ menuFile->Append(HelpDemo_Advanced_Html_Help_Help, "Advanced HTML &About Help Demo...");
+ menuFile->Append(HelpDemo_Advanced_Html_Help_Search, "Advanced HTML &Search help...");
#endif
#ifndef __WXMSW__
void MyFrame::OnHelp(wxCommandEvent& event)
{
- switch(event.GetId())
+ ShowHelp(event.GetId(), m_help);
+}
+
+void MyFrame::OnHtmlHelp(wxCommandEvent& event)
+{
+#if USE_HTML_HELP
+ ShowHelp(event.GetId(), m_htmlHelp);
+#endif
+}
+
+void MyFrame::OnAdvancedHtmlHelp(wxCommandEvent& event)
+{
+#if USE_HTML_HELP
+ ShowHelp(event.GetId(), m_advancedHtmlHelp);
+#endif
+}
+
+void MyFrame::ShowHelp(int commandId, wxHelpControllerBase& helpController)
+{
+ switch(commandId)
{
// Note: For WinHelp, these ids are specified in the map session, mapping
// For HTML and external help, a wxhelp.map file is used.
case HelpDemo_Help_Classes:
- m_help.DisplaySection(2);
- break;
- case HelpDemo_Help_Functions:
- m_help.DisplaySection(1);
- break;
- case HelpDemo_Help_Help:
- m_help.DisplaySection(3);
- break;
+ case HelpDemo_Html_Help_Classes:
+ case HelpDemo_Advanced_Html_Help_Classes:
+ helpController.DisplaySection(2);
- // These three calls are only used by wxExtHelpController
+ // if (helpController.IsKindOf(CLASSINFO(wxHtmlHelpController)))
+ // ((wxHtmlHelpController&)helpController).Display("Classes"); // An alternative form for this controller
- case HelpDemo_Help_KDE:
- m_help.SetViewer("kdehelp");
break;
- case HelpDemo_Help_GNOME:
- m_help.SetViewer("gnome-help-browser");
+ case HelpDemo_Help_Functions:
+ case HelpDemo_Html_Help_Functions:
+ case HelpDemo_Advanced_Html_Help_Functions:
+ helpController.DisplaySection(1);
break;
- case HelpDemo_Help_Netscape:
- m_help.SetViewer("netscape", wxHELP_NETSCAPE);
+ case HelpDemo_Help_Help:
+ case HelpDemo_Html_Help_Help:
+ case HelpDemo_Advanced_Html_Help_Help:
+ helpController.DisplaySection(3);
break;
case HelpDemo_Help_Search:
+ case HelpDemo_Html_Help_Search:
+ case HelpDemo_Advanced_Html_Help_Search:
{
wxString key = wxGetTextFromUser("Search for?",
"Search help for keyword",
"",
this);
if(! key.IsEmpty())
- m_help.KeywordSearch(key);
+ helpController.KeywordSearch(key);
}
break;
+
case HelpDemo_Help_Index:
- default:
- m_help.DisplayContents();
+ case HelpDemo_Html_Help_Index:
+ case HelpDemo_Advanced_Html_Help_Index:
+ helpController.DisplayContents();
break;
- }
-}
-void MyFrame::OnHtmlHelp(wxCommandEvent& event)
-{
-#if USE_HTML_HELP
- switch(event.GetId())
- {
+ // These three calls are only used by wxExtHelpController
- case HelpDemo_Html_Help_Classes:
- m_htmlHelp.DisplaySection(2);
+ case HelpDemo_Help_KDE:
+ helpController.SetViewer("kdehelp");
break;
- case HelpDemo_Html_Help_Functions:
- m_htmlHelp.DisplaySection(1);
+ case HelpDemo_Help_GNOME:
+ helpController.SetViewer("gnome-help-browser");
break;
- case HelpDemo_Html_Help_Help:
- m_htmlHelp.DisplaySection(3);
+ case HelpDemo_Help_Netscape:
+ helpController.SetViewer("netscape", wxHELP_NETSCAPE);
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
}
projects / wxWidgets.git / blobdiff