Committed William Osborne's wxPalmOS port

[wxWidgets.git] / include / wx / palmos / help.h

diff --git a/include/wx/palmos/help.h b/include/wx/palmos/help.h
new file mode 100644 (file)
index 0000000..2aa2b0d
--- /dev/null
+++ b/include/wx/palmos/help.h
@@ -0,0 +1,60 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        helpwin.h
+// Purpose:     Help system: WinHelp implementation
+// Author:      William Osborne
+// Modified by:
+// Created:     10/13/04
+// RCS-ID:      $Id: 
+// Copyright:   (c) William Osborne
+// Licence:     wxWindows licence
+/////////////////////////////////////////////////////////////////////////////
+
+#ifndef _WX_HELP_H_
+#define _WX_HELP_H_
+
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+#pragma interface "help.h"
+#endif
+
+#include "wx/wx.h"
+
+#if wxUSE_HELP
+
+#include "wx/helpbase.h"
+
+class WXDLLEXPORT wxPalmHelpController: public wxHelpControllerBase
+{
+    DECLARE_CLASS(wxPalmHelpController)
+
+public:
+    wxPalmHelpController() {};
+    ~wxPalmHelpController() {};
+
+    // 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);
+    virtual bool DisplayContents();
+    virtual bool DisplaySection(int sectionNo);
+    virtual bool DisplaySection(const wxString& section) { return KeywordSearch(section); }
+    virtual bool DisplayBlock(long blockNo);
+    virtual bool DisplayContextPopup(int contextId);
+    virtual bool KeywordSearch(const wxString& k,
+                               wxHelpSearchMode mode = wxHELP_SEARCH_ALL);
+    virtual bool Quit();
+
+    inline wxString GetHelpFile() const { return m_helpFile; }
+
+protected:
+    // Append extension if necessary.
+    wxString GetValidFilename(const wxString& file) const;
+    
+private:
+    wxString m_helpFile;
+};
+
+#endif // wxUSE_HELP
+#endif
+// _WX_HELP_H_