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 : public wxObject {
  46 public:
  47     wxHtmlBookRecord(const wxString& bookfile, const wxString& basepath,
  48                      const wxString& title, const wxString& start);
  49
  50     wxString GetBookFile();
  51     wxString GetTitle();
  52     wxString GetStart();
  53     wxString GetBasePath();
  54
  55     void SetContentsRange(int start, int end);
  56     int GetContentsStart();
  57     int GetContentsEnd();
  58
  59     void SetTitle(const wxString& title);
  60     void SetBasePath(const wxString& path);
  61     void SetStart(const wxString& start);
  62
  63     wxString GetFullPath(const wxString &page) const;
  64 };
  65
  66 //---------------------------------------------------------------------------
  67
  68 struct wxHtmlContentsItem
  69 {
  70     short int m_Level;
  71     int m_ID;
  72     char* m_Name;
  73     char* m_Page;
  74     wxHtmlBookRecord *m_Book;
  75 };
  76
  77 //---------------------------------------------------------------------------
  78
  79 class wxHtmlSearchStatus
  80 {
  81 public:
  82     //wxHtmlSearchStatus(wxHtmlHelpData* base, const wxString& keyword,
  83     //                   const wxString& book = wxEmptyString);
  84     bool Search();
  85     bool IsActive();
  86     int GetCurIndex();
  87     int GetMaxIndex();
  88     const wxString& GetName();
  89     wxHtmlContentsItem* GetContentsItem();
  90 };
  91
  92 //---------------------------------------------------------------------------
  93
  94 class wxHtmlHelpData {
  95 public:
  96     wxHtmlHelpData();
  97     ~wxHtmlHelpData();
  98
  99     void SetTempDir(const wxString& path);
 100     bool AddBook(const wxString& book);
 101 //      bool AddBookParam(const wxString& title, const wxString& contfile,
 102 //                    const wxString& indexfile=wxEmptyString,
 103 //                    const wxString& deftopic=wxEmptyString,
 104 //                    const wxString& path=wxEmptyString);
 105
 106     wxString FindPageByName(const wxString& page);
 107     wxString FindPageById(int id);
 108
 109     // TODO: this one needs fixed...
 110     const wxHtmlBookRecArray& GetBookRecArray();
 111
 112     wxHtmlContentsItem* GetContents();
 113     int GetContentsCnt();
 114     wxHtmlContentsItem* GetIndex();
 115     int GetIndexCnt();
 116 };
 117
 118 //---------------------------------------------------------------------------
 119
 120 class wxHtmlHelpFrame : public wxFrame {
 121 public:
 122     wxHtmlHelpFrame(wxWindow* parent, int wxWindowID,
 123                     const wxString& title = wxEmptyString,
 124                     int style = wxHF_DEFAULTSTYLE, wxHtmlHelpData* data = NULL);
 125
 126     %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
 127
 128     wxHtmlHelpData* GetData();
 129     void SetTitleFormat(const wxString& format);
 130     void Display(const wxString& x);
 131     %name(DisplayID) void Display(int id);
 132     void DisplayContents();
 133     void DisplayIndex();
 134     bool KeywordSearch(const wxString& keyword);
 135     void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString);
 136     void ReadCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
 137     void WriteCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
 138 };
 139
 140
 141 //---------------------------------------------------------------------------
 142
 143
 144 enum {
 145     wxHF_TOOLBAR,
 146     wxHF_FLATTOOLBAR,
 147     wxHF_CONTENTS,
 148     wxHF_INDEX,
 149     wxHF_SEARCH,
 150     wxHF_BOOKMARKS,
 151     wxHF_OPENFILES,
 152     wxHF_PRINT,
 153     wxHF_DEFAULTSTYLE,
 154 };
 155
 156
 157 class wxHtmlHelpController : public wxEvtHandler {
 158 public:
 159     wxHtmlHelpController(int style = wxHF_DEFAULTSTYLE);
 160     ~wxHtmlHelpController();
 161
 162     %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
 163
 164     void SetTitleFormat(const wxString& format);
 165     void SetTempDir(const wxString& path);
 166     bool AddBook(const wxString& book, int show_wait_msg = FALSE);
 167     void Display(const wxString& x);
 168     %name(DisplayID) void Display(int id);
 169     void DisplayContents();
 170     void DisplayIndex();
 171     bool KeywordSearch(const wxString& keyword);
 172     void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString);
 173     void ReadCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
 174     void WriteCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
 175     wxHtmlHelpFrame* GetFrame();
 176 };
 177
 178 //---------------------------------------------------------------------------
 179 //---------------------------------------------------------------------------