X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/33b64e6f8b7cf372a569e61d7eee879217945043..015e69f36dfbc469eef59456f973d0567e865d70:/samples/help/demo.cpp diff --git a/samples/help/demo.cpp b/samples/help/demo.cpp index 1980c9f265..daba593c1a 100644 --- a/samples/help/demo.cpp +++ b/samples/help/demo.cpp @@ -16,26 +16,56 @@ // ---------------------------------------------------------------------------- // headers // ---------------------------------------------------------------------------- -#ifdef __GNUG__ - #pragma implementation "demo.cpp" - #pragma interface "demo.cpp" -#endif // For compilers that support precompilation, includes "wx/wx.h". #include "wx/wxprec.h" #ifdef __BORLANDC__ - #pragma hdrstop +# pragma hdrstop #endif // for all others, include the necessary headers (this file is usually all you // need because it includes almost all "standard" wxWindows headers #ifndef WX_PRECOMP - #include "wx/wx.h" +# include "wx/wx.h" +#endif + +# include "wx/image.h" +# include "wx/help.h" +# include "wx/cshelp.h" + +#if wxUSE_TOOLTIPS +# include "wx/tooltip.h" +#endif + +// 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 + +// Use old-style HTML help if 1 +#define USE_OLD_HTML_HELP 0 + +#if !wxUSE_HTML +#undef USE_HTML_HELP +#define USE_HTML_HELP 0 +#endif + +#if USE_HTML_HELP +#include +#include + +#if USE_OLD_HTML_HELP +#include "wx/generic/helpwxht.h" #endif -#include "wx/helpbase.h" -#include "wx/help.h" +#include "wx/html/helpctrl.h" +#endif + +#if wxUSE_MS_HTML_HELP +#include "wx/msw/helpchm.h" +#endif // ---------------------------------------------------------------------------- // ressources @@ -60,6 +90,9 @@ public: // initialization (doing it here and not in the ctor allows to have an error // return: if OnInit() returns false, the application terminates) virtual bool OnInit(); + + // do some clean up here + virtual int OnExit(); }; // Define a new frame type: this is going to be our main frame @@ -69,16 +102,59 @@ public: // ctor(s) MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size); + wxHelpController& GetHelpController() { return m_help; } + +#if USE_HTML_HELP +#if USE_OLD_HTML_HELP + wxHelpControllerHtml& GetHtmlHelpController() { return m_htmlHelp; } +#endif + wxHtmlHelpController& GetAdvancedHtmlHelpController() { return m_advancedHtmlHelp; } +#endif +#if wxUSE_MS_HTML_HELP + wxCHMHelpController& GetMSHtmlHelpController() { return m_msHtmlHelp; } +#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 OnMSHtmlHelp(wxCommandEvent& event); + + void OnShowContextHelp(wxCommandEvent& event); + void OnShowDialogContextHelp(wxCommandEvent& event); + + void ShowHelp(int commandId, wxHelpControllerBase& helpController); private: - wxHelpController help; + wxHelpController m_help; + +#if USE_HTML_HELP +#if USE_OLD_HTML_HELP + wxHelpControllerHtml m_htmlHelp; +#endif + wxHtmlHelpController m_advancedHtmlHelp; +#endif + +#if wxUSE_MS_HTML_HELP + wxCHMHelpController m_msHtmlHelp; +#endif + // any class wishing to process wxWindows events must use this macro DECLARE_EVENT_TABLE() }; +// A custom modal dialog +class MyModalDialog : public wxDialog +{ +public: + MyModalDialog(wxWindow *parent); + +private: + + DECLARE_EVENT_TABLE() +}; + // ---------------------------------------------------------------------------- // constants // ---------------------------------------------------------------------------- @@ -87,15 +163,36 @@ private: enum { // menu items - HelpDemo_Quit = 1, + HelpDemo_Quit = 100, HelpDemo_Help_Index, HelpDemo_Help_Classes, HelpDemo_Help_Functions, HelpDemo_Help_Help, + HelpDemo_Help_Search, + HelpDemo_Help_ContextHelp, + HelpDemo_Help_DialogContextHelp, + + HelpDemo_Html_Help_Index, + HelpDemo_Html_Help_Classes, + HelpDemo_Html_Help_Functions, + 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_MS_Html_Help_Index, + HelpDemo_MS_Html_Help_Classes, + HelpDemo_MS_Html_Help_Functions, + HelpDemo_MS_Html_Help_Help, + HelpDemo_MS_Html_Help_Search, + HelpDemo_Help_KDE, HelpDemo_Help_GNOME, HelpDemo_Help_Netscape, - HelpDemo_Help_Search, // controls start here (the numbers are, of course, arbitrary) HelpDemo_Text = 1000, }; @@ -113,10 +210,31 @@ 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_Search, MyFrame::OnHelp) + EVT_MENU(HelpDemo_Help_ContextHelp, MyFrame::OnShowContextHelp) + EVT_MENU(HelpDemo_Help_DialogContextHelp, MyFrame::OnShowDialogContextHelp) + + 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_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_MS_Html_Help_Index, MyFrame::OnMSHtmlHelp) + EVT_MENU(HelpDemo_MS_Html_Help_Classes, MyFrame::OnMSHtmlHelp) + EVT_MENU(HelpDemo_MS_Html_Help_Functions, MyFrame::OnMSHtmlHelp) + EVT_MENU(HelpDemo_MS_Html_Help_Help, MyFrame::OnMSHtmlHelp) + EVT_MENU(HelpDemo_MS_Html_Help_Search, MyFrame::OnMSHtmlHelp) + 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 @@ -137,26 +255,98 @@ IMPLEMENT_APP(MyApp) // `Main program' equivalent: the program execution "starts" here bool MyApp::OnInit() { + // Create a simple help provider to make SetHelpText() do something. + // Note that this must be set before any SetHelpText() calls are made. + //wxHelpProvider::Set(new wxSimpleHelpProvider); + wxHelpControllerHelpProvider* provider = new wxHelpControllerHelpProvider; + wxHelpProvider::Set(provider); + +#if wxUSE_HTML +#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 + // Create the main application window MyFrame *frame = new MyFrame("HelpDemo wxWindows App", wxPoint(50, 50), wxSize(450, 340)); +#if wxUSE_MS_HTML_HELP + provider->SetHelpController(& frame->GetMSHtmlHelpController()); +#else + provider->SetHelpController(& frame->GetHelpController()); +#endif + 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 standard HTML help system: this means that the HTML docs are in the + // subdirectory doc for platforms using HTML help +#if USE_OLD_HTML_HELP + if ( !frame->GetHtmlHelpController().Initialize("doc") ) + { + wxLogError("Cannot initialize the HTML help system, aborting."); + + return FALSE; + } +#endif + + // 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 + +#if defined(__WXMSW__) && wxUSE_MS_HTML_HELP + wxString path(wxGetCwd()); + if ( !frame->GetMSHtmlHelpController().Initialize(path + "\\doc.chm") ) + { + wxLogError("Cannot initialize the MS HTML help system, aborting."); + + return FALSE; + } +#endif + return TRUE; } +int MyApp::OnExit() +{ + // clean up + delete wxHelpProvider::Set(NULL); + + return 0; +} + // ---------------------------------------------------------------------------- // main frame // ---------------------------------------------------------------------------- // frame constructor MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size) - : wxFrame((wxFrame *)NULL, -1, title, pos, size) + : wxFrame((wxFrame *)NULL, 300, title, pos, size) { // set the frame icon SetIcon(wxICON(mondrian)); @@ -167,14 +357,43 @@ MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size) menuFile->Append(HelpDemo_Help_Index, "&Help Index..."); menuFile->Append(HelpDemo_Help_Classes, "&Help on Classes..."); menuFile->Append(HelpDemo_Help_Functions, "&Help on Functions..."); + menuFile->Append(HelpDemo_Help_ContextHelp, "&Context Help..."); + menuFile->Append(HelpDemo_Help_DialogContextHelp, "&Dialog Context Help...\tCtrl-H"); menuFile->Append(HelpDemo_Help_Help, "&About Help Demo..."); - menuFile->AppendSeparator(); menuFile->Append(HelpDemo_Help_Search, "&Search help..."); -#ifdef __WXGTK__ +#if USE_HTML_HELP +#if USE_OLD_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->Append(HelpDemo_Html_Help_Search, "HTML &Search help..."); +#endif + 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 + +#if wxUSE_MS_HTML_HELP + menuFile->AppendSeparator(); + menuFile->Append(HelpDemo_MS_Html_Help_Index, "MS HTML &Help Index..."); + menuFile->Append(HelpDemo_MS_Html_Help_Classes, "MS HTML &Help on Classes..."); + menuFile->Append(HelpDemo_MS_Html_Help_Functions, "MS HTML &Help on Functions..."); + menuFile->Append(HelpDemo_MS_Html_Help_Help, "MS HTML &About Help Demo..."); + menuFile->Append(HelpDemo_MS_Html_Help_Search, "MS HTML &Search help..."); +#endif + +#ifndef __WXMSW__ +#if !wxUSE_HTML menuFile->AppendSeparator(); menuFile->Append(HelpDemo_Help_KDE, "Use &KDE"); menuFile->Append(HelpDemo_Help_GNOME, "Use &GNOME"); menuFile->Append(HelpDemo_Help_Netscape, "Use &Netscape"); +#endif #endif menuFile->AppendSeparator(); menuFile->Append(HelpDemo_Quit, "E&xit"); @@ -194,14 +413,13 @@ MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size) // a panel first - if there were several controls, it would allow us to // navigate between them from the keyboard - wxPanel *panel = new wxPanel(this, -1, wxPoint(0, 0), wxSize(400, 200)); + wxPanel *panel = new wxPanel(this, 301, wxPoint(0, 0), wxSize(400, 200)); + //panel->SetHelpText(_("This panel just holds a static text control.")); + panel->SetHelpText(wxContextId(300)); // and a static control whose parent is the panel - (void)new wxStaticText(panel, -1, "Hello, world!", wxPoint(10, 10)); - - // initialise the help system - help.Initialize("doc"); - + wxStaticText* staticText = new wxStaticText(panel, 302, "Hello, world!", wxPoint(10, 10)); + staticText->SetHelpText(_("This static text control isn't doing a lot right now.")); } @@ -215,48 +433,224 @@ void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event)) void MyFrame::OnHelp(wxCommandEvent& event) { - switch(event.GetId()) - { + ShowHelp(event.GetId(), m_help); +} - // Note: these DisplaySection calls use ids that are specific to wxExtHelpController - // (on Unix). For WinHelp, we'd need to use different context ids. +void MyFrame::OnShowContextHelp(wxCommandEvent& event) +{ + // This starts context help mode, then the user + // clicks on a window to send a help message + wxContextHelp contextHelp(this); +} +void MyFrame::OnShowDialogContextHelp(wxCommandEvent& event) +{ + MyModalDialog dialog(this); + dialog.ShowModal(); +} + +void MyFrame::OnHtmlHelp(wxCommandEvent& event) +{ +#if USE_HTML_HELP && USE_OLD_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::OnMSHtmlHelp(wxCommandEvent& event) +{ +#if wxUSE_MS_HTML_HELP + ShowHelp(event.GetId(), m_msHtmlHelp); +#endif +} + +/* + Notes: ShowHelp uses section ids for displaying particular topics, + but you might want to use a unique keyword to display a topic, instead. + + Section ids are specified as follows for the different formats. + + WinHelp + + The [MAP] section specifies the topic to integer id mapping, e.g. + + [MAP] + #define intro 100 + #define functions 1 + #define classes 2 + #define about 3 + + The identifier name corresponds to the label used for that topic. + You could also put these in a .h file and #include it in both the MAP + section and your C++ source. + + Note that Tex2RTF doesn't currently generate the MAP section automatically. + + MS HTML Help + + The [MAP] section specifies the HTML filename root to integer id mapping, e.g. + + [MAP] + #define doc1 100 + #define doc3 1 + #define doc2 2 + #define doc4 3 + + The identifier name corresponds to the HTML filename used for that topic. + You could also put these in a .h file and #include it in both the MAP + section and your C++ source. + + Note that Tex2RTF doesn't currently generate the MAP section automatically. + + Simple wxHTML Help and External HTML Help + + A wxhelp.map file is used, for example: + + 0 wx.htm ; wxWindows: Help index; additional keywords like overview + 1 wx204.htm ; wxWindows Function Reference + 2 wx34.htm ; wxWindows Class Reference + + Note that Tex2RTF doesn't currently generate the MAP section automatically. + + Advanced HTML Help + + An extension to the .hhc file format is used, specifying a new parameter + with name="ID": + + + + + + + + Again, this is not generated automatically by Tex2RTF, though it could + be added quite easily. + + Unfortunately adding the ID parameters appears to interfere with MS HTML Help, + so you should not try to compile a .chm file from a .hhc file with + this extension, or the contents will be messed up. + */ + +void MyFrame::ShowHelp(int commandId, wxHelpControllerBase& helpController) +{ + switch(commandId) + { case HelpDemo_Help_Classes: - help.DisplaySection(1); + case HelpDemo_Html_Help_Classes: + case HelpDemo_Advanced_Html_Help_Classes: + case HelpDemo_MS_Html_Help_Classes: + helpController.DisplaySection(2); + //helpController.DisplaySection("Classes"); // An alternative form for most controllers + break; case HelpDemo_Help_Functions: - help.DisplaySection(2); + case HelpDemo_Html_Help_Functions: + case HelpDemo_Advanced_Html_Help_Functions: + case HelpDemo_MS_Html_Help_Functions: + helpController.DisplaySection(1); + //helpController.DisplaySection("Functions"); // An alternative form for most controllers break; case HelpDemo_Help_Help: - help.DisplaySection(5); - break; - - // These three calls are only used by wxExtHelpController - - case HelpDemo_Help_KDE: - help.SetViewer("kdehelp"); - break; - case HelpDemo_Help_GNOME: - help.SetViewer("gnome-help-browser"); - break; - case HelpDemo_Help_Netscape: - help.SetViewer("netscape", wxHELP_NETSCAPE); + case HelpDemo_Html_Help_Help: + case HelpDemo_Advanced_Html_Help_Help: + case HelpDemo_MS_Html_Help_Help: + helpController.DisplaySection(3); + //helpController.DisplaySection("About"); // An alternative form for most controllers break; case HelpDemo_Help_Search: + case HelpDemo_Html_Help_Search: + case HelpDemo_Advanced_Html_Help_Search: + case HelpDemo_MS_Html_Help_Search: { wxString key = wxGetTextFromUser("Search for?", "Search help for keyword", "", this); if(! key.IsEmpty()) - help.KeywordSearch(key); + helpController.KeywordSearch(key); } break; + case HelpDemo_Help_Index: + case HelpDemo_Html_Help_Index: + case HelpDemo_Advanced_Html_Help_Index: + case HelpDemo_MS_Html_Help_Index: + helpController.DisplayContents(); + break; + + // These three calls are only used by wxExtHelpController + + case HelpDemo_Help_KDE: + helpController.SetViewer("kdehelp"); + break; + case HelpDemo_Help_GNOME: + helpController.SetViewer("gnome-help-browser"); + break; + case HelpDemo_Help_Netscape: + helpController.SetViewer("netscape", wxHELP_NETSCAPE); + break; default: - help.DisplayContents(); break; } } +// ---------------------------------------------------------------------------- +// MyModalDialog +// Demonstrates context-sensitive help +// ---------------------------------------------------------------------------- + +BEGIN_EVENT_TABLE(MyModalDialog, wxDialog) +END_EVENT_TABLE() + +MyModalDialog::MyModalDialog(wxWindow *parent) + : wxDialog() +{ + // Add the context-sensitive help button on the caption for MSW +#ifdef __WXMSW__ + SetExtraStyle(wxDIALOG_EX_CONTEXTHELP); +#endif + + wxDialog::Create(parent, -1, wxString("Modal dialog")); + + wxBoxSizer *sizerTop = new wxBoxSizer(wxVERTICAL); + wxBoxSizer *sizerRow = new wxBoxSizer(wxHORIZONTAL); + + wxButton* btnOK = new wxButton(this, wxID_OK, "&OK"); + btnOK->SetHelpText(_("The OK button confirms the dialog choices.")); + + wxButton* btnCancel = new wxButton(this, wxID_CANCEL, "&Cancel"); + btnCancel->SetHelpText(_("The Cancel button cancels the dialog.")); + + sizerRow->Add(btnOK, 0, wxALIGN_CENTER | wxALL, 5); + sizerRow->Add(btnCancel, 0, wxALIGN_CENTER | wxALL, 5); + + // Add explicit context-sensitive help button for non-MSW +#ifndef __WXMSW__ + sizerRow->Add(new wxContextHelpButton(this), 0, wxALIGN_CENTER | wxALL, 5); +#endif + + wxTextCtrl *text = new wxTextCtrl(this, -1, wxT("A demo text control"), + wxDefaultPosition, wxSize(300, 100), + wxTE_MULTILINE); + text->SetHelpText(_("Type text here if you have got nothing more " + "interesting to do")); + 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); + sizerTop->Fit(this); + + btnOK->SetFocus(); + btnOK->SetDefault(); +} +