more type-safety

[wxWidgets.git] / samples / help / demo.cpp

diff --git a/samples/help/demo.cpp b/samples/help/demo.cpp
index f7118b22d2f8f41d9c43b0d91df4ae54a2996fb4..df29ed2e264fcd8db0c4b86062ce3f2209e55d53 100644 (file)
--- a/samples/help/demo.cpp
+++ b/samples/help/demo.cpp
@@ -1,12 +1,12 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        minimal.cpp
-// Purpose:     Minimal wxWindows sample
-// Author:      Julian Smart
+// Name:        demo.cpp
+// Purpose:     wxHelpController demo
+// Author:      Karsten Ballueder

 // Modified by:
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     04/01/98
 // RCS-ID:      $Id$

-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:     wxWindows license
+// Copyright:   (c) Karsten Ballueder, Julian Smart
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 /////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================


@@ -16,32 +16,34 @@
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------

-#ifdef __GNUG__
-    #pragma implementation "minimal.cpp"
-    #pragma interface "minimal.cpp"
-#endif

 
 // For compilers that support precompilation, includes "wx/wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
 
 // 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
 #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
 
 #endif
 

-#include   "wx/helpbase.h"
-#include   "wx/help.h"
+// define this to 1 to use HTML help even under Windows (by default, Windows
+// version will HLP-based help)
+//#define USE_HTML_HELP 1
+#if USE_HTML_HELP
+#   include "wx/helpbase.h"
+#else
+#   include "wx/help.h"
+#endif

 
 // ----------------------------------------------------------------------------
 // ressources
 // ----------------------------------------------------------------------------
 // the application icon
 
 // ----------------------------------------------------------------------------
 // ressources
 // ----------------------------------------------------------------------------
 // the application icon

-#ifdef __WXGTK__
+#if defined(__WXGTK__) || defined(__WXMOTIF__)

     #include "mondrian.xpm"
 #endif
 
     #include "mondrian.xpm"
 #endif
 


@@ -74,7 +76,8 @@ public:
     void OnHelp(wxCommandEvent& event);
 
 private:
     void OnHelp(wxCommandEvent& event);
 
 private:

-   wxHelpController  help;
+   wxHelpController m_help;
+

     // any class wishing to process wxWindows events must use this macro
    DECLARE_EVENT_TABLE()
 };
     // any class wishing to process wxWindows events must use this macro
    DECLARE_EVENT_TABLE()
 };


@@ -87,17 +90,17 @@ private:
 enum
 {
     // menu items
 enum
 {
     // menu items

-    Minimal_Quit = 1,
-    Minimal_Help_Index,
-    Minimal_Help_Classes,
-    Minimal_Help_Functions,
-    Minimal_Help_Help,
-    Minimal_Help_KDE,
-    Minimal_Help_GNOME,
-    Minimal_Help_Netscape,
-    Minimal_Help_Search,
+    HelpDemo_Quit = 1,
+    HelpDemo_Help_Index,
+    HelpDemo_Help_Classes,
+    HelpDemo_Help_Functions,
+    HelpDemo_Help_Help,
+    HelpDemo_Help_KDE,
+    HelpDemo_Help_GNOME,
+    HelpDemo_Help_Netscape,
+    HelpDemo_Help_Search,

     // controls start here (the numbers are, of course, arbitrary)
     // controls start here (the numbers are, of course, arbitrary)

-    Minimal_Text = 1000,
+    HelpDemo_Text = 1000,

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -108,15 +111,15 @@ enum
 // 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)
 // 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(Minimal_Quit,  MyFrame::OnQuit)
-    EVT_MENU(Minimal_Help_Index, MyFrame::OnHelp)
-    EVT_MENU(Minimal_Help_Classes, MyFrame::OnHelp)
-    EVT_MENU(Minimal_Help_Functions, MyFrame::OnHelp)
-    EVT_MENU(Minimal_Help_Help, MyFrame::OnHelp)
-    EVT_MENU(Minimal_Help_KDE, MyFrame::OnHelp)
-    EVT_MENU(Minimal_Help_GNOME, MyFrame::OnHelp)
-    EVT_MENU(Minimal_Help_Netscape, MyFrame::OnHelp)
-    EVT_MENU(Minimal_Help_Search, MyFrame::OnHelp)
+    EVT_MENU(HelpDemo_Quit,  MyFrame::OnQuit)
+    EVT_MENU(HelpDemo_Help_Index, MyFrame::OnHelp)
+    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_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
 END_EVENT_TABLE()
 
 // Create a new application object: this macro will allow wxWindows to create


@@ -138,11 +141,9 @@ IMPLEMENT_APP(MyApp)
 bool MyApp::OnInit()
 {
     // Create the main application window
 bool MyApp::OnInit()
 {
     // Create the main application window

-    MyFrame *frame = new MyFrame("Minimal wxWindows App",
+    MyFrame *frame = new MyFrame("HelpDemo wxWindows App",

                                  wxPoint(50, 50), wxSize(450, 340));
 
                                  wxPoint(50, 50), wxSize(450, 340));
 

-    // Show it and tell the application that it's our main window
-    // @@@ what does it do exactly, in fact? is it necessary here?

     frame->Show(TRUE);
     SetTopWindow(frame);
 
     frame->Show(TRUE);
     SetTopWindow(frame);
 


@@ -166,21 +167,22 @@ MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size)
     // create a menu bar
     wxMenu *menuFile = new wxMenu;
 
     // create a menu bar
     wxMenu *menuFile = new wxMenu;
 

-    menuFile->Append(Minimal_Help_Index, "&Help Index...");
-    menuFile->Append(Minimal_Help_Classes, "&Help on Classes...");
-    menuFile->Append(Minimal_Help_Functions, "&Help on Functions...");
-    menuFile->Append(Minimal_Help_Help, "&About wxExtHelpController...");
+    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_Help, "&About Help Demo...");

     menuFile->AppendSeparator();
     menuFile->AppendSeparator();

-    menuFile->Append(Minimal_Help_Search, "&Search help...");
-    if(help.IsKindOf(CLASSINFO(wxExtHelpController)))
-       {
-          menuFile->AppendSeparator();
-          menuFile->Append(Minimal_Help_KDE, "Use &KDE");
-          menuFile->Append(Minimal_Help_GNOME, "Use &GNOME");
-          menuFile->Append(Minimal_Help_Netscape, "Use &Netscape");
-       }
+    menuFile->Append(HelpDemo_Help_Search, "&Search help...");
+#ifndef __WXMSW__
+#ifndef 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->AppendSeparator();

-    menuFile->Append(Minimal_Quit, "E&xit");
+    menuFile->Append(HelpDemo_Quit, "E&xit");

 
     // now append the freshly created menu to the menu bar...
     wxMenuBar *menuBar = new wxMenuBar;
 
     // now append the freshly created menu to the menu bar...
     wxMenuBar *menuBar = new wxMenuBar;


@@ -202,9 +204,10 @@ MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size)
     // and a static control whose parent is the panel
     (void)new wxStaticText(panel, -1, "Hello, world!", wxPoint(10, 10));
 
     // 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");
-   
+    // 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
+    m_help.Initialize("doc");

 }
 
 
 }
 
 


@@ -220,40 +223,46 @@ void MyFrame::OnHelp(wxCommandEvent& event)
 {
    switch(event.GetId())
    {
 {
    switch(event.GetId())
    {

-   case Minimal_Help_Classes:
-      help.DisplaySection(1);
+
+   // Note: these DisplaySection calls use ids that are specific to wxExtHelpController
+   // (on Unix). For WinHelp, we'd need to use different context ids.
+
+   case HelpDemo_Help_Classes:
+      m_help.DisplaySection(1);

       break;
       break;

-   case Minimal_Help_Functions:
-      help.DisplaySection(2);
+   case HelpDemo_Help_Functions:
+      m_help.DisplaySection(4);

       break;
       break;

-   case Minimal_Help_Help:
-      help.DisplaySection(5);
+   case HelpDemo_Help_Help:
+      m_help.DisplaySection(5);

       break;
       break;

-   case Minimal_Help_KDE:
-      if(help.IsKindOf(CLASSINFO(wxExtHelpController)))
-         ((wxExtHelpController *)&help)->SetBrowser("kdehelp");
+
+   // These three calls are only used by wxExtHelpController
+
+   case HelpDemo_Help_KDE:
+      m_help.SetViewer("kdehelp");

       break;
       break;

-   case Minimal_Help_GNOME:
-      if(help.IsKindOf(CLASSINFO(wxExtHelpController)))
-         ((wxExtHelpController *)&help)->SetBrowser("gnome-help-browser");
+   case HelpDemo_Help_GNOME:
+      m_help.SetViewer("gnome-help-browser");

       break;
       break;

-   case Minimal_Help_Netscape:
-      if(help.IsKindOf(CLASSINFO(wxExtHelpController)))
-         ((wxExtHelpController *)&help)->SetBrowser("netscape",TRUE);
+   case HelpDemo_Help_Netscape:
+      m_help.SetViewer("netscape", wxHELP_NETSCAPE);

       break;
       break;

-   case Minimal_Help_Search:
+
+   case HelpDemo_Help_Search:

    {
       wxString key = wxGetTextFromUser("Search for?",
                                        "Search help for keyword",
                                        "",
                                        this);
       if(! key.IsEmpty())
    {
       wxString key = wxGetTextFromUser("Search for?",
                                        "Search help for keyword",
                                        "",
                                        this);
       if(! key.IsEmpty())

-         help.KeywordSearch(key);
+         m_help.KeywordSearch(key);

    }
    break;
    }
    break;

-   case Minimal_Help_Index:
+   case HelpDemo_Help_Index:

    default:
    default:

-      help.DisplayContents();
+      m_help.DisplayContents();

       break;
    }
 }
       break;
    }
 }

+