#endif
// for all others, include the necessary headers (this file is usually all you
-// need because it includes almost all "standard" wxWindows headers
+// need because it includes almost all "standard" wxWidgets headers
#ifndef WX_PRECOMP
# include "wx/wx.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
+// 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/html/helpctrl.h"
#endif
-#if wxUSE_MS_HTML_HELP
+#if wxUSE_MS_HTML_HELP && !defined(__WXUNIVERSAL__)
#include "wx/msw/helpchm.h"
#endif
-#if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP
+#if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP && !defined(__WXUNIVERSAL__)
#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; }
#endif
-#if wxUSE_MS_HTML_HELP
+#if wxUSE_MS_HTML_HELP && !defined(__WXUNIVERSAL__)
wxCHMHelpController& GetMSHtmlHelpController() { return m_msHtmlHelp; }
#endif
-#if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP
+#if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP && !defined(__WXUNIVERSAL__)
wxBestHelpController& GetBestHelpController() { return m_bestHelp; }
#endif
void OnQuit(wxCommandEvent& event);
void OnHelp(wxCommandEvent& event);
void OnAdvancedHtmlHelp(wxCommandEvent& event);
+#if wxUSE_MS_HTML_HELP && !defined(__WXUNIVERSAL__)
void OnMSHtmlHelp(wxCommandEvent& event);
+#endif
+#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
+#if wxUSE_MS_HTML_HELP && !defined(__WXUNIVERSAL__)
wxCHMHelpController m_msHtmlHelp;
#endif
-#if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP
+#if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP && !defined(__WXUNIVERSAL__)
wxBestHelpController m_bestHelp;
#endif
- // any class wishing to process wxWindows events must use this macro
+ // any class wishing to process wxWidgets events must use this macro
DECLARE_EVENT_TABLE()
};
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
};
// ----------------------------------------------------------------------------
-// event tables and other macros for wxWindows
+// event tables and other macros for wxWidgets
// ----------------------------------------------------------------------------
-// the event tables connect the wxWindows events with the functions (event
+// the event tables connect the wxWidgets events with the functions (event
// handlers) which process them. It can be also done at run-time, but for the
// simple menu events like this the static method is much simpler.
BEGIN_EVENT_TABLE(MyFrame, wxFrame)
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)
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)
+#endif
+#if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP && !defined(__WXUNIVERSAL__)
EVT_MENU(HelpDemo_Best_Help_Index, MyFrame::OnBestHelp)
+#endif
EVT_MENU(HelpDemo_Help_KDE, MyFrame::OnHelp)
EVT_MENU(HelpDemo_Help_GNOME, MyFrame::OnHelp)
EVT_MENU(HelpDemo_Help_Netscape, MyFrame::OnHelp)
END_EVENT_TABLE()
-// Create a new application object: this macro will allow wxWindows to create
+// Create a new application object: this macro will allow wxWidgets to create
// the application object during program execution (it's better than using a
// static object for many reasons) and also declares the accessor function
// wxGetApp() which will return the reference of the right type (i.e. MyApp and
// `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("HelpDemo wxWindows App",
+ MyFrame *frame = new MyFrame(_T("HelpDemo wxWidgets App"),
wxPoint(50, 50), wxSize(450, 340));
#if !USE_SIMPLE_HELP_PROVIDER
-#if wxUSE_MS_HTML_HELP
+#if wxUSE_MS_HTML_HELP && !defined(__WXUNIVERSAL__)
provider->SetHelpController(& frame->GetMSHtmlHelpController());
#else
provider->SetHelpController(& frame->GetHelpController());
#endif
-#endif
+#endif // !USE_SIMPLE_HELP_PROVIDER
- frame->Show(TRUE);
+ 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("doc") )
+ if ( !frame->GetHelpController().Initialize(_T("doc")) )
{
wxLogError(wxT("Cannot initialize the help system, aborting."));
- return FALSE;
+ return false;
}
-#if wxUSE_MS_HTML_HELP
- if( !frame->GetMSHtmlHelpController().Initialize("doc") )
+#if wxUSE_MS_HTML_HELP && !defined(__WXUNIVERSAL__)
+ if( !frame->GetMSHtmlHelpController().Initialize(_T("doc")) )
{
wxLogError(wxT("Cannot initialize the MS HTML Help system."));
}
#endif
-#if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP
+#if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP && !defined(__WXUNIVERSAL__)
// you need to call Initialize in order to use wxBestHelpController
- if( !frame->GetBestHelpController().Initialize("doc") )
+ if( !frame->GetBestHelpController().Initialize(_T("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("doc") )
+ if ( !frame->GetAdvancedHtmlHelpController().Initialize(_T("doc")) )
{
wxLogError(wxT("Cannot initialize the advanced HTML help system, aborting."));
- return FALSE;
+ return false;
}
#endif
#if 0
// defined(__WXMSW__) && wxUSE_MS_HTML_HELP
wxString path(wxGetCwd());
- if ( !frame->GetMSHtmlHelpController().Initialize(path + "\\doc.chm") )
+ if ( !frame->GetMSHtmlHelpController().Initialize(path + _T("\\doc.chm")) )
{
wxLogError("Cannot initialize the MS HTML help system, aborting.");
- return FALSE;
+ return false;
}
#endif
- return TRUE;
+ return true;
}
int MyApp::OnExit()
// 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));
// create a menu bar
wxMenu *menuFile = new wxMenu;
- 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->Append(HelpDemo_Help_Search, "&Search help...");
+ 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..."));
#if USE_HTML_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...");
+ 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_Modal, _T("Advanced HTML Help &Modal Dialog..."));
#endif
-#if wxUSE_MS_HTML_HELP
+#if wxUSE_MS_HTML_HELP && !defined(__WXUNIVERSAL__)
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...");
+ 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..."));
#endif
-#if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP
+#if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP && !defined(__WXUNIVERSAL__)
menuFile->AppendSeparator();
- menuFile->Append(HelpDemo_Best_Help_Index, "Best &Help Index...");
+ menuFile->Append(HelpDemo_Best_Help_Index, _T("Best &Help Index..."));
#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");
+ menuFile->Append(HelpDemo_Help_KDE, _T("Use &KDE"));
+ menuFile->Append(HelpDemo_Help_GNOME, _T("Use &GNOME"));
+ menuFile->Append(HelpDemo_Help_Netscape, _T("Use &Netscape"));
#endif
#endif
menuFile->AppendSeparator();
- menuFile->Append(HelpDemo_Quit, "E&xit");
+ menuFile->Append(HelpDemo_Quit, _T("E&xit"));
// now append the freshly created menu to the menu bar...
wxMenuBar *menuBar = new wxMenuBar;
- menuBar->Append(menuFile, "&File");
+ menuBar->Append(menuFile, _T("&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("Welcome to wxWindows!");
+ 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
//panel->SetHelpText(wxContextId(300));
// and a static control whose parent is the panel
- wxStaticText* staticText = new wxStaticText(panel, 302, "Hello, world!", wxPoint(10, 10));
+ 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
}
void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event))
{
- // TRUE is to force the frame to close
- Close(TRUE);
+ // true is to force the frame to close
+ Close(true);
}
void MyFrame::OnHelp(wxCommandEvent& event)
ShowHelp(event.GetId(), m_help);
}
-void MyFrame::OnShowContextHelp(wxCommandEvent& event)
+void MyFrame::OnShowContextHelp(wxCommandEvent& WXUNUSED(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)
+void MyFrame::OnShowDialogContextHelp(wxCommandEvent& WXUNUSED(event))
{
MyModalDialog dialog(this);
dialog.ShowModal();
#endif
}
+#if wxUSE_MS_HTML_HELP && !defined(__WXUNIVERSAL__)
void MyFrame::OnMSHtmlHelp(wxCommandEvent& event)
{
-#if wxUSE_MS_HTML_HELP
ShowHelp(event.GetId(), m_msHtmlHelp);
-#endif
}
+#endif
+#if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP && !defined(__WXUNIVERSAL__)
void MyFrame::OnBestHelp(wxCommandEvent& event)
{
-#if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP
ShowHelp(event.GetId(), m_bestHelp);
+}
#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,
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
+ 0 wx.htm ; wxWidgets: Help index; additional keywords like overview
+ 1 wx204.htm ; wxWidgets Function Reference
+ 2 wx34.htm ; wxWidgets Class Reference
Note that Tex2RTF doesn't currently generate the MAP section automatically.
case HelpDemo_MS_Html_Help_Search:
case HelpDemo_Best_Help_Search:
{
- wxString key = wxGetTextFromUser("Search for?",
- "Search help for keyword",
- "",
+ wxString key = wxGetTextFromUser(_T("Search for?"),
+ _T("Search help for keyword"),
+ wxEmptyString,
this);
if(! key.IsEmpty())
helpController.KeywordSearch(key);
// These three calls are only used by wxExtHelpController
case HelpDemo_Help_KDE:
- helpController.SetViewer("kdehelp");
+ helpController.SetViewer(_T("kdehelp"));
break;
case HelpDemo_Help_GNOME:
- helpController.SetViewer("gnome-help-browser");
+ helpController.SetViewer(_T("gnome-help-browser"));
break;
case HelpDemo_Help_Netscape:
- helpController.SetViewer("netscape", wxHELP_NETSCAPE);
+ helpController.SetViewer(_T("netscape"), wxHELP_NETSCAPE);
break;
}
}
END_EVENT_TABLE()
MyModalDialog::MyModalDialog(wxWindow *parent)
- : wxDialog()
+ : wxDialog(parent, wxID_ANY, wxString(_T("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, -1, wxString("Modal dialog"));
wxBoxSizer *sizerTop = new wxBoxSizer(wxVERTICAL);
wxBoxSizer *sizerRow = new wxBoxSizer(wxHORIZONTAL);
- wxButton* btnOK = new wxButton(this, wxID_OK, "&OK");
+ wxButton* btnOK = new wxButton(this, wxID_OK, _T("&OK"));
btnOK->SetHelpText(_("The OK button confirms the dialog choices."));
- wxButton* btnCancel = new wxButton(this, wxID_CANCEL, "&Cancel");
+ wxButton* btnCancel = new wxButton(this, wxID_CANCEL, _T("&Cancel"));
btnCancel->SetHelpText(_("The Cancel button cancels the dialog."));
sizerRow->Add(btnOK, 0, wxALIGN_CENTER | wxALL, 5);
sizerRow->Add(new wxContextHelpButton(this), 0, wxALIGN_CENTER | wxALL, 5);
#endif
- wxTextCtrl *text = new wxTextCtrl(this, -1, wxT("A demo text control"),
+ wxTextCtrl *text = new wxTextCtrl(this, wxID_ANY, 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);
projects / wxWidgets.git / blobdiff