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