Doc tweaks

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

diff --git a/samples/html/help/help.cpp b/samples/html/help/help.cpp
index 26a13b0c0315e47a93fdac27fc128237a0fd94c8..d54817fab5345e2f90f81f11b79a1dabc90787dc 100644 (file)
--- a/samples/html/help/help.cpp
+++ b/samples/html/help/help.cpp
@@ -1,29 +1,31 @@
-

 /////////////////////////////////////////////////////////////////////////////
 // Name:        test.cpp
 // Purpose:     wxHtml testing example
 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 // Name:        test.cpp
 // Purpose:     wxHtml testing example
 /////////////////////////////////////////////////////////////////////////////
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(__APPLE__)

     #pragma implementation "help.cpp"
     #pragma interface "help.cpp"
 #endif
 
 // For compilers that support precompilation, includes "wx/wx.h".
     #pragma implementation "help.cpp"
     #pragma interface "help.cpp"
 #endif
 
 // For compilers that support precompilation, includes "wx/wx.h".

-#include <wx/wxprec.h>
+#include "wx/wxprec.h"

 
 #ifdef __BORLANDC__
     #pragma hdrstop
 #endif
 
 // for all others, include the necessary headers (this file is usually all you
 
 #ifdef __BORLANDC__
     #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
+// need because it includes almost all "standard" wxWidgets headers

 #ifndef WX_PRECOMP
 #ifndef WX_PRECOMP

-    #include <wx/wx.h>
+    #include "wx/wx.h"

 #endif
 
 #endif
 

-#include <wx/image.h>
-#include <wx/wxhtml.h>
+#include "wx/image.h"
+#include "wx/html/helpfrm.h"
+#include "wx/html/helpctrl.h"
+#include "wx/filesys.h"
+#include "wx/fs_zip.h"

 
 // ----------------------------------------------------------------------------
 // private classes
 
 // ----------------------------------------------------------------------------
 // private classes


@@ -59,7 +61,7 @@
    private:
       wxHtmlHelpController help;
    
    private:
       wxHtmlHelpController help;
    

-    // 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()
    };
 
     DECLARE_EVENT_TABLE()
    };
 


@@ -76,10 +78,10 @@
    };
 
 // ----------------------------------------------------------------------------
    };
 
 // ----------------------------------------------------------------------------

-// 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)
 // 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)


@@ -88,7 +90,7 @@
    EVT_CLOSE(MyFrame::OnClose)
    END_EVENT_TABLE()
 
    EVT_CLOSE(MyFrame::OnClose)
    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
    // 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


@@ -105,30 +107,27 @@
    // `Main program' equivalent: the program execution "starts" here
    bool MyApp::OnInit()
    {
    // `Main program' equivalent: the program execution "starts" here
    bool MyApp::OnInit()
    {

-       #if wxUSE_LIBPNG
-        wxImage::AddHandler(new wxPNGHandler);
-       #endif
-       #if wxUSE_LIBJPEG
-        wxImage::AddHandler(new wxJPEGHandler);
-       #endif
-
-      SetVendorName("wxWindows");
-      SetAppName("wxHTMLHelp"); 
+      wxInitAllImageHandlers();
+#if wxUSE_STREAMS && wxUSE_ZIPSTREAM && wxUSE_ZLIB 
+      wxFileSystem::AddHandler(new wxZipFSHandler);
+#endif
+      SetVendorName(wxT("wxWidgets"));
+      SetAppName(wxT("wxHTMLHelp")); 

 
     // Create the main application window
 
     // Create the main application window

-      MyFrame *frame = new MyFrame("HTML Help Sample",
-         wxPoint(50, 50), wxSize(150, 50));
+      MyFrame *frame = new MyFrame(_("HTML Help Sample"),
+         wxDefaultPosition, wxDefaultSize);

 
     // Show it and tell the application that it's our main window
     // @@@ what does it do exactly, in fact? is it necessary here?
 
     // 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);
+      frame->Show(true);

       SetTopWindow(frame);
 
 
     // success: wxApp::OnRun() will be called which will enter the main message
       SetTopWindow(frame);
 
 
     // success: wxApp::OnRun() will be called which will enter the main message

-    // loop and the application will run. If we returned FALSE here, the
+    // loop and the application will run. If we returned false here, the

     // application would exit immediately.
     // application would exit immediately.

-      return TRUE;
+      return true;

    }
 
 // ----------------------------------------------------------------------------
    }
 
 // ----------------------------------------------------------------------------


@@ -138,29 +137,31 @@
 
 // frame constructor
    MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size)
 
 // frame constructor
    MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size)

-   : wxFrame((wxFrame *)NULL, -1, title, pos, size), help()
+   : wxFrame((wxFrame *)NULL, wxID_ANY, title, pos, size), 
+     help(wxHF_DEFAULT_STYLE | wxHF_OPEN_FILES)

    {
     // create a menu bar
       wxMenu *menuFile = new wxMenu;
 
    {
     // create a menu bar
       wxMenu *menuFile = new wxMenu;
 

-      menuFile->Append(Minimal_Help, "&Help");
-      menuFile->Append(Minimal_Quit, "E&xit");
+      menuFile->Append(Minimal_Help, _("&Help"));
+      menuFile->Append(Minimal_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;

-      menuBar->Append(menuFile, "&File");
+      menuBar->Append(menuFile, _("&File"));

 
     // ... and attach this menu bar to the frame
       SetMenuBar(menuBar);
 
       help.UseConfig(wxConfig::Get());
       bool ret;
 
     // ... and attach this menu bar to the frame
       SetMenuBar(menuBar);
 
       help.UseConfig(wxConfig::Get());
       bool ret;

-      ret = help.AddBook("helpfiles/testing.hhp");
+      help.SetTempDir(wxT("."));
+      ret = help.AddBook(wxFileName(wxT("helpfiles/testing.hhp"), wxPATH_UNIX));

       if (! ret)
       if (! ret)

-         wxMessageBox("Failed adding book helpfiles/testing.hhp");
-      ret = help.AddBook("helpfiles/another.hhp");
+        wxMessageBox(wxT("Failed adding book helpfiles/testing.hhp"));
+      ret = help.AddBook(wxFileName(wxT("helpfiles/another.hhp"), wxPATH_UNIX));

       if (! ret)
       if (! ret)

-         wxMessageBox("Failed adding book helpfiles/another.hhp");
+        wxMessageBox(_("Failed adding book helpfiles/another.hhp"));

    }
 
 
    }
 
 


@@ -168,13 +169,13 @@
 
    void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event))
    {
 
    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& WXUNUSED(event))
    {
    }
 
    void MyFrame::OnHelp(wxCommandEvent& WXUNUSED(event))
    {

-       help.Display("Main page");
+       help.Display(wxT("Test HELPFILE"));

    }
 
    void MyFrame::OnClose(wxCloseEvent& event)
    }
 
    void MyFrame::OnClose(wxCloseEvent& event)


@@ -182,7 +183,7 @@
        // Close the help frame; this will cause the config data to
        // get written.
        if ( help.GetFrame() ) // returns NULL if no help frame active
        // Close the help frame; this will cause the config data to
        // get written.
        if ( help.GetFrame() ) // returns NULL if no help frame active

-           help.GetFrame()->Close(TRUE);
+           help.GetFrame()->Close(true);

        // now we can safely delete the config pointer
        event.Skip();   
        delete wxConfig::Set(NULL);
        // now we can safely delete the config pointer
        event.Skip();   
        delete wxConfig::Set(NULL);