typo fixes

[wxWidgets.git] / include / wx / html / helpdata.h

diff --git a/include/wx/html/helpdata.h b/include/wx/html/helpdata.h
index be84c07264c54f422ae6c48143ae0e4e9360d422..b58ff120224926b62754459bfae32aa2550cfc9a 100644 (file)
--- a/include/wx/html/helpdata.h
+++ b/include/wx/html/helpdata.h
@@ -13,7 +13,7 @@
 #define _WX_HELPDATA_H_
 
 #ifdef __GNUG__
 #define _WX_HELPDATA_H_
 
 #ifdef __GNUG__

-#pragma interface
+#pragma interface "helpdata.h"

 #endif
 
 #include "wx/defs.h"
 #endif
 
 #include "wx/defs.h"


@@ -26,85 +26,97 @@
 #include "wx/dynarray.h"
 #include "wx/font.h"
 
 #include "wx/dynarray.h"
 #include "wx/font.h"
 

+class WXDLLEXPORT wxHtmlHelpData;
+

 //--------------------------------------------------------------------------------
 // helper classes & structs
 //--------------------------------------------------------------------------------
 
 class WXDLLEXPORT wxHtmlBookRecord : public wxObject
 {
 //--------------------------------------------------------------------------------
 // helper classes & structs
 //--------------------------------------------------------------------------------
 
 class WXDLLEXPORT wxHtmlBookRecord : public wxObject
 {

-    public:
-        wxHtmlBookRecord(const wxString& basepath, const wxString& title,
-                         const wxString& start)
-        {
-            m_BasePath = basepath;
-            m_Title = title;
-            m_Start = start;
-            // for debugging, give the contents index obvious default values
-            m_ContentsStart = m_ContentsEnd = -1;
-        }
-        wxString GetTitle() const { return m_Title; }
-        wxString GetStart() const { return m_Start; }
-        wxString GetBasePath() const { return m_BasePath; }
-        /* SetContentsRange: store in the bookrecord where in the index/contents lists the
-         * book's records are stored. This to facilitate searching in a specific book.
-         * This code will have to be revised when loading/removing books becomes dynamic.
-         * (as opposed to appending only)
-         * Note that storing index range is pointless, because the index is alphab. sorted. */
-        void SetContentsRange(int start, int end) { m_ContentsStart = start; m_ContentsEnd = end; }
-        int GetContentsStart() const { return m_ContentsStart; }
-        int GetContentsEnd() const { return m_ContentsEnd; }
-
-        void SetTitle(const wxString& title) { m_Title = title; }
-        void SetBasePath(const wxString& path) { m_BasePath = path; }
-        void SetStart(const wxString& start) { m_Start = start; }
-
-    protected:
-        wxString m_BasePath;
-        wxString m_Title;
-        wxString m_Start;
-        int m_ContentsStart;
-        int m_ContentsEnd;
+public:
+    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; }
+    /* SetContentsRange: store in the bookrecord where in the index/contents lists the
+     * book's records are stored. This to facilitate searching in a specific book.
+     * This code will have to be revised when loading/removing books becomes dynamic.
+     * (as opposed to appending only)
+     * Note that storing index range is pointless, because the index is alphab. sorted. */
+    void SetContentsRange(int start, int end) { m_ContentsStart = start; m_ContentsEnd = end; }
+    int GetContentsStart() const { return m_ContentsStart; }
+    int GetContentsEnd() const { return m_ContentsEnd; }
+
+    void SetTitle(const wxString& title) { m_Title = title; }
+    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;
+    int m_ContentsStart;
+    int m_ContentsEnd;

 };
 
 
 WX_DECLARE_EXPORTED_OBJARRAY(wxHtmlBookRecord, wxHtmlBookRecArray);
 
 
 };
 
 
 WX_DECLARE_EXPORTED_OBJARRAY(wxHtmlBookRecord, wxHtmlBookRecArray);
 
 

-typedef struct
+struct wxHtmlContentsItem

 {
     short int m_Level;
     int m_ID;
     wxChar* m_Name;
     wxChar* m_Page;
     wxHtmlBookRecord *m_Book;
 {
     short int m_Level;
     int m_ID;
     wxChar* m_Name;
     wxChar* m_Page;
     wxHtmlBookRecord *m_Book;

-}
-wxHtmlContentsItem;
+    
+    // returns full filename of m_Page, i.e. with book's basePath prepended
+    wxString GetFullPath() const { return m_Book->GetFullPath(m_Page); }
+};

 
 //------------------------------------------------------------------------------
 // wxSearchEngine
 //                  This class takes input streams and scans them for occurence
 //                  of keyword(s)
 //------------------------------------------------------------------------------
 
 //------------------------------------------------------------------------------
 // wxSearchEngine
 //                  This class takes input streams and scans them for occurence
 //                  of keyword(s)
 //------------------------------------------------------------------------------

+

 class WXDLLEXPORT wxSearchEngine : public wxObject
 {
 class WXDLLEXPORT wxSearchEngine : public wxObject
 {

-    public:
-        wxSearchEngine() : wxObject() {m_Keyword = NULL; }
-        ~wxSearchEngine() {if (m_Keyword) delete[] m_Keyword; }
+public:
+    wxSearchEngine() : wxObject() {m_Keyword = NULL; }
+    ~wxSearchEngine() {if (m_Keyword) delete[] m_Keyword; }

 
 

-        virtual void LookFor(const wxString& keyword, bool case_sensitive, bool whole_words_only);
-        // Sets the keyword we will be searching for
+    // Sets the keyword we will be searching for
+    virtual void LookFor(const wxString& keyword, bool case_sensitive, bool whole_words_only);

 
 

-        virtual bool Scan(wxInputStream *stream);
-        // Scans the stream for the keyword.
-        // Returns TRUE if the stream contains keyword, fALSE otherwise
+    // Scans the stream for the keyword.
+    // Returns TRUE if the stream contains keyword, fALSE otherwise
+    virtual bool Scan(wxInputStream *stream);

 
 

-    private:
-        wxChar *m_Keyword;
-        bool m_CaseSensitive;
-        bool m_WholeWords;
+private:
+    wxChar *m_Keyword;
+    bool m_CaseSensitive;
+    bool m_WholeWords;

 };
 
 };
 

-class wxHtmlHelpData;

 
 // State information of a search action. I'd have prefered to make this a nested
 // class inside wxHtmlHelpData, but that's against coding standards :-(
 
 // State information of a search action. I'd have prefered to make this a nested
 // class inside wxHtmlHelpData, but that's against coding standards :-(


@@ -112,95 +124,89 @@ class wxHtmlHelpData;
 // wxHtmlHelpData::PrepareKeywordSearch(const wxString& key)
 class WXDLLEXPORT wxHtmlSearchStatus
 {
 // wxHtmlHelpData::PrepareKeywordSearch(const wxString& key)
 class WXDLLEXPORT wxHtmlSearchStatus
 {

-    public:
-        // constructor; supply wxHtmlHelpData ptr, the keyword and (optionally) the
-        // title of the book to search. By default, all books are searched.
-
-        wxHtmlSearchStatus(wxHtmlHelpData* base, const wxString& keyword,
-                           bool case_sensitive, bool whole_words_only,
-                           const wxString& book = wxEmptyString);
-        bool Search();  // do the next iteration
-        bool IsActive() { return m_Active; }
-        int GetCurIndex() { return m_CurIndex; }
-        int GetMaxIndex() { return m_MaxIndex; }
-        const wxString& GetName() { return m_Name; }
-        wxHtmlContentsItem* GetContentsItem() { return m_ContentsItem; }
-
-    private:
-        wxHtmlHelpData* m_Data;
-        wxSearchEngine m_Engine;
-        wxString m_Keyword, m_Name;
-        wxChar *m_LastPage;
-        wxHtmlContentsItem* m_ContentsItem;
-        bool m_Active;   // search is not finished
-        int m_CurIndex;  // where we are now
-        int m_MaxIndex;  // number of files we search
-        // For progress bar: 100*curindex/maxindex = % complete
+public:
+    // constructor; supply wxHtmlHelpData ptr, the keyword and (optionally) the
+    // title of the book to search. By default, all books are searched.
+    wxHtmlSearchStatus(wxHtmlHelpData* base, const wxString& keyword,
+                       bool case_sensitive, bool whole_words_only,
+                       const wxString& book = wxEmptyString);
+    bool Search();  // do the next iteration
+    bool IsActive() { return m_Active; }
+    int GetCurIndex() { return m_CurIndex; }
+    int GetMaxIndex() { return m_MaxIndex; }
+    const wxString& GetName() { return m_Name; }
+    wxHtmlContentsItem* GetContentsItem() { return m_ContentsItem; }
+
+private:
+    wxHtmlHelpData* m_Data;
+    wxSearchEngine m_Engine;
+    wxString m_Keyword, m_Name;
+    wxChar *m_LastPage;
+    wxHtmlContentsItem* m_ContentsItem;
+    bool m_Active;   // search is not finished
+    int m_CurIndex;  // where we are now
+    int m_MaxIndex;  // number of files we search
+    // For progress bar: 100*curindex/maxindex = % complete

 };
 
 class WXDLLEXPORT wxHtmlHelpData : public wxObject
 {
 };
 
 class WXDLLEXPORT wxHtmlHelpData : public wxObject
 {

-        DECLARE_DYNAMIC_CLASS(wxHtmlHelpData)
-
-        friend class wxHtmlSearchStatus;
-
-    public:
-        wxHtmlHelpData();
-        ~wxHtmlHelpData();
-
-        void SetTempDir(const wxString& path);
-        // Sets directory where temporary files are stored.
-        // These temp files are index & contents file in binary (much faster to read)
-        // form. These files are NOT deleted on program's exit.
-
-        bool AddBook(const wxString& book);
-        // Adds new book. 'book' is location of .htb file (stands for "html book").
-        // See documentation for details on its format.
-        // Returns success.
-        bool AddBookParam(const wxFSFile& bookfile,
-                          wxFontEncoding encoding,
-                          const wxString& title, const wxString& contfile,
-                          const wxString& indexfile = wxEmptyString,
-                          const wxString& deftopic = wxEmptyString,
-                          const wxString& path = wxEmptyString);
-
-        // Some accessing stuff
-        wxString FindPageByName(const wxString& page);
-        // returns URL of page on basis of (file)name
-        wxString FindPageById(int id);
-        // returns URL of page on basis of MS id
-
-        const wxHtmlBookRecArray& GetBookRecArray() { return m_BookRecords; }
-        wxHtmlContentsItem* GetContents() { return m_Contents; }
-        int GetContentsCnt() { return m_ContentsCnt; }
-        wxHtmlContentsItem* GetIndex() { return m_Index; }
-        int GetIndexCnt() { return m_IndexCnt; }
-
-    protected:
-        wxString m_TempPath;
-
-        wxHtmlBookRecArray m_BookRecords;
-        // each book has one record in this array
-        wxHtmlContentsItem* m_Contents;
-        int m_ContentsCnt;
-        // list of all available books and pages.
-        wxHtmlContentsItem* m_Index;
-        int m_IndexCnt;
-        // list of index items
-
-    protected:
-        bool LoadMSProject(wxHtmlBookRecord *book, wxFileSystem& fsys,
-                           const wxString& indexfile, const wxString& contentsfile);
-        // Imports .hhp files (MS HTML Help Workshop)
-        bool LoadCachedBook(wxHtmlBookRecord *book, wxInputStream *f);
-        // Reads binary book
-        bool SaveCachedBook(wxHtmlBookRecord *book, wxOutputStream *f);
-        // Writes binary book
+    DECLARE_DYNAMIC_CLASS(wxHtmlHelpData)
+    friend class wxHtmlSearchStatus;
+
+public:
+    wxHtmlHelpData();
+    ~wxHtmlHelpData();
+
+    // Sets directory where temporary files are stored.
+    // These temp files are index & contents file in binary (much faster to read)
+    // form. These files are NOT deleted on program's exit.
+    void SetTempDir(const wxString& path);
+
+    // Adds new book. 'book' is location of .htb file (stands for "html book").
+    // See documentation for details on its format.
+    // Returns success.
+    bool AddBook(const wxString& book);
+    bool AddBookParam(const wxFSFile& bookfile,
+                      wxFontEncoding encoding,
+                      const wxString& title, const wxString& contfile,
+                      const wxString& indexfile = wxEmptyString,
+                      const wxString& deftopic = wxEmptyString,
+                      const wxString& path = wxEmptyString);
+
+    // Some accessing stuff:
+
+    // returns URL of page on basis of (file)name
+    wxString FindPageByName(const wxString& page);
+    // returns URL of page on basis of MS id
+    wxString FindPageById(int id);
+
+    const wxHtmlBookRecArray& GetBookRecArray() { return m_BookRecords; }
+    wxHtmlContentsItem* GetContents() { return m_Contents; }
+    int GetContentsCnt() { return m_ContentsCnt; }
+    wxHtmlContentsItem* GetIndex() { return m_Index; }
+    int GetIndexCnt() { return m_IndexCnt; }
+
+protected:
+    wxString m_TempPath;
+
+    wxHtmlBookRecArray m_BookRecords;
+    // each book has one record in this array:
+    wxHtmlContentsItem* m_Contents;
+    int m_ContentsCnt;   
+    wxHtmlContentsItem* m_Index; // list of all available books and pages.
+    int m_IndexCnt;  // list of index items
+
+protected:
+    // Imports .hhp files (MS HTML Help Workshop)
+    bool LoadMSProject(wxHtmlBookRecord *book, wxFileSystem& fsys,
+                       const wxString& indexfile, const wxString& contentsfile);
+    // Reads binary book
+    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) ;
-

 #endif
 
 #endif
 #endif
 
 #endif