wxDisplay cleanup/rewrite:

[wxWidgets.git] / include / wx / msw / helpbest.h

diff --git a/include/wx/msw/helpbest.h b/include/wx/msw/helpbest.h
index cc3e41bcb03ab71b88d908b5db5b83615baca223..95b128084c3b6d22a6c75181e5649f3083e0ead0 100644 (file)
--- a/include/wx/msw/helpbest.h
+++ b/include/wx/msw/helpbest.h
@@ -1,128 +1,124 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        helpbest.h
+// Name:        wx/msw/helpbest.h
 // Purpose:     Tries to load MS HTML Help, falls back to wxHTML upon failure
 // Author:      Mattia Barbon
 // Modified by:
 // Created:     02/04/2001
 // RCS-ID:      $Id$
 // Copyright:   (c) Mattia Barbon
-// Licence:    wxWindows licence
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_HELPBEST_H_
 #define _WX_HELPBEST_H_
 
-#ifdef __GNUG__
-#pragma interface "helpbest.h"
-#endif
-
-#include "wx/wx.h"
-
-#if wxUSE_HELP && wxUSE_MS_HTML_HELP && defined(__WIN95__) && wxUSE_WXHTML_HELP
+#if wxUSE_HELP && wxUSE_MS_HTML_HELP \
+    && wxUSE_WXHTML_HELP && !defined(__WXUNIVERSAL__)
 
 #include "wx/helpbase.h"
 
-class WXDLLEXPORT wxBestHelpController: public wxHelpControllerBase
+class WXDLLIMPEXP_HTML wxBestHelpController: public wxHelpControllerBase
 {
-    DECLARE_DYNAMIC_CLASS(wxBestHelpController)
-        
 public:
-    wxBestHelpController():m_helpControllerType( wxUseNone ),
-        m_helpController( 0 ) {}
-    ~wxBestHelpController() { delete m_helpController; }
-    
+    wxBestHelpController(wxWindow* parentWindow = NULL)
+        : wxHelpControllerBase( parentWindow ), m_helpControllerType( wxUseNone ),
+          m_helpController( NULL )
+    {
+    }
+
+    virtual ~wxBestHelpController() { delete m_helpController; }
+
     // Must call this to set the filename
     virtual bool Initialize(const wxString& file);
-    
+    virtual bool Initialize(const wxString& file, int WXUNUSED(server) ) { return Initialize( file ); }
+
     // If file is "", reloads file given in Initialize
     virtual bool LoadFile(const wxString& file = wxEmptyString)
     {
-        wxASSERT( m_helpController );
         return m_helpController->LoadFile( GetValidFilename( file ) );
     }
 
     virtual bool DisplayContents()
     {
-        wxASSERT( m_helpController );
         return m_helpController->DisplayContents();
     }
 
     virtual bool DisplaySection(int sectionNo)
     {
-        wxASSERT( m_helpController );
         return m_helpController->DisplaySection( sectionNo );
     }
 
     virtual bool DisplaySection(const wxString& section)
     {
-        wxASSERT( m_helpController );
         return m_helpController->DisplaySection( section );
     }
 
     virtual bool DisplayBlock(long blockNo)
     {
-        wxASSERT( m_helpController );
         return m_helpController->DisplayBlock( blockNo );
     }
 
     virtual bool DisplayContextPopup(int contextId)
     {
-        wxASSERT( m_helpController );
         return m_helpController->DisplayContextPopup( contextId );
     }
 
     virtual bool DisplayTextPopup(const wxString& text, const wxPoint& pos)
     {
-        wxASSERT( m_helpController );
         return m_helpController->DisplayTextPopup( text, pos );
     }
 
-    virtual bool KeywordSearch(const wxString& k)
+    virtual bool KeywordSearch(const wxString& k,
+                               wxHelpSearchMode mode = wxHELP_SEARCH_ALL)
     {
-        wxASSERT( m_helpController );
-        return m_helpController->KeywordSearch( k );
+        return m_helpController->KeywordSearch( k, mode );
     }
 
     virtual bool Quit()
     {
-        wxASSERT( m_helpController );
         return m_helpController->Quit();
     }
 
-    /// Allows one to override the default settings for the help frame.
+    // Allows one to override the default settings for the help frame.
     virtual void SetFrameParameters(const wxString& title,
-        const wxSize& size,
-        const wxPoint& pos = wxDefaultPosition,
-        bool newFrameEachTime = FALSE)
+                                    const wxSize& size,
+                                    const wxPoint& pos = wxDefaultPosition,
+                                    bool newFrameEachTime = false)
     {
-        wxASSERT( m_helpController );
         m_helpController->SetFrameParameters( title, size, pos,
                                               newFrameEachTime );
     }
 
-    /// Obtains the latest settings used by the help frame and the help 
-    /// frame.
+    // Obtains the latest settings used by the help frame and the help frame.
     virtual wxFrame *GetFrameParameters(wxSize *size = NULL,
-        wxPoint *pos = NULL,
-        bool *newFrameEachTime = NULL)
+                                        wxPoint *pos = NULL,
+                                        bool *newFrameEachTime = NULL)
     {
-        wxASSERT( m_helpController );
         return m_helpController->GetFrameParameters( size, pos,
                                                      newFrameEachTime );
     }
 
+    /// Set the window that can optionally be used for the help window's parent.
+    virtual void SetParentWindow(wxWindow* win) { m_helpController->SetParentWindow(win); }
+
+    /// Get the window that can optionally be used for the help window's parent.
+    virtual wxWindow* GetParentWindow() const { return m_helpController->GetParentWindow(); }
+
 protected:
     // Append/change extension if necessary.
     wxString GetValidFilename(const wxString& file) const;
-    
+
 protected:
     enum HelpControllerType { wxUseNone, wxUseHtmlHelp, wxUseChmHelp };
 
     HelpControllerType m_helpControllerType;
     wxHelpControllerBase* m_helpController;
+
+    DECLARE_DYNAMIC_CLASS(wxBestHelpController)
+    DECLARE_NO_COPY_CLASS(wxBestHelpController)
 };
 
-#endif // wxUSE_HELP && wxUSE_MS_HTML_HELP && defined(__WIN95__) && wxUSE_WXHTML_HELP
+#endif // wxUSE_HELP && wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP
 
 #endif
     // _WX_HELPBEST_H_