]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/html/helpdata.h
removed wxGzipStreams (supported by wxZlibStreams now)
[wxWidgets.git] / include / wx / html / helpdata.h
index dd7135f7d204193f2ebd0691f88763a8a04baf4f..f03914cc18f9b1ca1e228d550f5306777980c540 100644 (file)
@@ -12,7 +12,7 @@
 #ifndef _WX_HELPDATA_H_
 #define _WX_HELPDATA_H_
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
 #pragma interface "helpdata.h"
 #endif
 
 #include "wx/dynarray.h"
 #include "wx/font.h"
 
-class WXDLLEXPORT wxHtmlHelpData;
+class WXDLLIMPEXP_HTML wxHtmlHelpData;
 
 //--------------------------------------------------------------------------------
 // helper classes & structs
 //--------------------------------------------------------------------------------
 
-class WXDLLEXPORT wxHtmlBookRecord : public wxObject
+class WXDLLIMPEXP_HTML wxHtmlBookRecord
 {
 public:
-    wxHtmlBookRecord(const wxString& basepath, const wxString& title,
-                     const wxString& start)
+    wxHtmlBookRecord(const wxString& bookfile, const wxString& basepath, 
+                     const wxString& title, const wxString& start)
     {
+        m_BookFile = bookfile;
         m_BasePath = basepath;
         m_Title = title;
         m_Start = start;
         // for debugging, give the contents index obvious default values
         m_ContentsStart = m_ContentsEnd = -1;
     }
+    wxString GetBookFile() const { return m_BookFile; }
     wxString GetTitle() const { return m_Title; }
     wxString GetStart() const { return m_Start; }
     wxString GetBasePath() const { return m_BasePath; }
@@ -60,7 +62,13 @@ public:
     void SetBasePath(const wxString& path) { m_BasePath = path; }
     void SetStart(const wxString& start) { m_Start = start; }
 
+    // returns full filename of page (which is part of the book), 
+    // i.e. with book's basePath prepended. If page is already absolute 
+    // path, basePath is _not_ prepended.
+    wxString GetFullPath(const wxString &page) const;
+
 protected:
+    wxString m_BookFile;
     wxString m_BasePath;
     wxString m_Title;
     wxString m_Start;
@@ -69,7 +77,8 @@ protected:
 };
 
 
-WX_DECLARE_EXPORTED_OBJARRAY(wxHtmlBookRecord, wxHtmlBookRecArray);
+WX_DECLARE_USER_EXPORTED_OBJARRAY(wxHtmlBookRecord, wxHtmlBookRecArray,
+                                  WXDLLIMPEXP_HTML);
 
 
 struct wxHtmlContentsItem
@@ -79,31 +88,36 @@ struct wxHtmlContentsItem
     wxChar* m_Name;
     wxChar* m_Page;
     wxHtmlBookRecord *m_Book;
+    
+    // returns full filename of m_Page, i.e. with book's basePath prepended
+    wxString GetFullPath() const { return m_Book->GetFullPath(m_Page); }
 };
 
 //------------------------------------------------------------------------------
-// wxSearchEngine
+// wxHtmlSearchEngine
 //                  This class takes input streams and scans them for occurence
 //                  of keyword(s)
 //------------------------------------------------------------------------------
 
-class WXDLLEXPORT wxSearchEngine : public wxObject
+class WXDLLIMPEXP_HTML wxHtmlSearchEngine : public wxObject
 {
 public:
-    wxSearchEngine() : wxObject() {m_Keyword = NULL; }
-    ~wxSearchEngine() {if (m_Keyword) delete[] m_Keyword; }
+    wxHtmlSearchEngine() : wxObject() {m_Keyword = NULL; }
+    ~wxHtmlSearchEngine() {if (m_Keyword) delete[] m_Keyword; }
 
     // Sets the keyword we will be searching for
     virtual void LookFor(const wxString& keyword, bool case_sensitive, bool whole_words_only);
 
     // Scans the stream for the keyword.
     // Returns TRUE if the stream contains keyword, fALSE otherwise
-    virtual bool Scan(wxInputStream *stream);
+    virtual bool Scan(const wxFSFile& file);
 
 private:
     wxChar *m_Keyword;
     bool m_CaseSensitive;
     bool m_WholeWords;
+
+    DECLARE_NO_COPY_CLASS(wxHtmlSearchEngine)
 };
 
 
@@ -111,7 +125,7 @@ private:
 // class inside wxHtmlHelpData, but that's against coding standards :-(
 // Never construct this class yourself, obtain a copy from
 // wxHtmlHelpData::PrepareKeywordSearch(const wxString& key)
-class WXDLLEXPORT wxHtmlSearchStatus
+class WXDLLIMPEXP_HTML wxHtmlSearchStatus
 {
 public:
     // constructor; supply wxHtmlHelpData ptr, the keyword and (optionally) the
@@ -128,7 +142,7 @@ public:
 
 private:
     wxHtmlHelpData* m_Data;
-    wxSearchEngine m_Engine;
+    wxHtmlSearchEngine m_Engine;
     wxString m_Keyword, m_Name;
     wxChar *m_LastPage;
     wxHtmlContentsItem* m_ContentsItem;
@@ -136,9 +150,11 @@ private:
     int m_CurIndex;  // where we are now
     int m_MaxIndex;  // number of files we search
     // For progress bar: 100*curindex/maxindex = % complete
+
+    DECLARE_NO_COPY_CLASS(wxHtmlSearchStatus)
 };
 
-class WXDLLEXPORT wxHtmlHelpData : public wxObject
+class WXDLLIMPEXP_HTML wxHtmlHelpData : public wxObject
 {
     DECLARE_DYNAMIC_CLASS(wxHtmlHelpData)
     friend class wxHtmlSearchStatus;
@@ -194,10 +210,9 @@ protected:
     bool LoadCachedBook(wxHtmlBookRecord *book, wxInputStream *f);
     // Writes binary book
     bool SaveCachedBook(wxHtmlBookRecord *book, wxOutputStream *f);
-};
 
-// Utility function
-wxString wxAddBasePath(const wxString& basePath, const wxString& path) ;
+    DECLARE_NO_COPY_CLASS(wxHtmlHelpData)
+};
 
 #endif