wxPython/src/htmlhelp.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        htmlhelp.i
   3 // Purpose:     SWIG definitions of html classes
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     25-Nov-1998
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 1998 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13
  14 %module htmlhelp
  15
  16 %{
  17 #include "export.h"
  18 #include <wx/html/htmlwin.h>
  19 #include <wx/html/helpctrl.h>
  20 #include <wx/image.h>
  21 #include <wx/fs_zip.h>
  22 #include <wx/fs_inet.h>
  23 #include <wx/wfstream.h>
  24 %}
  25
  26 //---------------------------------------------------------------------------
  27
  28 %include typemaps.i
  29 %include my_typemaps.i
  30
  31 %extern wx.i
  32 %extern windows.i
  33 %extern frames.i
  34 %extern _defs.i
  35 %extern events.i
  36 %extern controls.i
  37 %extern controls2.i
  38
  39 %extern utils.i
  40 %extern html.i
  41
  42
  43 //---------------------------------------------------------------------------
  44
  45 class wxHtmlBookRecord  {
  46 public:
  47     wxHtmlBookRecord(const wxString& basepath, const wxString& title,
  48                      const wxString& start);
  49
  50     wxString GetTitle();
  51     wxString GetStart();
  52     wxString GetBasePath();
  53
  54     void SetContentsRange(int start, int end);
  55     int GetContentsStart();
  56     int GetContentsEnd();
  57 };
  58
  59 //---------------------------------------------------------------------------
  60
  61 typedef struct
  62 {
  63     short int m_Level;
  64     int m_ID;
  65     char* m_Name;
  66     char* m_Page;
  67     wxHtmlBookRecord *m_Book;
  68 } wxHtmlContentsItem;
  69
  70 //---------------------------------------------------------------------------
  71
  72 class wxHtmlSearchStatus
  73 {
  74 public:
  75     //wxHtmlSearchStatus(wxHtmlHelpData* base, const wxString& keyword,
  76     //                   const wxString& book = wxEmptyString);
  77     bool Search();
  78     bool IsActive();
  79     int GetCurIndex();
  80     int GetMaxIndex();
  81     const wxString& GetName();
  82     wxHtmlContentsItem* GetContentsItem();
  83 };
  84
  85 //---------------------------------------------------------------------------
  86
  87 class wxHtmlHelpData {
  88 public:
  89     wxHtmlHelpData();
  90     ~wxHtmlHelpData();
  91
  92     void SetTempDir(const wxString& path);
  93     bool AddBook(const wxString& book);
  94 //      bool AddBookParam(const wxString& title, const wxString& contfile,
  95 //                    const wxString& indexfile=wxEmptyString,
  96 //                    const wxString& deftopic=wxEmptyString,
  97 //                    const wxString& path=wxEmptyString);
  98
  99     wxString FindPageByName(const wxString& page);
 100     wxString FindPageById(int id);
 101
 102     // TODO: this one needs fixed...
 103     const wxHtmlBookRecArray& GetBookRecArray();
 104
 105     wxHtmlContentsItem* GetContents();
 106     int GetContentsCnt();
 107     wxHtmlContentsItem* GetIndex();
 108     int GetIndexCnt();
 109 };
 110
 111 //---------------------------------------------------------------------------
 112
 113 class wxHtmlHelpFrame : public wxFrame {
 114 public:
 115     wxHtmlHelpFrame(wxWindow* parent, int wxWindowID,
 116                     const wxString& title = wxEmptyString,
 117                     int style = wxHF_DEFAULTSTYLE, wxHtmlHelpData* data = NULL);
 118
 119     wxHtmlHelpData* GetData();
 120     void SetTitleFormat(const wxString& format);
 121     void Display(const wxString& x);
 122     %name(DisplayID) void Display(int id);
 123     void DisplayContents();
 124     void DisplayIndex();
 125     bool KeywordSearch(const wxString& keyword);
 126     void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString);
 127     void ReadCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
 128     void WriteCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
 129 };
 130
 131
 132 //---------------------------------------------------------------------------
 133
 134
 135 enum {
 136     wxHF_TOOLBAR,
 137     wxHF_FLATTOOLBAR,
 138     wxHF_CONTENTS,
 139     wxHF_INDEX,
 140     wxHF_SEARCH,
 141     wxHF_BOOKMARKS,
 142     wxHF_OPENFILES,
 143     wxHF_PRINT,
 144     wxHF_DEFAULTSTYLE,
 145 };
 146
 147
 148 class wxHtmlHelpController : public wxEvtHandler {
 149 public:
 150     wxHtmlHelpController(int style = wxHF_DEFAULTSTYLE);
 151     ~wxHtmlHelpController();
 152
 153     void SetTitleFormat(const wxString& format);
 154     void SetTempDir(const wxString& path);
 155     bool AddBook(const wxString& book, int show_wait_msg = FALSE);
 156     void Display(const wxString& x);
 157     %name(DisplayID) void Display(int id);
 158     void DisplayContents();
 159     void DisplayIndex();
 160     bool KeywordSearch(const wxString& keyword);
 161     void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString);
 162     void ReadCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
 163     void WriteCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
 164     wxHtmlHelpFrame* GetFrame();
 165 };
 166
 167 //---------------------------------------------------------------------------
 168 //---------------------------------------------------------------------------