// define this to 1 to use HTML help even under Windows (by default, Windows
// version will use WinHelp).
// Please also see samples/html/helpview.
-
#define USE_HTML_HELP 1
+// define this to 1 to use external help controller (not used by default)
+#define USE_EXT_HELP 0
+
// Define this to 0 to use the help controller as the help
// provider, or to 1 to use the 'simple help provider'
// (the one implemented with wxTipWindow).
#include "wx/msw/helpbest.h"
#endif
+#if USE_EXT_HELP
+#include "wx/generic/helpext.h"
+#endif
+
// ----------------------------------------------------------------------------
// ressources
// ----------------------------------------------------------------------------
// ctor(s)
MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size);
- wxHelpController& GetHelpController() { return m_help; }
+ wxHelpControllerBase& GetHelpController() { return m_help; }
#if USE_HTML_HELP
wxHtmlHelpController& GetAdvancedHtmlHelpController() { return m_advancedHtmlHelp; }
#if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP && !defined(__WXUNIVERSAL__)
void OnBestHelp(wxCommandEvent& event);
#endif
+#if USE_HTML_HELP
+ void OnModalHtmlHelp(wxCommandEvent& event);
+#endif
void OnShowContextHelp(wxCommandEvent& event);
void OnShowDialogContextHelp(wxCommandEvent& event);
void ShowHelp(int commandId, wxHelpControllerBase& helpController);
private:
+#if USE_EXT_HELP
+ wxExtHelpController m_help;
+#else
wxHelpController m_help;
+#endif
#if USE_HTML_HELP
wxHtmlHelpController m_advancedHtmlHelp;
+ wxHtmlHelpController m_embeddedHtmlHelp;
+ wxHtmlHelpWindow* m_embeddedHelpWindow;
#endif
#if wxUSE_MS_HTML_HELP && !defined(__WXUNIVERSAL__)
HelpDemo_Advanced_Html_Help_Functions,
HelpDemo_Advanced_Html_Help_Help,
HelpDemo_Advanced_Html_Help_Search,
+ HelpDemo_Advanced_Html_Help_Modal,
HelpDemo_MS_Html_Help_Index,
HelpDemo_MS_Html_Help_Classes,
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)
+#if USE_HTML_HELP
+ EVT_MENU(HelpDemo_Advanced_Html_Help_Modal, MyFrame::OnModalHtmlHelp)
+#endif
#if wxUSE_MS_HTML_HELP && !defined(__WXUNIVERSAL__)
EVT_MENU(HelpDemo_MS_Html_Help_Index, MyFrame::OnMSHtmlHelp)
#endif
wxHelpProvider::Set(provider);
-#if wxUSE_HTML
-#if wxUSE_GIF
- // Required for images in the online documentation
- wxImage::AddHandler(new wxGIFHandler);
+#if USE_HTML_HELP
+ #if wxUSE_GIF
+ // Required for images in the online documentation
+ wxImage::AddHandler(new wxGIFHandler);
+ #endif // wxUSE_GIF
// Required for advanced HTML help
-#if wxUSE_STREAMS && wxUSE_ZIPSTREAM && wxUSE_ZLIB
- wxFileSystem::AddHandler(new wxZipFSHandler);
-#endif
-
-#endif
-#endif
+ #if wxUSE_STREAMS && wxUSE_ZIPSTREAM && wxUSE_ZLIB
+ wxFileSystem::AddHandler(new wxZipFSHandler);
+ #endif
+#endif // wxUSE_HTML
// Create the main application window
MyFrame *frame = new MyFrame(_T("HelpDemo wxWidgets App"),
#else
provider->SetHelpController(& frame->GetHelpController());
#endif
-#endif
+#endif // !USE_SIMPLE_HELP_PROVIDER
frame->Show(true);
SetTopWindow(frame);
// frame constructor
MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size)
: wxFrame((wxFrame *)NULL, 300, title, pos, size)
+#if USE_HTML_HELP
+ , m_embeddedHtmlHelp(wxHF_EMBEDDED|wxHF_DEFAULT_STYLE)
+#endif
{
// set the frame icon
SetIcon(wxICON(mondrian));
menuFile->Append(HelpDemo_Advanced_Html_Help_Functions, _T("Advanced HTML &Help on Functions..."));
menuFile->Append(HelpDemo_Advanced_Html_Help_Help, _T("Advanced HTML &About Help Demo..."));
menuFile->Append(HelpDemo_Advanced_Html_Help_Search, _T("Advanced HTML &Search help..."));
+ menuFile->Append(HelpDemo_Advanced_Html_Help_Modal, _T("Advanced HTML Help &Modal Dialog..."));
#endif
#if wxUSE_MS_HTML_HELP && !defined(__WXUNIVERSAL__)
// ... and attach this menu bar to the frame
SetMenuBar(menuBar);
+#if wxUSE_STATUSBAR
// create a status bar just for fun (by default with 1 pane only)
CreateStatusBar();
SetStatusText(_T("Welcome to wxWidgets!"));
+#endif // wxUSE_STATUSBAR
+#if USE_HTML_HELP
+ // Create embedded HTML Help window
+ m_embeddedHelpWindow = new wxHtmlHelpWindow;
+ // m_embeddedHtmlHelp.UseConfig(config, rootPath); // Can set your own config object here
+ m_embeddedHtmlHelp.SetHelpWindow(m_embeddedHelpWindow);
+
+ m_embeddedHelpWindow->Create(this,
+ wxID_ANY, wxDefaultPosition, GetClientSize(), wxTAB_TRAVERSAL|wxNO_BORDER, wxHF_DEFAULT_STYLE);
+
+ m_embeddedHtmlHelp.AddBook(wxFileName(_T("doc.zip")));
+ m_embeddedHtmlHelp.Display(_T("Introduction"));
+#else
// now create some controls
// a panel first - if there were several controls, it would allow us to
// and a static control whose parent is the panel
wxStaticText* staticText = new wxStaticText(panel, 302, _T("Hello, world!"), wxPoint(10, 10));
staticText->SetHelpText(_("This static text control isn't doing a lot right now."));
+#endif
}
}
#endif
+#if USE_HTML_HELP
+void MyFrame::OnModalHtmlHelp(wxCommandEvent& WXUNUSED(event))
+{
+ wxHtmlModalHelp modalHelp(this, wxT("doc.zip"), wxT("Introduction"));
+}
+#endif
+
/*
Notes: ShowHelp uses section ids for displaying particular topics,
but you might want to use a unique keyword to display a topic, instead.
{
wxString key = wxGetTextFromUser(_T("Search for?"),
_T("Search help for keyword"),
- _T(""),
+ wxEmptyString,
this);
if(! key.IsEmpty())
helpController.KeywordSearch(key);
sizerTop->Add(text, 0, wxEXPAND|wxALIGN_CENTER_VERTICAL|wxALL, 5 );
sizerTop->Add(sizerRow, 0, wxALIGN_RIGHT|wxALIGN_CENTER_VERTICAL|wxALL, 5 );
- SetAutoLayout(true);
SetSizer(sizerTop);
sizerTop->SetSizeHints(this);