interface/wx/html/helpdata.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        html/helpdata.h
   3 // Purpose:     interface of wxHtmlHelpData
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxHtmlHelpData
  11
  12     This class is used by wxHtmlHelpController and wxHtmlHelpFrame to access HTML
  13     help items.
  14
  15     It is internal class and should not be used directly - except for the case
  16     you're writing your own HTML help controller.
  17
  18     @library{wxhtml}
  19     @category{help,html}
  20 */
  21 class wxHtmlHelpData : public wxObject
  22 {
  23 public:
  24     /**
  25         Constructor.
  26     */
  27     wxHtmlHelpData();
  28
  29     /**
  30         Adds new book.
  31
  32         @a book_url is URL (not filename!) of HTML help project (hhp) or ZIP file
  33         that contains arbitrary number of .hhp projects (this zip file can have
  34         either .zip or .htb extension, htb stands for "html book").
  35
  36         Returns success.
  37     */
  38     bool AddBook(const wxString& book_url);
  39
  40     /**
  41         Returns page's URL based on integer ID stored in project.
  42     */
  43     wxString FindPageById(int id);
  44
  45     /**
  46         Returns page's URL based on its (file)name.
  47     */
  48     wxString FindPageByName(const wxString& page);
  49
  50     /**
  51         Returns array with help books info.
  52     */
  53     const wxHtmlBookRecArray& GetBookRecArray() const;
  54
  55     /**
  56         Returns reference to array with contents entries.
  57     */
  58     const wxHtmlHelpDataItems& GetContentsArray() const;
  59
  60     /**
  61         Returns reference to array with index entries.
  62     */
  63     const wxHtmlHelpDataItems& GetIndexArray() const;
  64
  65     /**
  66         Sets the temporary directory where binary cached versions of MS HTML Workshop
  67         files will be stored. (This is turned off by default and you can enable
  68         this feature by setting non-empty temp dir.)
  69     */
  70     void SetTempDir(const wxString& path);
  71 };
  72