#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 <wx/filesys.h>
-#include <wx/fs_zip.h>
-
-#if USE_OLD_HTML_HELP
-#include "wx/generic/helpwxht.h"
-#endif
+#include "wx/filesys.h"
+#include "wx/fs_zip.h"
#include "wx/html/helpctrl.h"
#endif
#include "wx/msw/helpchm.h"
#endif
+#if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP
+#include "wx/msw/helpbest.h"
+#endif
+
// ----------------------------------------------------------------------------
// ressources
// ----------------------------------------------------------------------------
// the application icon
-#if defined(__WXGTK__) || defined(__WXMOTIF__)
+#if defined(__WXGTK__) || defined(__WXX11__) || defined(__WXMOTIF__) || defined(__WXMAC__) || defined(__WXMGL__)
#include "mondrian.xpm"
#endif
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
+#if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP
+ wxBestHelpController& GetBestHelpController() { return m_bestHelp; }
+#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 OnBestHelp(wxCommandEvent& event);
- void OnContextHelp(wxHelpEvent& event);
void OnShowContextHelp(wxCommandEvent& event);
void OnShowDialogContextHelp(wxCommandEvent& event);
wxHelpController m_help;
#if USE_HTML_HELP
-#if USE_OLD_HTML_HELP
- wxHelpControllerHtml m_htmlHelp;
-#endif
wxHtmlHelpController m_advancedHtmlHelp;
#endif
wxCHMHelpController m_msHtmlHelp;
#endif
+#if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP
+ wxBestHelpController m_bestHelp;
+#endif
+
// any class wishing to process wxWindows events must use this macro
DECLARE_EVENT_TABLE()
};
public:
MyModalDialog(wxWindow *parent);
- void OnContextHelp(wxHelpEvent& event);
-
private:
DECLARE_EVENT_TABLE()
enum
{
// menu items
- HelpDemo_Quit = 1,
+ HelpDemo_Quit = 100,
HelpDemo_Help_Index,
HelpDemo_Help_Classes,
HelpDemo_Help_Functions,
HelpDemo_MS_Html_Help_Help,
HelpDemo_MS_Html_Help_Search,
+ HelpDemo_Best_Help_Index,
+ HelpDemo_Best_Help_Classes,
+ HelpDemo_Best_Help_Functions,
+ HelpDemo_Best_Help_Help,
+ HelpDemo_Best_Help_Search,
+
HelpDemo_Help_KDE,
HelpDemo_Help_GNOME,
HelpDemo_Help_Netscape,
EVT_MENU(HelpDemo_Help_ContextHelp, MyFrame::OnShowContextHelp)
EVT_MENU(HelpDemo_Help_DialogContextHelp, MyFrame::OnShowDialogContextHelp)
- EVT_HELP(-1, MyFrame::OnContextHelp)
-
- 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_MS_Html_Help_Help, MyFrame::OnMSHtmlHelp)
EVT_MENU(HelpDemo_MS_Html_Help_Search, MyFrame::OnMSHtmlHelp)
+ EVT_MENU(HelpDemo_Best_Help_Index, MyFrame::OnBestHelp)
+
EVT_MENU(HelpDemo_Help_KDE, MyFrame::OnHelp)
EVT_MENU(HelpDemo_Help_GNOME, MyFrame::OnHelp)
EVT_MENU(HelpDemo_Help_Netscape, MyFrame::OnHelp)
// `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
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);
// using HTML help
if ( !frame->GetHelpController().Initialize("doc") )
{
- wxLogError("Cannot initialize the help system, aborting.");
+ wxLogError(wxT("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") )
+#if wxUSE_MS_HTML_HELP
+ if( !frame->GetMSHtmlHelpController().Initialize("doc") )
{
- wxLogError("Cannot initialize the HTML help system, aborting.");
+ wxLogError(wxT("Cannot initialize the MS HTML Help system."));
+ }
+#endif
- return FALSE;
+#if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP
+ // you need to call Initialize in order to use wxBestHelpController
+ if( !frame->GetBestHelpController().Initialize("doc") )
+ {
+ wxLogError(wxT("Cannot initialize the best help system, aborting."));
}
#endif
+#if USE_HTML_HELP
// 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.");
+ wxLogError(wxT("Cannot initialize the advanced HTML help system, aborting."));
return FALSE;
}
#endif
-#if wxUSE_MS_HTML_HELP
- if ( !frame->GetMSHtmlHelpController().Initialize("doc") )
+#if 0
+ // 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.");
}
#endif
- // create a simple help provider to make SetHelpText() do something
- wxHelpProvider::Set(new wxSimpleHelpProvider);
-
return TRUE;
}
// 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));
menuFile->Append(HelpDemo_Help_Help, "&About Help Demo...");
menuFile->Append(HelpDemo_Help_Search, "&Search help...");
#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_MS_Html_Help_Search, "MS HTML &Search help...");
#endif
+#if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP
+ menuFile->AppendSeparator();
+ menuFile->Append(HelpDemo_Best_Help_Index, "Best &Help Index...");
+#endif
+
#ifndef __WXMSW__
#if !wxUSE_HTML
menuFile->AppendSeparator();
// 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));
+ wxStaticText* staticText = new wxStaticText(panel, 302, "Hello, world!", wxPoint(10, 10));
+ staticText->SetHelpText(_("This static text control isn't doing a lot right now."));
}
dialog.ShowModal();
}
-void MyFrame::OnContextHelp(wxHelpEvent& event)
-{
- // In a real app, if we didn't recognise this ID, we should call event.Skip()
- wxString msg;
- msg.Printf(wxT("We should now display help for window %d"), event.GetId());
- wxMessageBox(msg);
-}
-
-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
#endif
}
+void MyFrame::OnBestHelp(wxCommandEvent& event)
+{
+#if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP
+ ShowHelp(event.GetId(), m_bestHelp);
+#endif
+}
+
/*
Notes: ShowHelp uses section ids for displaying particular topics,
but you might want to use a unique keyword to display a topic, instead.
{
switch(commandId)
{
- case HelpDemo_Help_Classes:
- 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:
- 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:
- 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())
- 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:
- break;
+ case HelpDemo_Help_Classes:
+ case HelpDemo_Html_Help_Classes:
+ case HelpDemo_Advanced_Html_Help_Classes:
+ case HelpDemo_MS_Html_Help_Classes:
+ case HelpDemo_Best_Help_Classes:
+ helpController.DisplaySection(2);
+ //helpController.DisplaySection("Classes"); // An alternative form for most controllers
+ break;
+
+ case HelpDemo_Help_Functions:
+ 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:
+ case HelpDemo_Html_Help_Help:
+ case HelpDemo_Advanced_Html_Help_Help:
+ case HelpDemo_MS_Html_Help_Help:
+ case HelpDemo_Best_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:
+ case HelpDemo_Best_Help_Search:
+ {
+ wxString key = wxGetTextFromUser("Search for?",
+ "Search help for keyword",
+ "",
+ this);
+ if(! key.IsEmpty())
+ 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:
+ case HelpDemo_Best_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;
}
}
// ----------------------------------------------------------------------------
BEGIN_EVENT_TABLE(MyModalDialog, wxDialog)
- EVT_HELP(-1, MyModalDialog::OnContextHelp)
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 the context-sensitive help button on the caption for MSW and the
- // explicit context-sensitive help button elsewhere
-#ifdef __WXMSW__
- SetExtraStyle(wxDIALOG_EX_CONTEXTHELP);
-#else
+ // 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"));
+ 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 );
btnOK->SetDefault();
}
-void MyModalDialog::OnContextHelp(wxHelpEvent& event)
-{
- wxString msg;
- switch (event.GetId())
- {
- case wxID_OK:
- {
- msg = _("The OK button confirms the dialog choices.");
- break;
- }
- case wxID_CANCEL:
- {
- msg = _("The Cancel button cancels the dialog.");
- break;
- }
- case wxID_APPLY:
- {
- msg = _("This is a text control that does nothing in particular.");
- break;
- }
- case wxID_CONTEXT_HELP:
- {
- msg = _("If you didn't know what this button is for, why did you press it? :-)");
- break;
- }
- }
- if (!msg.IsEmpty())
- wxMessageBox(msg, _("Help"), wxICON_INFORMATION, this);
-}
-
projects / wxWidgets.git / blobdiff