samples/help/demo.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        demo.cpp
   3 // Purpose:     wxHelpController demo
   4 // Author:      Karsten Ballueder
   5 // Modified by:
   6 // Created:     04/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Karsten Ballueder, Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 // For compilers that support precompilation, includes "wx/wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24 #   pragma hdrstop
  25 #endif
  26
  27 // for all others, include the necessary headers (this file is usually all you
  28 // need because it includes almost all "standard" wxWidgets headers
  29 #ifndef WX_PRECOMP
  30 #   include "wx/wx.h"
  31 #endif
  32
  33 #   include "wx/image.h"
  34 #   include "wx/help.h"
  35 #   include "wx/cshelp.h"
  36
  37 #if wxUSE_TOOLTIPS
  38 #   include "wx/tooltip.h"
  39 #endif
  40
  41 // define this to 1 to use HTML help even under Windows (by default, Windows
  42 // version will use WinHelp).
  43 // Please also see samples/html/helpview.
  44 #define USE_HTML_HELP 1
  45
  46 // define this to 1 to use external help controller (not used by default)
  47 #define USE_EXT_HELP 0
  48
  49 // Define this to 0 to use the help controller as the help
  50 // provider, or to 1 to use the 'simple help provider'
  51 // (the one implemented with wxTipWindow).
  52 #define USE_SIMPLE_HELP_PROVIDER 0
  53
  54 #if !wxUSE_HTML
  55 #undef USE_HTML_HELP
  56 #define USE_HTML_HELP 0
  57 #endif
  58
  59 #if USE_HTML_HELP
  60 #include "wx/filesys.h"
  61 #include "wx/fs_zip.h"
  62
  63 #include "wx/html/helpctrl.h"
  64 #endif
  65
  66 #if wxUSE_MS_HTML_HELP && !defined(__WXUNIVERSAL__)
  67 #include "wx/msw/helpchm.h"
  68 #endif
  69
  70 #if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP && !defined(__WXUNIVERSAL__)
  71 #include "wx/msw/helpbest.h"
  72 #endif
  73
  74 #if USE_EXT_HELP
  75 #include "wx/generic/helpext.h"
  76 #endif
  77
  78 // ----------------------------------------------------------------------------
  79 // ressources
  80 // ----------------------------------------------------------------------------
  81 // the application icon
  82 #if defined(__WXGTK__) || defined(__WXX11__) || defined(__WXMOTIF__) || defined(__WXMAC__) || defined(__WXMGL__)
  83     #include "mondrian.xpm"
  84 #endif
  85
  86 // ----------------------------------------------------------------------------
  87 // private classes
  88 // ----------------------------------------------------------------------------
  89
  90 // Define a new application type, each program should derive a class from wxApp
  91 class MyApp : public wxApp
  92 {
  93 public:
  94     // override base class virtuals
  95     // ----------------------------
  96
  97     // this one is called on application startup and is a good place for the app
  98     // initialization (doing it here and not in the ctor allows to have an error
  99     // return: if OnInit() returns false, the application terminates)
 100     virtual bool OnInit();
 101
 102     // do some clean up here
 103     virtual int OnExit();
 104 };
 105
 106 // Define a new frame type: this is going to be our main frame
 107 class MyFrame : public wxFrame
 108 {
 109 public:
 110     // ctor(s)
 111     MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size);
 112
 113     wxHelpControllerBase& GetHelpController() { return m_help; }
 114
 115 #if USE_HTML_HELP
 116     wxHtmlHelpController& GetAdvancedHtmlHelpController() { return m_advancedHtmlHelp; }
 117 #endif
 118 #if wxUSE_MS_HTML_HELP && !defined(__WXUNIVERSAL__)
 119     wxCHMHelpController& GetMSHtmlHelpController() { return m_msHtmlHelp; }
 120 #endif
 121 #if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP && !defined(__WXUNIVERSAL__)
 122     wxBestHelpController& GetBestHelpController() { return m_bestHelp; }
 123 #endif
 124
 125     // event handlers (these functions should _not_ be virtual)
 126     void OnQuit(wxCommandEvent& event);
 127     void OnHelp(wxCommandEvent& event);
 128     void OnAdvancedHtmlHelp(wxCommandEvent& event);
 129 #if wxUSE_MS_HTML_HELP && !defined(__WXUNIVERSAL__)
 130     void OnMSHtmlHelp(wxCommandEvent& event);
 131 #endif
 132 #if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP && !defined(__WXUNIVERSAL__)
 133     void OnBestHelp(wxCommandEvent& event);
 134 #endif
 135 #if USE_HTML_HELP
 136     void OnModalHtmlHelp(wxCommandEvent& event);
 137 #endif
 138
 139     void OnShowContextHelp(wxCommandEvent& event);
 140     void OnShowDialogContextHelp(wxCommandEvent& event);
 141
 142     void ShowHelp(int commandId, wxHelpControllerBase& helpController);
 143
 144 private:
 145 #if USE_EXT_HELP
 146    wxExtHelpController      m_help;
 147 #else
 148    wxHelpController         m_help;
 149 #endif
 150
 151 #if USE_HTML_HELP
 152    wxHtmlHelpController     m_advancedHtmlHelp;
 153    wxHtmlHelpController     m_embeddedHtmlHelp;
 154    wxHtmlHelpWindow*        m_embeddedHelpWindow;
 155 #endif
 156
 157 #if wxUSE_MS_HTML_HELP && !defined(__WXUNIVERSAL__)
 158     wxCHMHelpController     m_msHtmlHelp;
 159 #endif
 160
 161 #if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP && !defined(__WXUNIVERSAL__)
 162     wxBestHelpController    m_bestHelp;
 163 #endif
 164
 165     // any class wishing to process wxWidgets events must use this macro
 166    DECLARE_EVENT_TABLE()
 167 };
 168
 169 // A custom modal dialog
 170 class MyModalDialog : public wxDialog
 171 {
 172 public:
 173     MyModalDialog(wxWindow *parent);
 174
 175 private:
 176
 177     DECLARE_EVENT_TABLE()
 178 };
 179
 180 // ----------------------------------------------------------------------------
 181 // constants
 182 // ----------------------------------------------------------------------------
 183
 184 // IDs for the controls and the menu commands
 185 enum
 186 {
 187     // menu items
 188     HelpDemo_Quit = 100,
 189     HelpDemo_Help_Index,
 190     HelpDemo_Help_Classes,
 191     HelpDemo_Help_Functions,
 192     HelpDemo_Help_Help,
 193     HelpDemo_Help_Search,
 194     HelpDemo_Help_ContextHelp,
 195     HelpDemo_Help_DialogContextHelp,
 196
 197     HelpDemo_Html_Help_Index,
 198     HelpDemo_Html_Help_Classes,
 199     HelpDemo_Html_Help_Functions,
 200     HelpDemo_Html_Help_Help,
 201     HelpDemo_Html_Help_Search,
 202
 203     HelpDemo_Advanced_Html_Help_Index,
 204     HelpDemo_Advanced_Html_Help_Classes,
 205     HelpDemo_Advanced_Html_Help_Functions,
 206     HelpDemo_Advanced_Html_Help_Help,
 207     HelpDemo_Advanced_Html_Help_Search,
 208     HelpDemo_Advanced_Html_Help_Modal,
 209
 210     HelpDemo_MS_Html_Help_Index,
 211     HelpDemo_MS_Html_Help_Classes,
 212     HelpDemo_MS_Html_Help_Functions,
 213     HelpDemo_MS_Html_Help_Help,
 214     HelpDemo_MS_Html_Help_Search,
 215
 216     HelpDemo_Best_Help_Index,
 217     HelpDemo_Best_Help_Classes,
 218     HelpDemo_Best_Help_Functions,
 219     HelpDemo_Best_Help_Help,
 220     HelpDemo_Best_Help_Search,
 221
 222     HelpDemo_Help_KDE,
 223     HelpDemo_Help_GNOME,
 224     HelpDemo_Help_Netscape,
 225     // controls start here (the numbers are, of course, arbitrary)
 226     HelpDemo_Text = 1000
 227 };
 228
 229 // ----------------------------------------------------------------------------
 230 // event tables and other macros for wxWidgets
 231 // ----------------------------------------------------------------------------
 232
 233 // the event tables connect the wxWidgets events with the functions (event
 234 // handlers) which process them. It can be also done at run-time, but for the
 235 // simple menu events like this the static method is much simpler.
 236 BEGIN_EVENT_TABLE(MyFrame, wxFrame)
 237     EVT_MENU(HelpDemo_Quit,  MyFrame::OnQuit)
 238     EVT_MENU(HelpDemo_Help_Index, MyFrame::OnHelp)
 239     EVT_MENU(HelpDemo_Help_Classes, MyFrame::OnHelp)
 240     EVT_MENU(HelpDemo_Help_Functions, MyFrame::OnHelp)
 241     EVT_MENU(HelpDemo_Help_Help, MyFrame::OnHelp)
 242     EVT_MENU(HelpDemo_Help_Search, MyFrame::OnHelp)
 243     EVT_MENU(HelpDemo_Help_ContextHelp, MyFrame::OnShowContextHelp)
 244     EVT_MENU(HelpDemo_Help_DialogContextHelp, MyFrame::OnShowDialogContextHelp)
 245
 246     EVT_MENU(HelpDemo_Advanced_Html_Help_Index, MyFrame::OnAdvancedHtmlHelp)
 247     EVT_MENU(HelpDemo_Advanced_Html_Help_Classes, MyFrame::OnAdvancedHtmlHelp)
 248     EVT_MENU(HelpDemo_Advanced_Html_Help_Functions, MyFrame::OnAdvancedHtmlHelp)
 249     EVT_MENU(HelpDemo_Advanced_Html_Help_Help, MyFrame::OnAdvancedHtmlHelp)
 250     EVT_MENU(HelpDemo_Advanced_Html_Help_Search, MyFrame::OnAdvancedHtmlHelp)
 251 #if USE_HTML_HELP
 252     EVT_MENU(HelpDemo_Advanced_Html_Help_Modal, MyFrame::OnModalHtmlHelp)
 253 #endif
 254
 255 #if wxUSE_MS_HTML_HELP && !defined(__WXUNIVERSAL__)
 256     EVT_MENU(HelpDemo_MS_Html_Help_Index, MyFrame::OnMSHtmlHelp)
 257     EVT_MENU(HelpDemo_MS_Html_Help_Classes, MyFrame::OnMSHtmlHelp)
 258     EVT_MENU(HelpDemo_MS_Html_Help_Functions, MyFrame::OnMSHtmlHelp)
 259     EVT_MENU(HelpDemo_MS_Html_Help_Help, MyFrame::OnMSHtmlHelp)
 260     EVT_MENU(HelpDemo_MS_Html_Help_Search, MyFrame::OnMSHtmlHelp)
 261 #endif
 262
 263 #if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP && !defined(__WXUNIVERSAL__)
 264     EVT_MENU(HelpDemo_Best_Help_Index, MyFrame::OnBestHelp)
 265 #endif
 266
 267     EVT_MENU(HelpDemo_Help_KDE, MyFrame::OnHelp)
 268     EVT_MENU(HelpDemo_Help_GNOME, MyFrame::OnHelp)
 269     EVT_MENU(HelpDemo_Help_Netscape, MyFrame::OnHelp)
 270 END_EVENT_TABLE()
 271
 272 // Create a new application object: this macro will allow wxWidgets to create
 273 // the application object during program execution (it's better than using a
 274 // static object for many reasons) and also declares the accessor function
 275 // wxGetApp() which will return the reference of the right type (i.e. MyApp and
 276 // not wxApp)
 277 IMPLEMENT_APP(MyApp)
 278
 279 // ============================================================================
 280 // implementation
 281 // ============================================================================
 282
 283 // ----------------------------------------------------------------------------
 284 // the application class
 285 // ----------------------------------------------------------------------------
 286
 287 // `Main program' equivalent: the program execution "starts" here
 288 bool MyApp::OnInit()
 289 {
 290     if ( !wxApp::OnInit() )
 291         return false;
 292
 293     // Create a simple help provider to make SetHelpText() do something.
 294     // Note that this must be set before any SetHelpText() calls are made.
 295 #if USE_SIMPLE_HELP_PROVIDER
 296     wxSimpleHelpProvider* provider = new wxSimpleHelpProvider;
 297 #else
 298     wxHelpControllerHelpProvider* provider = new wxHelpControllerHelpProvider;
 299 #endif
 300     wxHelpProvider::Set(provider);
 301
 302 #if USE_HTML_HELP
 303     #if wxUSE_GIF
 304         // Required for images in the online documentation
 305         wxImage::AddHandler(new wxGIFHandler);
 306     #endif // wxUSE_GIF
 307
 308     // Required for advanced HTML help
 309     #if wxUSE_STREAMS && wxUSE_ZIPSTREAM && wxUSE_ZLIB
 310         wxFileSystem::AddHandler(new wxZipFSHandler);
 311     #endif
 312 #endif // wxUSE_HTML
 313
 314     // Create the main application window
 315     MyFrame *frame = new MyFrame(wxT("HelpDemo wxWidgets App"),
 316                                  wxPoint(50, 50), wxSize(450, 340));
 317
 318 #if !USE_SIMPLE_HELP_PROVIDER
 319 #if wxUSE_MS_HTML_HELP && !defined(__WXUNIVERSAL__)
 320     provider->SetHelpController(& frame->GetMSHtmlHelpController());
 321 #else
 322     provider->SetHelpController(& frame->GetHelpController());
 323 #endif
 324 #endif // !USE_SIMPLE_HELP_PROVIDER
 325
 326     frame->Show(true);
 327     SetTopWindow(frame);
 328
 329     // initialise the help system: this means that we'll use doc.hlp file under
 330     // Windows and that the HTML docs are in the subdirectory doc for platforms
 331     // using HTML help
 332     if ( !frame->GetHelpController().Initialize(wxT("doc")) )
 333     {
 334         wxLogError(wxT("Cannot initialize the help system, aborting."));
 335
 336         return false;
 337     }
 338
 339 #if wxUSE_MS_HTML_HELP && !defined(__WXUNIVERSAL__)
 340     if( !frame->GetMSHtmlHelpController().Initialize(wxT("doc")) )
 341     {
 342         wxLogError(wxT("Cannot initialize the MS HTML Help system."));
 343     }
 344 #endif
 345
 346 #if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP && !defined(__WXUNIVERSAL__)
 347     // you need to call Initialize in order to use wxBestHelpController
 348     if( !frame->GetBestHelpController().Initialize(wxT("doc")) )
 349     {
 350         wxLogError(wxT("Cannot initialize the best help system, aborting."));
 351     }
 352 #endif
 353
 354 #if USE_HTML_HELP
 355     // initialise the advanced HTML help system: this means that the HTML docs are in .htb
 356     // (zipped) form
 357     if ( !frame->GetAdvancedHtmlHelpController().Initialize(wxT("doc")) )
 358     {
 359         wxLogError(wxT("Cannot initialize the advanced HTML help system, aborting."));
 360
 361         return false;
 362     }
 363 #endif
 364
 365 #if 0
 366     // defined(__WXMSW__) && wxUSE_MS_HTML_HELP
 367     wxString path(wxGetCwd());
 368     if ( !frame->GetMSHtmlHelpController().Initialize(path + wxT("\\doc.chm")) )
 369     {
 370         wxLogError("Cannot initialize the MS HTML help system, aborting.");
 371
 372         return false;
 373     }
 374 #endif
 375
 376     return true;
 377 }
 378
 379 int MyApp::OnExit()
 380 {
 381     // clean up
 382     delete wxHelpProvider::Set(NULL);
 383
 384     return 0;
 385 }
 386
 387 // ----------------------------------------------------------------------------
 388 // main frame
 389 // ----------------------------------------------------------------------------
 390
 391 // frame constructor
 392 MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size)
 393        : wxFrame((wxFrame *)NULL, 300, title, pos, size)
 394 #if USE_HTML_HELP
 395     , m_embeddedHtmlHelp(wxHF_EMBEDDED|wxHF_DEFAULT_STYLE)
 396 #endif
 397 {
 398     // set the frame icon
 399     SetIcon(wxICON(mondrian));
 400
 401     // create a menu bar
 402     wxMenu *menuFile = new wxMenu;
 403
 404     menuFile->Append(HelpDemo_Help_Index, wxT("&Help Index..."));
 405     menuFile->Append(HelpDemo_Help_Classes, wxT("&Help on Classes..."));
 406     menuFile->Append(HelpDemo_Help_Functions, wxT("&Help on Functions..."));
 407     menuFile->Append(HelpDemo_Help_ContextHelp, wxT("&Context Help..."));
 408     menuFile->Append(HelpDemo_Help_DialogContextHelp, wxT("&Dialog Context Help...\tCtrl-H"));
 409     menuFile->Append(HelpDemo_Help_Help, wxT("&About Help Demo..."));
 410     menuFile->Append(HelpDemo_Help_Search, wxT("&Search help..."));
 411 #if USE_HTML_HELP
 412     menuFile->AppendSeparator();
 413     menuFile->Append(HelpDemo_Advanced_Html_Help_Index, wxT("Advanced HTML &Help Index..."));
 414     menuFile->Append(HelpDemo_Advanced_Html_Help_Classes, wxT("Advanced HTML &Help on Classes..."));
 415     menuFile->Append(HelpDemo_Advanced_Html_Help_Functions, wxT("Advanced HTML &Help on Functions..."));
 416     menuFile->Append(HelpDemo_Advanced_Html_Help_Help, wxT("Advanced HTML &About Help Demo..."));
 417     menuFile->Append(HelpDemo_Advanced_Html_Help_Search, wxT("Advanced HTML &Search help..."));
 418     menuFile->Append(HelpDemo_Advanced_Html_Help_Modal, wxT("Advanced HTML Help &Modal Dialog..."));
 419 #endif
 420
 421 #if wxUSE_MS_HTML_HELP && !defined(__WXUNIVERSAL__)
 422     menuFile->AppendSeparator();
 423     menuFile->Append(HelpDemo_MS_Html_Help_Index, wxT("MS HTML &Help Index..."));
 424     menuFile->Append(HelpDemo_MS_Html_Help_Classes, wxT("MS HTML &Help on Classes..."));
 425     menuFile->Append(HelpDemo_MS_Html_Help_Functions, wxT("MS HTML &Help on Functions..."));
 426     menuFile->Append(HelpDemo_MS_Html_Help_Help, wxT("MS HTML &About Help Demo..."));
 427     menuFile->Append(HelpDemo_MS_Html_Help_Search, wxT("MS HTML &Search help..."));
 428 #endif
 429
 430 #if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP && !defined(__WXUNIVERSAL__)
 431     menuFile->AppendSeparator();
 432     menuFile->Append(HelpDemo_Best_Help_Index, wxT("Best &Help Index..."));
 433 #endif
 434
 435 #ifndef __WXMSW__
 436 #if !wxUSE_HTML
 437     menuFile->AppendSeparator();
 438     menuFile->Append(HelpDemo_Help_KDE, wxT("Use &KDE"));
 439     menuFile->Append(HelpDemo_Help_GNOME, wxT("Use &GNOME"));
 440     menuFile->Append(HelpDemo_Help_Netscape, wxT("Use &Netscape"));
 441 #endif
 442 #endif
 443     menuFile->AppendSeparator();
 444     menuFile->Append(HelpDemo_Quit, wxT("E&xit"));
 445
 446     // now append the freshly created menu to the menu bar...
 447     wxMenuBar *menuBar = new wxMenuBar;
 448     menuBar->Append(menuFile, wxT("&File"));
 449
 450     // ... and attach this menu bar to the frame
 451     SetMenuBar(menuBar);
 452
 453 #if wxUSE_STATUSBAR
 454     // create a status bar just for fun (by default with 1 pane only)
 455     CreateStatusBar();
 456     SetStatusText(wxT("Welcome to wxWidgets!"));
 457 #endif // wxUSE_STATUSBAR
 458
 459 #if USE_HTML_HELP
 460     // Create embedded HTML Help window
 461     m_embeddedHelpWindow = new wxHtmlHelpWindow;
 462     // m_embeddedHtmlHelp.UseConfig(config, rootPath); // Can set your own config object here
 463     m_embeddedHtmlHelp.SetHelpWindow(m_embeddedHelpWindow);
 464
 465     m_embeddedHelpWindow->Create(this,
 466         wxID_ANY, wxDefaultPosition, GetClientSize(), wxTAB_TRAVERSAL|wxNO_BORDER, wxHF_DEFAULT_STYLE);
 467
 468     m_embeddedHtmlHelp.AddBook(wxFileName(wxT("doc.zip")));
 469     m_embeddedHtmlHelp.Display(wxT("Introduction"));
 470 #else
 471     // now create some controls
 472
 473     // a panel first - if there were several controls, it would allow us to
 474     // navigate between them from the keyboard
 475     wxPanel *panel = new wxPanel(this, 301, wxPoint(0, 0), wxSize(400, 200));
 476     panel->SetHelpText(_("This panel just holds a static text control."));
 477     //panel->SetHelpText(wxContextId(300));
 478
 479     // and a static control whose parent is the panel
 480     wxStaticText* staticText = new wxStaticText(panel, 302, wxT("Hello, world!"), wxPoint(10, 10));
 481     staticText->SetHelpText(_("This static text control isn't doing a lot right now."));
 482 #endif
 483 }
 484
 485
 486 // event handlers
 487
 488 void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event))
 489 {
 490     // true is to force the frame to close
 491     Close(true);
 492 }
 493
 494 void MyFrame::OnHelp(wxCommandEvent& event)
 495 {
 496     ShowHelp(event.GetId(), m_help);
 497 }
 498
 499 void MyFrame::OnShowContextHelp(wxCommandEvent& WXUNUSED(event))
 500 {
 501     // This starts context help mode, then the user
 502     // clicks on a window to send a help message
 503     wxContextHelp contextHelp(this);
 504 }
 505
 506 void MyFrame::OnShowDialogContextHelp(wxCommandEvent& WXUNUSED(event))
 507 {
 508     MyModalDialog dialog(this);
 509     dialog.ShowModal();
 510 }
 511
 512 void MyFrame::OnAdvancedHtmlHelp(wxCommandEvent& event)
 513 {
 514 #if USE_HTML_HELP
 515     ShowHelp(event.GetId(), m_advancedHtmlHelp);
 516 #endif
 517 }
 518
 519 #if wxUSE_MS_HTML_HELP && !defined(__WXUNIVERSAL__)
 520 void MyFrame::OnMSHtmlHelp(wxCommandEvent& event)
 521 {
 522     ShowHelp(event.GetId(), m_msHtmlHelp);
 523 }
 524 #endif
 525
 526 #if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP && !defined(__WXUNIVERSAL__)
 527 void MyFrame::OnBestHelp(wxCommandEvent& event)
 528 {
 529     ShowHelp(event.GetId(), m_bestHelp);
 530 }
 531 #endif
 532
 533 #if USE_HTML_HELP
 534 void MyFrame::OnModalHtmlHelp(wxCommandEvent& WXUNUSED(event))
 535 {
 536     wxHtmlModalHelp modalHelp(this, wxT("doc.zip"), wxT("Introduction"));
 537 }
 538 #endif
 539
 540 /*
 541  Notes: ShowHelp uses section ids for displaying particular topics,
 542  but you might want to use a unique keyword to display a topic, instead.
 543
 544  Section ids are specified as follows for the different formats.
 545
 546  WinHelp
 547
 548    The [MAP] section specifies the topic to integer id mapping, e.g.
 549
 550    [MAP]
 551    #define intro       100
 552    #define functions   1
 553    #define classes     2
 554    #define about       3
 555
 556    The identifier name corresponds to the label used for that topic.
 557    You could also put these in a .h file and #include it in both the MAP
 558    section and your C++ source.
 559
 560    Note that Tex2RTF doesn't currently generate the MAP section automatically.
 561
 562  MS HTML Help
 563
 564    The [MAP] section specifies the HTML filename root to integer id mapping, e.g.
 565
 566    [MAP]
 567    #define doc1       100
 568    #define doc3       1
 569    #define doc2       2
 570    #define doc4       3
 571
 572    The identifier name corresponds to the HTML filename used for that topic.
 573    You could also put these in a .h file and #include it in both the MAP
 574    section and your C++ source.
 575
 576    Note that Tex2RTF doesn't currently generate the MAP section automatically.
 577
 578  Simple wxHTML Help and External HTML Help
 579
 580    A wxhelp.map file is used, for example:
 581
 582    0 wx.htm             ; wxWidgets: Help index; additional keywords like overview
 583    1 wx204.htm          ; wxWidgets Function Reference
 584    2 wx34.htm           ; wxWidgets Class Reference
 585
 586    Note that Tex2RTF doesn't currently generate the MAP section automatically.
 587
 588  Advanced HTML Help
 589
 590    An extension to the .hhc file format is used, specifying a new parameter
 591    with name="ID":
 592
 593    <OBJECT type="text/sitemap">
 594    <param name="Local" value="doc2.htm#classes">
 595    <param name="Name" value="Classes">
 596    <param name="ID" value=2>
 597    </OBJECT>
 598
 599    Again, this is not generated automatically by Tex2RTF, though it could
 600    be added quite easily.
 601
 602    Unfortunately adding the ID parameters appears to interfere with MS HTML Help,
 603    so you should not try to compile a .chm file from a .hhc file with
 604    this extension, or the contents will be messed up.
 605  */
 606
 607 void MyFrame::ShowHelp(int commandId, wxHelpControllerBase& helpController)
 608 {
 609    switch(commandId)
 610    {
 611        case HelpDemo_Help_Classes:
 612        case HelpDemo_Html_Help_Classes:
 613        case HelpDemo_Advanced_Html_Help_Classes:
 614        case HelpDemo_MS_Html_Help_Classes:
 615        case HelpDemo_Best_Help_Classes:
 616           helpController.DisplaySection(2);
 617           //helpController.DisplaySection("Classes"); // An alternative form for most controllers
 618           break;
 619
 620        case HelpDemo_Help_Functions:
 621        case HelpDemo_Html_Help_Functions:
 622        case HelpDemo_Advanced_Html_Help_Functions:
 623        case HelpDemo_MS_Html_Help_Functions:
 624           helpController.DisplaySection(1);
 625           //helpController.DisplaySection("Functions"); // An alternative form for most controllers
 626           break;
 627
 628        case HelpDemo_Help_Help:
 629        case HelpDemo_Html_Help_Help:
 630        case HelpDemo_Advanced_Html_Help_Help:
 631        case HelpDemo_MS_Html_Help_Help:
 632        case HelpDemo_Best_Help_Help:
 633           helpController.DisplaySection(3);
 634           //helpController.DisplaySection("About"); // An alternative form for most controllers
 635           break;
 636
 637        case HelpDemo_Help_Search:
 638        case HelpDemo_Html_Help_Search:
 639        case HelpDemo_Advanced_Html_Help_Search:
 640        case HelpDemo_MS_Html_Help_Search:
 641        case HelpDemo_Best_Help_Search:
 642        {
 643           wxString key = wxGetTextFromUser(wxT("Search for?"),
 644                                            wxT("Search help for keyword"),
 645                                            wxEmptyString,
 646                                            this);
 647           if(! key.IsEmpty())
 648              helpController.KeywordSearch(key);
 649        }
 650        break;
 651
 652        case HelpDemo_Help_Index:
 653        case HelpDemo_Html_Help_Index:
 654        case HelpDemo_Advanced_Html_Help_Index:
 655        case HelpDemo_MS_Html_Help_Index:
 656        case HelpDemo_Best_Help_Index:
 657           helpController.DisplayContents();
 658           break;
 659
 660        // These three calls are only used by wxExtHelpController
 661
 662        case HelpDemo_Help_KDE:
 663           helpController.SetViewer(wxT("kdehelp"));
 664           break;
 665        case HelpDemo_Help_GNOME:
 666           helpController.SetViewer(wxT("gnome-help-browser"));
 667           break;
 668        case HelpDemo_Help_Netscape:
 669           helpController.SetViewer(wxT("netscape"), wxHELP_NETSCAPE);
 670           break;
 671    }
 672 }
 673
 674 // ----------------------------------------------------------------------------
 675 // MyModalDialog
 676 // Demonstrates context-sensitive help
 677 // ----------------------------------------------------------------------------
 678
 679 BEGIN_EVENT_TABLE(MyModalDialog, wxDialog)
 680 END_EVENT_TABLE()
 681
 682 MyModalDialog::MyModalDialog(wxWindow *parent)
 683              : wxDialog(parent, wxID_ANY, wxString(wxT("Modal dialog")))
 684 {
 685     // Add the context-sensitive help button on the caption for the platforms
 686     // which support it (currently MSW only)
 687     SetExtraStyle(wxDIALOG_EX_CONTEXTHELP);
 688
 689
 690     wxBoxSizer *sizerTop = new wxBoxSizer(wxVERTICAL);
 691     wxBoxSizer *sizerRow = new wxBoxSizer(wxHORIZONTAL);
 692
 693     wxButton* btnOK = new wxButton(this, wxID_OK, wxT("&OK"));
 694     btnOK->SetHelpText(_("The OK button confirms the dialog choices."));
 695
 696     wxButton* btnCancel = new wxButton(this, wxID_CANCEL, wxT("&Cancel"));
 697     btnCancel->SetHelpText(_("The Cancel button cancels the dialog."));
 698
 699     sizerRow->Add(btnOK, 0, wxALIGN_CENTER | wxALL, 5);
 700     sizerRow->Add(btnCancel, 0, wxALIGN_CENTER | wxALL, 5);
 701
 702     // Add explicit context-sensitive help button for non-MSW
 703 #ifndef __WXMSW__
 704     sizerRow->Add(new wxContextHelpButton(this), 0, wxALIGN_CENTER | wxALL, 5);
 705 #endif
 706
 707     wxTextCtrl *text = new wxTextCtrl(this, wxID_ANY, wxT("A demo text control"),
 708                                       wxDefaultPosition, wxSize(300, 100),
 709                                       wxTE_MULTILINE);
 710     text->SetHelpText(_("Type text here if you have got nothing more interesting to do"));
 711     sizerTop->Add(text, 0, wxEXPAND|wxALIGN_CENTER_VERTICAL|wxALL, 5 );
 712     sizerTop->Add(sizerRow, 0, wxALIGN_RIGHT|wxALIGN_CENTER_VERTICAL|wxALL, 5 );
 713
 714     SetSizerAndFit(sizerTop);
 715
 716     btnOK->SetFocus();
 717     btnOK->SetDefault();
 718 }
 719