#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
#include "wx/dynarray.h"
#include "wx/font.h"
-class WXDLLIMPEXP_HTML wxHtmlHelpData;
+class WXDLLIMPEXP_FWD_HTML wxHtmlHelpData;
//--------------------------------------------------------------------------------
// helper classes & structs
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;
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;
struct WXDLLIMPEXP_HTML wxHtmlHelpDataItem
{
- wxHtmlHelpDataItem() : level(0), parent(NULL), id(-1), book(NULL) {}
+ wxHtmlHelpDataItem() : level(0), parent(NULL), id(wxID_ANY), book(NULL) {}
- short int level;
+ 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 book->GetFullPath(page); }
WX_DECLARE_USER_EXPORTED_OBJARRAY(wxHtmlHelpDataItem, wxHtmlHelpDataItems,
WXDLLIMPEXP_HTML);
-#if WXWIN_COMPATIBILITY_2_4
-// old interface to contents and index:
-struct wxHtmlContentsItem
-{
- wxHtmlContentsItem();
- wxHtmlContentsItem(const wxHtmlHelpDataItem& d);
- wxHtmlContentsItem& operator=(const wxHtmlContentsItem& d);
- ~wxHtmlContentsItem();
-
- short int m_Level;
- int m_ID;
- 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); }
-
-private:
- bool m_autofree;
-};
-#endif
-
//------------------------------------------------------------------------------
// wxHtmlSearchEngine
{
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:
};
-// 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
const wxString& GetName() { return m_Name; }
const wxHtmlHelpDataItem *GetCurItem() const { return m_CurItem; }
-#if WXWIN_COMPATIBILITY_2_4
- wxDEPRECATED( wxHtmlContentsItem* GetContentsItem() );
-#endif
private:
wxHtmlHelpData* m_Data;
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)
const wxHtmlHelpDataItems& GetContentsArray() const { return m_contents; }
const wxHtmlHelpDataItems& GetIndexArray() const { return m_index; }
-#if WXWIN_COMPATIBILITY_2_4
- // deprecated interface, new interface is arrays-based (see above)
- wxDEPRECATED( wxHtmlContentsItem* GetContents() );
- wxDEPRECATED( int GetContentsCnt() );
- wxDEPRECATED( wxHtmlContentsItem* GetIndex() );
- wxDEPRECATED( int GetIndexCnt() );
-#endif
-
protected:
wxString m_tempPath;
wxHtmlHelpDataItems m_contents; // list of all available books and pages
wxHtmlHelpDataItems m_index; // list of index itesm
-
-#if WXWIN_COMPATIBILITY_2_4
- // deprecated data structures, set only if GetContents(), GetIndex()
- // called
- wxHtmlContentsItem* m_cacheContents;
- wxHtmlContentsItem* m_cacheIndex;
-private:
- void CleanCompatibilityData();
-#endif
protected:
// Imports .hhp files (MS HTML Help Workshop)