// 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
// ----------------------------------------------------------------------------
// the application icon
-#if defined(__WXGTK__) || defined(__WXX11__) || defined(__WXMOTIF__) || defined(__WXMAC__) || defined(__WXMGL__)
- #include "mondrian.xpm"
+#ifndef wxHAS_IMAGES_IN_RESOURCES
+ #include "../sample.xpm"
#endif
// ----------------------------------------------------------------------------
// 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,
HelpDemo_Help_GNOME,
HelpDemo_Help_Netscape,
// controls start here (the numbers are, of course, arbitrary)
- HelpDemo_Text = 1000,
+ HelpDemo_Text = 1000
};
// ----------------------------------------------------------------------------
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)
// `Main program' equivalent: the program execution "starts" here
bool MyApp::OnInit()
{
+ if ( !wxApp::OnInit() )
+ return false;
+
// Create a simple help provider to make SetHelpText() do something.
// Note that this must be set before any SetHelpText() calls are made.
#if USE_SIMPLE_HELP_PROVIDER
#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"),
+ MyFrame *frame = new MyFrame(wxT("HelpDemo wxWidgets App"),
wxPoint(50, 50), wxSize(450, 340));
#if !USE_SIMPLE_HELP_PROVIDER
#else
provider->SetHelpController(& frame->GetHelpController());
#endif
-#endif
+#endif // !USE_SIMPLE_HELP_PROVIDER
frame->Show(true);
- SetTopWindow(frame);
// 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(_T("doc")) )
+ if ( !frame->GetHelpController().Initialize(wxT("doc")) )
{
wxLogError(wxT("Cannot initialize the help system, aborting."));
}
#if wxUSE_MS_HTML_HELP && !defined(__WXUNIVERSAL__)
- if( !frame->GetMSHtmlHelpController().Initialize(_T("doc")) )
+ if( !frame->GetMSHtmlHelpController().Initialize(wxT("doc")) )
{
wxLogError(wxT("Cannot initialize the MS HTML Help system."));
}
#if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP && !defined(__WXUNIVERSAL__)
// you need to call Initialize in order to use wxBestHelpController
- if( !frame->GetBestHelpController().Initialize(_T("doc")) )
+ if( !frame->GetBestHelpController().Initialize(wxT("doc")) )
{
wxLogError(wxT("Cannot initialize the best help system, aborting."));
}
#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(_T("doc")) )
+ if ( !frame->GetAdvancedHtmlHelpController().Initialize(wxT("doc")) )
{
wxLogError(wxT("Cannot initialize the advanced HTML help system, aborting."));
#if 0
// defined(__WXMSW__) && wxUSE_MS_HTML_HELP
wxString path(wxGetCwd());
- if ( !frame->GetMSHtmlHelpController().Initialize(path + _T("\\doc.chm")) )
+ if ( !frame->GetMSHtmlHelpController().Initialize(path + wxT("\\doc.chm")) )
{
wxLogError("Cannot initialize the MS HTML help system, aborting.");
// 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));
+ SetIcon(wxICON(sample));
// create a menu bar
wxMenu *menuFile = new wxMenu;
- menuFile->Append(HelpDemo_Help_Index, _T("&Help Index..."));
- menuFile->Append(HelpDemo_Help_Classes, _T("&Help on Classes..."));
- menuFile->Append(HelpDemo_Help_Functions, _T("&Help on Functions..."));
- menuFile->Append(HelpDemo_Help_ContextHelp, _T("&Context Help..."));
- menuFile->Append(HelpDemo_Help_DialogContextHelp, _T("&Dialog Context Help...\tCtrl-H"));
- menuFile->Append(HelpDemo_Help_Help, _T("&About Help Demo..."));
- menuFile->Append(HelpDemo_Help_Search, _T("&Search help..."));
+ menuFile->Append(HelpDemo_Help_Index, wxT("&Help Index..."));
+ menuFile->Append(HelpDemo_Help_Classes, wxT("&Help on Classes..."));
+ menuFile->Append(HelpDemo_Help_Functions, wxT("&Help on Functions..."));
+ menuFile->Append(HelpDemo_Help_ContextHelp, wxT("&Context Help..."));
+ menuFile->Append(HelpDemo_Help_DialogContextHelp, wxT("&Dialog Context Help...\tCtrl-H"));
+ menuFile->Append(HelpDemo_Help_Help, wxT("&About Help Demo..."));
+ menuFile->Append(HelpDemo_Help_Search, wxT("&Search help..."));
#if USE_HTML_HELP
menuFile->AppendSeparator();
- menuFile->Append(HelpDemo_Advanced_Html_Help_Index, _T("Advanced HTML &Help Index..."));
- menuFile->Append(HelpDemo_Advanced_Html_Help_Classes, _T("Advanced HTML &Help on Classes..."));
- 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_Index, wxT("Advanced HTML &Help Index..."));
+ menuFile->Append(HelpDemo_Advanced_Html_Help_Classes, wxT("Advanced HTML &Help on Classes..."));
+ menuFile->Append(HelpDemo_Advanced_Html_Help_Functions, wxT("Advanced HTML &Help on Functions..."));
+ menuFile->Append(HelpDemo_Advanced_Html_Help_Help, wxT("Advanced HTML &About Help Demo..."));
+ menuFile->Append(HelpDemo_Advanced_Html_Help_Search, wxT("Advanced HTML &Search help..."));
+ menuFile->Append(HelpDemo_Advanced_Html_Help_Modal, wxT("Advanced HTML Help &Modal Dialog..."));
#endif
#if wxUSE_MS_HTML_HELP && !defined(__WXUNIVERSAL__)
menuFile->AppendSeparator();
- menuFile->Append(HelpDemo_MS_Html_Help_Index, _T("MS HTML &Help Index..."));
- menuFile->Append(HelpDemo_MS_Html_Help_Classes, _T("MS HTML &Help on Classes..."));
- menuFile->Append(HelpDemo_MS_Html_Help_Functions, _T("MS HTML &Help on Functions..."));
- menuFile->Append(HelpDemo_MS_Html_Help_Help, _T("MS HTML &About Help Demo..."));
- menuFile->Append(HelpDemo_MS_Html_Help_Search, _T("MS HTML &Search help..."));
+ menuFile->Append(HelpDemo_MS_Html_Help_Index, wxT("MS HTML &Help Index..."));
+ menuFile->Append(HelpDemo_MS_Html_Help_Classes, wxT("MS HTML &Help on Classes..."));
+ menuFile->Append(HelpDemo_MS_Html_Help_Functions, wxT("MS HTML &Help on Functions..."));
+ menuFile->Append(HelpDemo_MS_Html_Help_Help, wxT("MS HTML &About Help Demo..."));
+ menuFile->Append(HelpDemo_MS_Html_Help_Search, wxT("MS HTML &Search help..."));
#endif
#if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP && !defined(__WXUNIVERSAL__)
menuFile->AppendSeparator();
- menuFile->Append(HelpDemo_Best_Help_Index, _T("Best &Help Index..."));
+ menuFile->Append(HelpDemo_Best_Help_Index, wxT("Best &Help Index..."));
#endif
#ifndef __WXMSW__
#if !wxUSE_HTML
menuFile->AppendSeparator();
- menuFile->Append(HelpDemo_Help_KDE, _T("Use &KDE"));
- menuFile->Append(HelpDemo_Help_GNOME, _T("Use &GNOME"));
- menuFile->Append(HelpDemo_Help_Netscape, _T("Use &Netscape"));
+ menuFile->Append(HelpDemo_Help_KDE, wxT("Use &KDE"));
+ menuFile->Append(HelpDemo_Help_GNOME, wxT("Use &GNOME"));
+ menuFile->Append(HelpDemo_Help_Netscape, wxT("Use &Netscape"));
#endif
#endif
menuFile->AppendSeparator();
- menuFile->Append(HelpDemo_Quit, _T("E&xit"));
+ menuFile->Append(HelpDemo_Quit, wxT("E&xit"));
// now append the freshly created menu to the menu bar...
wxMenuBar *menuBar = new wxMenuBar;
- menuBar->Append(menuFile, _T("&File"));
+ menuBar->Append(menuFile, wxT("&File"));
// ... 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!"));
+ SetStatusText(wxT("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(wxT("doc.zip")));
+ m_embeddedHtmlHelp.Display(wxT("Introduction"));
+#else
// now create some controls
// a panel first - if there were several controls, it would allow us to
//panel->SetHelpText(wxContextId(300));
// and a static control whose parent is the panel
- wxStaticText* staticText = new wxStaticText(panel, 302, _T("Hello, world!"), wxPoint(10, 10));
+ wxStaticText* staticText = new wxStaticText(panel, 302, wxT("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.
case HelpDemo_MS_Html_Help_Search:
case HelpDemo_Best_Help_Search:
{
- wxString key = wxGetTextFromUser(_T("Search for?"),
- _T("Search help for keyword"),
+ wxString key = wxGetTextFromUser(wxT("Search for?"),
+ wxT("Search help for keyword"),
wxEmptyString,
this);
if(! key.IsEmpty())
// These three calls are only used by wxExtHelpController
case HelpDemo_Help_KDE:
- helpController.SetViewer(_T("kdehelp"));
+ helpController.SetViewer(wxT("kdehelp"));
break;
case HelpDemo_Help_GNOME:
- helpController.SetViewer(_T("gnome-help-browser"));
+ helpController.SetViewer(wxT("gnome-help-browser"));
break;
case HelpDemo_Help_Netscape:
- helpController.SetViewer(_T("netscape"), wxHELP_NETSCAPE);
+ helpController.SetViewer(wxT("netscape"), wxHELP_NETSCAPE);
break;
}
}
END_EVENT_TABLE()
MyModalDialog::MyModalDialog(wxWindow *parent)
- : wxDialog()
+ : wxDialog(parent, wxID_ANY, wxString(wxT("Modal dialog")))
{
- // Add the context-sensitive help button on the caption for MSW
-#ifdef __WXMSW__
+ // Add the context-sensitive help button on the caption for the platforms
+ // which support it (currently MSW only)
SetExtraStyle(wxDIALOG_EX_CONTEXTHELP);
-#endif
- wxDialog::Create(parent, wxID_ANY, wxString(_T("Modal dialog")));
wxBoxSizer *sizerTop = new wxBoxSizer(wxVERTICAL);
wxBoxSizer *sizerRow = new wxBoxSizer(wxHORIZONTAL);
- wxButton* btnOK = new wxButton(this, wxID_OK, _T("&OK"));
+ wxButton* btnOK = new wxButton(this, wxID_OK, wxT("&OK"));
btnOK->SetHelpText(_("The OK button confirms the dialog choices."));
- wxButton* btnCancel = new wxButton(this, wxID_CANCEL, _T("&Cancel"));
+ wxButton* btnCancel = new wxButton(this, wxID_CANCEL, wxT("&Cancel"));
btnCancel->SetHelpText(_("The Cancel button cancels the dialog."));
sizerRow->Add(btnOK, 0, wxALIGN_CENTER | wxALL, 5);
sizerTop->Add(text, 0, wxEXPAND|wxALIGN_CENTER_VERTICAL|wxALL, 5 );
sizerTop->Add(sizerRow, 0, wxALIGN_RIGHT|wxALIGN_CENTER_VERTICAL|wxALL, 5 );
- SetSizer(sizerTop);
-
- sizerTop->SetSizeHints(this);
- sizerTop->Fit(this);
+ SetSizerAndFit(sizerTop);
btnOK->SetFocus();
btnOK->SetDefault();
projects / wxWidgets.git / blobdiff