wxID_PREFERENCES added for the preferences menu item

[wxWidgets.git] / include / wx / helpbase.h

diff --git a/include/wx/helpbase.h b/include/wx/helpbase.h
index 17443e79ac56135a40ec2ea21d6989091f018090..3d1d60965cb4652389fee602814a7b77175ac20c 100644 (file)
--- a/include/wx/helpbase.h
+++ b/include/wx/helpbase.h
@@ -5,48 +5,47 @@
 // 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) Julian Smart
+// Licence:    wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_HELPBASEH__
 #define _WX_HELPBASEH__
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_HELPBASEH__
 #define _WX_HELPBASEH__
 

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

 #pragma interface "helpbase.h"
 #endif
 
 #include "wx/defs.h"
 #pragma interface "helpbase.h"
 #endif
 
 #include "wx/defs.h"

+
+#if wxUSE_HELP
+

 #include "wx/object.h"
 #include "wx/string.h"
 #include "wx/gdicmn.h"
 #include "wx/frame.h"
 
 #include "wx/object.h"
 #include "wx/string.h"
 #include "wx/gdicmn.h"
 #include "wx/frame.h"
 

-#if wxUSE_HELP
-

 // Flags for SetViewer
 #define wxHELP_NETSCAPE     1
 
 // Defines the API for help controllers
 class WXDLLEXPORT wxHelpControllerBase: public wxObject
 {
 // Flags for SetViewer
 #define wxHELP_NETSCAPE     1
 
 // Defines the API for help controllers
 class WXDLLEXPORT wxHelpControllerBase: public wxObject
 {

-    DECLARE_CLASS(wxHelpControllerBase)
-        

 public:
     inline wxHelpControllerBase() {}
 public:
     inline wxHelpControllerBase() {}

-    inline ~wxHelpControllerBase() {};
-    
+    inline ~wxHelpControllerBase() {}
+

     // Must call this to set the filename and server name.
     // server is only required when implementing TCP/IP-based
     // help controllers.
     virtual bool Initialize(const wxString& WXUNUSED(file), int WXUNUSED(server) ) { return FALSE; }
     virtual bool Initialize(const wxString& WXUNUSED(file)) { return FALSE; }
     // Must call this to set the filename and server name.
     // server is only required when implementing TCP/IP-based
     // help controllers.
     virtual bool Initialize(const wxString& WXUNUSED(file), int WXUNUSED(server) ) { return FALSE; }
     virtual bool Initialize(const wxString& WXUNUSED(file)) { return FALSE; }

-    
+

     // Set viewer: only relevant to some kinds of controller
     virtual void SetViewer(const wxString& WXUNUSED(viewer), long WXUNUSED(flags) = 0) {}
     // Set viewer: only relevant to some kinds of controller
     virtual void SetViewer(const wxString& WXUNUSED(viewer), long WXUNUSED(flags) = 0) {}

-    
+

     // If file is "", reloads file given  in Initialize
     // If file is "", reloads file given  in Initialize

-    virtual bool LoadFile(const wxString& file = "") = 0;
+    virtual bool LoadFile(const wxString& file = wxEmptyString) = 0;

 
     // Displays the contents
     virtual bool DisplayContents(void) = 0;
 
     // Displays the contents
     virtual bool DisplayContents(void) = 0;


@@ -58,11 +57,11 @@ public:
     virtual bool DisplayContextPopup(int WXUNUSED(contextId)) { return FALSE; };
 
     // Display the text in a popup, if possible
     virtual bool DisplayContextPopup(int WXUNUSED(contextId)) { return FALSE; };
 
     // Display the text in a popup, if possible

-    virtual bool DisplayTextPopup(const wxString& WXUNUSED(text), const wxPoint& WXUNUSED(pos)) { return FALSE; };
+    virtual bool DisplayTextPopup(const wxString& WXUNUSED(text), const wxPoint& WXUNUSED(pos)) { return FALSE; }

 
     // By default, uses KeywordSection to display a topic. Implementations
     // may override this for more specific behaviour.
 
     // By default, uses KeywordSection to display a topic. Implementations
     // may override this for more specific behaviour.

-    virtual bool DisplaySection(const wxString& section) { return KeywordSearch(section); };
+    virtual bool DisplaySection(const wxString& section) { return KeywordSearch(section); }

     virtual bool DisplayBlock(long blockNo) = 0;
     virtual bool KeywordSearch(const wxString& k) = 0;
     /// Allows one to override the default settings for the help frame.
     virtual bool DisplayBlock(long blockNo) = 0;
     virtual bool KeywordSearch(const wxString& k) = 0;
     /// Allows one to override the default settings for the help frame.


@@ -73,19 +72,23 @@ public:
     {
         // does nothing by default
     }
     {
         // does nothing by default
     }

-    /// Obtains the latest settings used by the help frame and the help 
+    /// Obtains the latest settings used by the help frame and the help

     /// frame.
     virtual wxFrame *GetFrameParameters(wxSize *WXUNUSED(size) = NULL,
         wxPoint *WXUNUSED(pos) = NULL,
         bool *WXUNUSED(newFrameEachTime) = NULL)
     {
     /// frame.
     virtual wxFrame *GetFrameParameters(wxSize *WXUNUSED(size) = NULL,
         wxPoint *WXUNUSED(pos) = NULL,
         bool *WXUNUSED(newFrameEachTime) = NULL)
     {

-        return (wxFrame*) NULL;// does nothing by default
+        return (wxFrame*) NULL; // does nothing by default

     }
     }

+
+    virtual bool Quit() = 0;
+    virtual void OnQuit() {}

     
     

-    virtual bool Quit(void) = 0;
-    virtual void OnQuit(void) {};
+private:
+    DECLARE_CLASS(wxHelpControllerBase)

 };
 
 #endif // wxUSE_HELP
 };
 
 #endif // wxUSE_HELP

+

 #endif
 // _WX_HELPBASEH__
 #endif
 // _WX_HELPBASEH__