X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3912b3f8f749862e3d336e124cf882ee7ff5a2cd..616c0d1f3ac084bb92f0a75dc48812e8647f1b22:/include/wx/html/helpdata.h diff --git a/include/wx/html/helpdata.h b/include/wx/html/helpdata.h index d8e8dab59f..09b1a46bce 100644 --- a/include/wx/html/helpdata.h +++ b/include/wx/html/helpdata.h @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: helpdata.h +// Name: wx/html/helpdata.h // Purpose: wxHtmlHelpData // Notes: Based on htmlhelp.cpp, implementing a monolithic // HTML Help controller class, by Vaclav Slavik @@ -12,10 +12,6 @@ #ifndef _WX_HELPDATA_H_ #define _WX_HELPDATA_H_ -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) -#pragma interface "helpdata.h" -#endif - #include "wx/defs.h" #if wxUSE_HTML @@ -26,7 +22,7 @@ #include "wx/dynarray.h" #include "wx/font.h" -class WXDLLIMPEXP_HTML wxHtmlHelpData; +class WXDLLIMPEXP_FWD_HTML wxHtmlHelpData; //-------------------------------------------------------------------------------- // helper classes & structs @@ -35,7 +31,7 @@ class WXDLLIMPEXP_HTML wxHtmlHelpData; class WXDLLIMPEXP_HTML wxHtmlBookRecord { public: - wxHtmlBookRecord(const wxString& bookfile, const wxString& basepath, + wxHtmlBookRecord(const wxString& bookfile, const wxString& basepath, const wxString& title, const wxString& start) { m_BookFile = bookfile; @@ -62,8 +58,8 @@ 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 + // 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; @@ -80,22 +76,31 @@ protected: WX_DECLARE_USER_EXPORTED_OBJARRAY(wxHtmlBookRecord, wxHtmlBookRecArray, WXDLLIMPEXP_HTML); - -struct wxHtmlContentsItem +struct WXDLLIMPEXP_HTML wxHtmlHelpDataItem { - short int m_Level; - int m_ID; - wxString m_Name; - wxString m_Page; - wxHtmlBookRecord *m_Book; - + wxHtmlHelpDataItem() : level(0), parent(NULL), id(wxID_ANY), book(NULL) {} + + int level; + wxHtmlHelpDataItem *parent; + int id; + wxString name; + wxString page; + wxHtmlBookRecord *book; + // returns full filename of m_Page, i.e. with book's basePath prepended - wxString GetFullPath() const { return m_Book->GetFullPath(m_Page); } + wxString GetFullPath() const { return book->GetFullPath(page); } + + // returns item indented with spaces if it has level>1: + wxString GetIndentedName() const; }; +WX_DECLARE_USER_EXPORTED_OBJARRAY(wxHtmlHelpDataItem, wxHtmlHelpDataItems, + WXDLLIMPEXP_HTML); + + //------------------------------------------------------------------------------ // wxHtmlSearchEngine -// This class takes input streams and scans them for occurence +// This class takes input streams and scans them for occurrence // of keyword(s) //------------------------------------------------------------------------------ @@ -103,13 +108,13 @@ class WXDLLIMPEXP_HTML wxHtmlSearchEngine : public wxObject { public: wxHtmlSearchEngine() : wxObject() {} - ~wxHtmlSearchEngine() {} + virtual ~wxHtmlSearchEngine() {} // 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 + // Returns true if the stream contains keyword, fALSE otherwise virtual bool Scan(const wxFSFile& file); private: @@ -117,12 +122,12 @@ private: bool m_CaseSensitive; bool m_WholeWords; - DECLARE_NO_COPY_CLASS(wxHtmlSearchEngine) + wxDECLARE_NO_COPY_CLASS(wxHtmlSearchEngine); }; -// 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 preferred to make this a +// nested class inside wxHtmlHelpData, but that's against coding standards :-( // Never construct this class yourself, obtain a copy from // wxHtmlHelpData::PrepareKeywordSearch(const wxString& key) class WXDLLIMPEXP_HTML wxHtmlSearchStatus @@ -138,20 +143,21 @@ public: int GetCurIndex() { return m_CurIndex; } int GetMaxIndex() { return m_MaxIndex; } const wxString& GetName() { return m_Name; } - wxHtmlContentsItem* GetContentsItem() { return m_ContentsItem; } + + const wxHtmlHelpDataItem *GetCurItem() const { return m_CurItem; } private: wxHtmlHelpData* m_Data; wxHtmlSearchEngine m_Engine; wxString m_Keyword, m_Name; wxString m_LastPage; - wxHtmlContentsItem* m_ContentsItem; + wxHtmlHelpDataItem* m_CurItem; 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 - DECLARE_NO_COPY_CLASS(wxHtmlSearchStatus) + wxDECLARE_NO_COPY_CLASS(wxHtmlSearchStatus); }; class WXDLLIMPEXP_HTML wxHtmlHelpData : public wxObject @@ -161,7 +167,7 @@ class WXDLLIMPEXP_HTML wxHtmlHelpData : public wxObject public: wxHtmlHelpData(); - ~wxHtmlHelpData(); + virtual ~wxHtmlHelpData(); // Sets directory where temporary files are stored. // These temp files are index & contents file in binary (much faster to read) @@ -172,15 +178,12 @@ public: // See documentation for details on its format. // Returns success. bool AddBook(const wxString& book); -#if WXWIN_COMPATIBILITY_2_4 - wxDEPRECATED( 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) ); -#endif + const wxString& path = wxEmptyString); // Some accessing stuff: @@ -189,30 +192,21 @@ public: // 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; } + const wxHtmlBookRecArray& GetBookRecArray() const { return m_bookRecords; } + + const wxHtmlHelpDataItems& GetContentsArray() const { return m_contents; } + const wxHtmlHelpDataItems& GetIndexArray() const { return m_index; } protected: - wxString m_TempPath; + 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 + wxHtmlBookRecArray m_bookRecords; + + wxHtmlHelpDataItems m_contents; // list of all available books and pages + wxHtmlHelpDataItems m_index; // list of index itesm protected: - bool AddBookParam(const wxFSFile& bookfile, - const wxString& charset, - const wxString& title, const wxString& contfile, - const wxString& indexfile = wxEmptyString, - const wxString& deftopic = wxEmptyString, - const wxString& path = wxEmptyString); - // Imports .hhp files (MS HTML Help Workshop) bool LoadMSProject(wxHtmlBookRecord *book, wxFileSystem& fsys, const wxString& indexfile, const wxString& contentsfile); @@ -221,7 +215,7 @@ protected: // Writes binary book bool SaveCachedBook(wxHtmlBookRecord *book, wxOutputStream *f); - DECLARE_NO_COPY_CLASS(wxHtmlHelpData) + wxDECLARE_NO_COPY_CLASS(wxHtmlHelpData); }; #endif