Added wxPGChoices::Copy(), tweaked related documentation

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

diff --git a/include/wx/html/helpdata.h b/include/wx/html/helpdata.h
index a59c6f76d633f560711c4dc3f1fe744799ba6d53..320235a446e9d4f63c19d901afa02ed6a5190a89 100644 (file)
--- a/include/wx/html/helpdata.h
+++ b/include/wx/html/helpdata.h
@@ -12,10 +12,6 @@
 #ifndef _WX_HELPDATA_H_
 #define _WX_HELPDATA_H_
 
 #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/defs.h"
 
 #if wxUSE_HTML


@@ -26,7 +22,7 @@
 #include "wx/dynarray.h"
 #include "wx/font.h"
 
 #include "wx/dynarray.h"
 #include "wx/font.h"
 

-class WXDLLIMPEXP_HTML wxHtmlHelpData;
+class WXDLLIMPEXP_FWD_HTML wxHtmlHelpData;

 
 //--------------------------------------------------------------------------------
 // helper classes & structs
 
 //--------------------------------------------------------------------------------
 // helper classes & structs


@@ -101,33 +97,10 @@ struct WXDLLIMPEXP_HTML wxHtmlHelpDataItem
 WX_DECLARE_USER_EXPORTED_OBJARRAY(wxHtmlHelpDataItem, wxHtmlHelpDataItems,
                                   WXDLLIMPEXP_HTML);
 
 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();
-
-    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
 
 //------------------------------------------------------------------------------
 // wxHtmlSearchEngine

-//                  This class takes input streams and scans them for occurence
+//                  This class takes input streams and scans them for occurrence

 //                  of keyword(s)
 //------------------------------------------------------------------------------
 
 //                  of keyword(s)
 //------------------------------------------------------------------------------
 


@@ -135,7 +108,7 @@ class WXDLLIMPEXP_HTML wxHtmlSearchEngine : public wxObject
 {
 public:
     wxHtmlSearchEngine() : 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);
 
     // Sets the keyword we will be searching for
     virtual void LookFor(const wxString& keyword, bool case_sensitive, bool whole_words_only);


@@ -153,8 +126,8 @@ 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
 // Never construct this class yourself, obtain a copy from
 // wxHtmlHelpData::PrepareKeywordSearch(const wxString& key)
 class WXDLLIMPEXP_HTML wxHtmlSearchStatus


@@ -172,9 +145,6 @@ public:
     const wxString& GetName() { return m_Name; }
 
     const wxHtmlHelpDataItem *GetCurItem() const { return m_CurItem; }
     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;
 
 private:
     wxHtmlHelpData* m_Data;


@@ -197,7 +167,7 @@ class WXDLLIMPEXP_HTML wxHtmlHelpData : public wxObject
 
 public:
     wxHtmlHelpData();
 
 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)
 
     // Sets directory where temporary files are stored.
     // These temp files are index & contents file in binary (much faster to read)


@@ -227,14 +197,6 @@ public:
     const wxHtmlHelpDataItems& GetContentsArray() const { return m_contents; }
     const wxHtmlHelpDataItems& GetIndexArray() const { return m_index; }
 
     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;
 
 protected:
     wxString m_tempPath;
 


@@ -244,15 +206,6 @@ protected:
     wxHtmlHelpDataItems m_contents; // list of all available books and pages
     wxHtmlHelpDataItems m_index; // list of index itesm
 
     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)
     bool LoadMSProject(wxHtmlBookRecord *book, wxFileSystem& fsys,
 protected:
     // Imports .hhp files (MS HTML Help Workshop)
     bool LoadMSProject(wxHtmlBookRecord *book, wxFileSystem& fsys,