//
// Author: Robin Dunn
//
-// Created: 25-nov-1998
+// Created: 25-Nov-1998
// RCS-ID: $Id$
-// Copyright: (c) 1998 by Total Control Software
+// Copyright: (c) 2003 by Total Control Software
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
%module html
%{
-#include "wxPython.h"
+#include "wx/wxPython/wxPython.h"
+#include "wx/wxPython/pyclasses.h"
+#include "wx/wxPython/pyistream.h"
+#include "wx/wxPython/printfw.h"
+
#include <wx/html/htmlwin.h>
#include <wx/html/htmprint.h>
-#include <wx/image.h>
-#include <wx/fs_zip.h>
-#include <wx/fs_inet.h>
-#include <wx/wfstream.h>
-#include <wx/filesys.h>
+#include <wx/html/helpctrl.h>
-#include "printfw.h"
%}
-//---------------------------------------------------------------------------
-
-%include typemaps.i
-%include my_typemaps.i
-
-%extern wx.i
-%extern windows.i
-%extern _defs.i
-%extern events.i
-%extern controls.i
-%extern controls2.i
-%extern printfw.i
-%extern utils.i
-%extern filesys.i
-%extern streams.i
-
-%pragma(python) code = "import wx"
+//---------------------------------------------------------------------------
+%import windows.i
+%pythoncode { wx = _core }
+%pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
-//----------------------------------------------------------------------
+%include _html_rename.i
-%{
- // Put some wx default wxChar* values into wxStrings.
- static const wxChar* wxHtmlWindowNameStr = wxT("htmlWindow");
- DECLARE_DEF_STRING(HtmlWindowNameStr);
- static const wxChar* wxHtmlPrintoutTitleStr = wxT("Printout");
- DECLARE_DEF_STRING(HtmlPrintoutTitleStr);
+MAKE_CONST_WXSTRING_NOSWIG(EmptyString);
+MAKE_CONST_WXSTRING2(HtmlWindowNameStr, wxT("htmlWindow"))
+MAKE_CONST_WXSTRING2(HtmlPrintoutTitleStr, wxT("Printout"))
+MAKE_CONST_WXSTRING2(HtmlPrintingTitleStr, wxT("Printing"))
- static const wxChar* wxHtmlPrintingTitleStr = wxT("Printing");
- DECLARE_DEF_STRING(HtmlPrintingTitleStr);
- static const wxString wxPyEmptyString(wxT(""));
-%}
+// TODO: Split this file into multiple %included files that coresponds to the
+// wx/html include files (more or less.)
//---------------------------------------------------------------------------
+//---------------------------------------------------------------------------
+%newgroup
+
enum {
wxHTML_ALIGN_LEFT,
wxHTML_COND_ISANCHOR,
wxHTML_COND_ISIMAGEMAP,
wxHTML_COND_USER,
+
+
+ wxHTML_FONT_SIZE_1,
+ wxHTML_FONT_SIZE_2,
+ wxHTML_FONT_SIZE_3,
+ wxHTML_FONT_SIZE_4,
+ wxHTML_FONT_SIZE_5,
+ wxHTML_FONT_SIZE_6,
+ wxHTML_FONT_SIZE_7,
};
wxHTML_URL_OTHER
};
+
+
//---------------------------------------------------------------------------
class wxHtmlLinkInfo : public wxObject {
wxString GetName();
bool HasParam(const wxString& par);
- wxString GetParam(const wxString& par, int with_commas = FALSE);
+ wxString GetParam(const wxString& par, int with_commas = False);
// Can't do this one as-is, but GetParam should be enough...
//int ScanParam(const wxString& par, const char *format, void* param);
int GetEndPos2();
};
-
//---------------------------------------------------------------------------
class wxHtmlParser : public wxObject {
int GetCharHeight();
int GetCharWidth();
wxPyHtmlWindow* GetWindow();
+
// Sets fonts to be used when displaying HTML page. (if size null then default sizes used).
- %addmethods {
+ %extend {
void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes=NULL) {
int* temp = NULL;
if (sizes) temp = int_LIST_helper(sizes);
};
-
//---------------------------------------------------------------------------
%{
%}
-%name(wxHtmlTagHandler) class wxPyHtmlTagHandler : public wxObject {
+%name(HtmlTagHandler) class wxPyHtmlTagHandler : public wxObject {
public:
+ %pythonAppend wxPyHtmlTagHandler "self._setCallbackInfo(self, HtmlTagHandler)"
wxPyHtmlTagHandler();
void _setCallbackInfo(PyObject* self, PyObject* _class);
- %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxHtmlTagHandler)"
void SetParser(wxHtmlParser *parser);
wxHtmlParser* GetParser();
%}
-%name(wxHtmlWinTagHandler) class wxPyHtmlWinTagHandler : public wxPyHtmlTagHandler {
+%name(HtmlWinTagHandler) class wxPyHtmlWinTagHandler : public wxPyHtmlTagHandler {
public:
+ %pythonAppend wxPyHtmlWinTagHandler "self._setCallbackInfo(self, HtmlWinTagHandler)"
wxPyHtmlWinTagHandler();
void _setCallbackInfo(PyObject* self, PyObject* _class);
- %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxHtmlWinTagHandler)"
void SetParser(wxHtmlParser *parser);
wxHtmlWinParser* GetParser();
}
void OnExit() {
- wxPyBeginBlockThreads();
+ bool blocked = wxPyBeginBlockThreads();
Py_DECREF(m_tagHandlerClass);
m_tagHandlerClass = NULL;
for (size_t x=0; x < m_objArray.GetCount(); x++) {
PyObject* obj = (PyObject*)m_objArray.Item(x);
Py_DECREF(obj);
}
- wxPyEndBlockThreads();
+ wxPyEndBlockThreads(blocked);
};
void FillHandlersTable(wxHtmlWinParser *parser) {
// Wave our magic wand... (if it works it's a miracle! ;-)
// First, make a new instance of the tag handler
- wxPyBeginBlockThreads();
- PyObject* arg = Py_BuildValue("()");
- PyObject* obj = PyInstance_New(m_tagHandlerClass, arg, NULL);
+ bool blocked = wxPyBeginBlockThreads();
+ PyObject* arg = PyTuple_New(0);
+ PyObject* obj = PyObject_CallObject(m_tagHandlerClass, arg);
Py_DECREF(arg);
- wxPyEndBlockThreads();
-
+
// now figure out where it's C++ object is...
wxPyHtmlWinTagHandler* thPtr;
- if (SWIG_GetPtrObj(obj, (void **)&thPtr, "_wxPyHtmlWinTagHandler_p"))
+ if (! wxPyConvertSwigPtr(obj, (void **)&thPtr, wxT("wxPyHtmlWinTagHandler"))) {
+ wxPyEndBlockThreads(blocked);
return;
+ }
+ wxPyEndBlockThreads(blocked);
// add it,
parser->AddTagHandler(thPtr);
//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
+%newgroup
// wxHtmlSelection is data holder with information about text selection.
wxHTML_SEL_CHANGING // ... is the cell on which selection state changes
};
+
+
// Selection state is passed to wxHtmlCell::Draw so that it can render itself
// differently e.g. when inside text selection or outside it.
class wxHtmlRenderingState
};
+
// HTML rendering customization. This class is used when rendering wxHtmlCells
// as a callback:
class wxHtmlRenderingStyle
};
//---------------------------------------------------------------------------
+%newgroup
enum
int GetWidth();
int GetHeight();
int GetDescent();
+
+ // Returns the maximum possible length of the cell.
+ // Call Layout at least once before using GetMaxTotalWidth()
+ int GetMaxTotalWidth() const;
+
+ const wxString& GetId() const;
+ void SetId(const wxString& id);
wxHtmlLinkInfo* GetLink(int x = 0, int y = 0);
wxHtmlCell* GetNext();
wxHtmlContainerCell* GetParent();
// Can the line be broken before this cell?
bool IsLinebreakAllowed() const;
- // Returns true for simple == terminal cells, i.e. not composite ones.
+ // Returns True for simple == terminal cells, i.e. not composite ones.
// This if for internal usage only and may disappear in future versions!
bool IsTerminalCell() const;
// (if it is the root, depth is 0)
unsigned GetDepth() const;
- // Returns true if the cell appears before 'cell' in natural order of
+ // Returns True if the cell appears before 'cell' in natural order of
// cells (= as they are read). If cell A is (grand)parent of cell B,
- // then both A.IsBefore(B) and B.IsBefore(A) always return true.
+ // then both A.IsBefore(B) and B.IsBefore(A) always return True.
bool IsBefore(wxHtmlCell *cell) const;
// Converts the cell into text representation. If sel != NULL then
};
+
+
//---------------------------------------------------------------------------
// wxHtmlFilter
//---------------------------------------------------------------------------
+%newgroup
%{ // here's the C++ version
public:
wxPyHtmlFilter() : wxHtmlFilter() {}
- // returns TRUE if this filter is able to open&read given file
+ // returns True if this filter is able to open&read given file
virtual bool CanRead(const wxFSFile& file) const {
- bool rval = FALSE;
+ bool rval = False;
bool found;
- wxPyBeginBlockThreads();
+ bool blocked = wxPyBeginBlockThreads();
if ((found = wxPyCBH_findCallback(m_myInst, "CanRead"))) {
PyObject* obj = wxPyMake_wxObject((wxFSFile*)&file); // cast away const
rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(O)", obj));
Py_DECREF(obj);
}
- wxPyEndBlockThreads();
+ wxPyEndBlockThreads(blocked);
return rval;
}
virtual wxString ReadFile(const wxFSFile& file) const {
wxString rval;
bool found;
- wxPyBeginBlockThreads();
+ bool blocked = wxPyBeginBlockThreads();
if ((found = wxPyCBH_findCallback(m_myInst, "ReadFile"))) {
PyObject* obj = wxPyMake_wxObject((wxFSFile*)&file); // cast away const
PyObject* ro;
Py_DECREF(ro);
}
}
- wxPyEndBlockThreads();
+ wxPyEndBlockThreads(blocked);
return rval;
}
// And now the version seen by SWIG
-%name(wxHtmlFilter) class wxPyHtmlFilter : public wxObject {
+%name(HtmlFilter) class wxPyHtmlFilter : public wxObject {
public:
+ %pythonAppend wxPyHtmlFilter "self._setCallbackInfo(self, HtmlFilter)"
wxPyHtmlFilter();
void _setCallbackInfo(PyObject* self, PyObject* _class);
- %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxHtmlFilter)"
};
//---------------------------------------------------------------------------
// wxHtmlWindow
//---------------------------------------------------------------------------
+%newgroup
%{
class wxPyHtmlWindow : public wxHtmlWindow {
void wxPyHtmlWindow::OnLinkClicked(const wxHtmlLinkInfo& link) {
bool found;
- wxPyBeginBlockThreads();
+ bool blocked = wxPyBeginBlockThreads();
if ((found = wxPyCBH_findCallback(m_myInst, "OnLinkClicked"))) {
PyObject* obj = wxPyConstructObject((void*)&link, wxT("wxHtmlLinkInfo"), 0);
wxPyCBH_callCallback(m_myInst, Py_BuildValue("(O)", obj));
Py_DECREF(obj);
}
- wxPyEndBlockThreads();
+ wxPyEndBlockThreads(blocked);
if (! found)
wxHtmlWindow::OnLinkClicked(link);
}
wxString *redirect) const {
bool found;
wxHtmlOpeningStatus rval;
- wxPyBeginBlockThreads();
+ bool blocked = wxPyBeginBlockThreads();
if ((found = wxPyCBH_findCallback(m_myInst, "OnOpeningURL"))) {
PyObject* ro;
PyObject* s = wx2PyString(url);
}
Py_DECREF(ro);
}
- wxPyEndBlockThreads();
+ wxPyEndBlockThreads(blocked);
if (! found)
rval = wxHtmlWindow::OnOpeningURL(type, url, redirect);
return rval;
-%name(wxHtmlWindow) class wxPyHtmlWindow : public wxScrolledWindow {
+%name(HtmlWindow) class wxPyHtmlWindow : public wxScrolledWindow {
public:
+ %pythonAppend wxPyHtmlWindow "self._setCallbackInfo(self, HtmlWindow); self._setOORInfo(self)"
+ %pythonAppend wxPyHtmlWindow() ""
+
wxPyHtmlWindow(wxWindow *parent, int id = -1,
- wxPoint& pos = wxDefaultPosition,
- wxSize& size = wxDefaultSize,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
int style=wxHW_DEFAULT_STYLE,
const wxString& name = wxPyHtmlWindowNameStr);
- %name(wxPreHtmlWindow)wxPyHtmlWindow();
+ %name(PreHtmlWindow)wxPyHtmlWindow();
bool Create(wxWindow *parent, int id = -1,
- wxPoint& pos = wxDefaultPosition,
- wxSize& size = wxDefaultSize,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
int style=wxHW_SCROLLBAR_AUTO,
const wxString& name = wxPyHtmlWindowNameStr);
void _setCallbackInfo(PyObject* self, PyObject* _class);
- %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxHtmlWindow)"
- %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
- %pragma(python) addtomethod = "wxPreHtmlWindow:val._setOORInfo(val)"
+
// Set HTML page and display it. !! source is HTML document itself,
// it is NOT address/filename of HTML document. If you want to
// specify document location, use LoadPage() istead
- // Return value : FALSE if an error occured, TRUE otherwise
+ // Return value : False if an error occured, True otherwise
bool SetPage(const wxString& source);
// Load HTML page from given location. Location can be either
void SetRelatedStatusBar(int bar);
// Sets fonts to be used when displaying HTML page.
- %addmethods {
+ %extend {
void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes=NULL) {
int* temp = NULL;
if (sizes) temp = int_LIST_helper(sizes);
}
}
- void SetTitle(const wxString& title);
+ DocDeclStr(
+ void, SetTitle(const wxString& title),
+ "");
// Sets space between text and window borders.
void SetBorders(int b);
void WriteCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString);
// Goes to previous/next page (in browsing history)
- // Returns TRUE if successful, FALSE otherwise
+ // Returns True if successful, False otherwise
bool HistoryBack();
bool HistoryForward();
bool HistoryCanBack();
//Adds input filter
static void AddFilter(wxPyHtmlFilter *filter);
+ // Helper functions to select parts of page:
+ void SelectWord(const wxPoint& pos);
+ void SelectLine(const wxPoint& pos);
+ void SelectAll();
+
void base_OnLinkClicked(const wxHtmlLinkInfo& link);
void base_OnSetTitle(const wxString& title);
void base_OnCellMouseHover(wxHtmlCell *cell, wxCoord x, wxCoord y);
void base_OnCellClicked(wxHtmlCell *cell,
wxCoord x, wxCoord y,
const wxMouseEvent& event);
+
+ static wxVisualAttributes
+ GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
};
+
//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
+%newgroup
class wxHtmlDCRenderer : public wxObject {
void SetSize(int width, int height);
void SetHtmlText(const wxString& html,
const wxString& basepath = wxPyEmptyString,
- bool isdir = TRUE);
+ bool isdir = True);
// Sets fonts to be used when displaying HTML page. (if size null then default sizes used).
- %addmethods {
+ %extend {
void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes=NULL) {
int* temp = NULL;
if (sizes) temp = int_LIST_helper(sizes);
delete [] temp;
}
}
- int Render(int x, int y, int from = 0, int dont_render = FALSE, int to = INT_MAX,
+ int Render(int x, int y, int from = 0, int dont_render = False, int to = INT_MAX,
//int *known_pagebreaks = NULL, int number_of_pages = 0
int* choices=NULL, int LCOUNT = 0
);
// (compare Render's return value with this)
};
+
enum {
wxPAGE_ODD,
wxPAGE_EVEN,
void SetHtmlText(const wxString& html,
const wxString &basepath = wxPyEmptyString,
- bool isdir = TRUE);
+ bool isdir = True);
void SetHtmlFile(const wxString &htmlfile);
void SetHeader(const wxString& header, int pg = wxPAGE_ALL);
void SetFooter(const wxString& footer, int pg = wxPAGE_ALL);
+
// Sets fonts to be used when displaying HTML page. (if size null then default sizes used).
- %addmethods {
+ %extend {
void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes=NULL) {
int* temp = NULL;
if (sizes) temp = int_LIST_helper(sizes);
void SetHeader(const wxString& header, int pg = wxPAGE_ALL);
void SetFooter(const wxString& footer, int pg = wxPAGE_ALL);
- %addmethods {
+ %extend {
void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes=NULL) {
int* temp = NULL;
if (sizes) temp = int_LIST_helper(sizes);
};
+//---------------------------------------------------------------------------
+//---------------------------------------------------------------------------
+%newgroup
+
+
+class wxHtmlBookRecord {
+public:
+ wxHtmlBookRecord(const wxString& bookfile, const wxString& basepath,
+ const wxString& title, const wxString& start);
+
+ wxString GetBookFile();
+ wxString GetTitle();
+ wxString GetStart();
+ wxString GetBasePath();
+
+ void SetContentsRange(int start, int end);
+ int GetContentsStart();
+ int GetContentsEnd();
+
+ void SetTitle(const wxString& title);
+ void SetBasePath(const wxString& path);
+ void SetStart(const wxString& start);
+
+ wxString GetFullPath(const wxString &page) const;
+};
+
+//---------------------------------------------------------------------------
+
+struct wxHtmlContentsItem
+{
+ %extend {
+ int GetLevel() { return self->m_Level; }
+ int GetID() { return self->m_ID; }
+ wxString GetName() { return self->m_Name; }
+ wxString GetPage() { return self->m_Page; }
+ wxHtmlBookRecord* GetBook() { return self->m_Book; }
+ }
+};
//---------------------------------------------------------------------------
+
+class wxHtmlSearchStatus
+{
+public:
+ //wxHtmlSearchStatus(wxHtmlHelpData* base, const wxString& keyword,
+ // const wxString& book = wxPyEmptyString);
+ bool Search();
+ bool IsActive();
+ int GetCurIndex();
+ int GetMaxIndex();
+ const wxString& GetName();
+ wxHtmlContentsItem* GetContentsItem();
+};
+
//---------------------------------------------------------------------------
-%{
- extern "C" SWIGEXPORT(void) inithtmlhelpc();
-%}
+class wxHtmlHelpData {
+public:
+ wxHtmlHelpData();
+ ~wxHtmlHelpData();
+
+ void SetTempDir(const wxString& path);
+ bool AddBook(const wxString& book);
+// bool AddBookParam(const wxString& title, const wxString& contfile,
+// const wxString& indexfile=wxPyEmptyString,
+// const wxString& deftopic=wxPyEmptyString,
+// const wxString& path=wxPyEmptyString);
+
+ wxString FindPageByName(const wxString& page);
+ wxString FindPageById(int id);
+
+ // TODO: this one needs fixed...
+ const wxHtmlBookRecArray& GetBookRecArray();
+
+ wxHtmlContentsItem* GetContents();
+ int GetContentsCnt();
+ wxHtmlContentsItem* GetIndex();
+ int GetIndexCnt();
+};
+//---------------------------------------------------------------------------
+
+class wxHtmlHelpFrame : public wxFrame {
+public:
+ %pythonAppend wxHtmlHelpFrame "self._setOORInfo(self)"
+
+ wxHtmlHelpFrame(wxWindow* parent, int wxWindowID,
+ const wxString& title = wxPyEmptyString,
+ int style = wxHF_DEFAULTSTYLE, wxHtmlHelpData* data = NULL);
+
+ wxHtmlHelpData* GetData();
+ void SetTitleFormat(const wxString& format);
+ void Display(const wxString& x);
+ %name(DisplayID) void Display(int id);
+ void DisplayContents();
+ void DisplayIndex();
+ bool KeywordSearch(const wxString& keyword);
+ void UseConfig(wxConfigBase *config, const wxString& rootpath = wxPyEmptyString);
+ void ReadCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString);
+ void WriteCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString);
+};
+
+
+//---------------------------------------------------------------------------
+
+
+enum {
+ wxHF_TOOLBAR,
+ wxHF_FLATTOOLBAR,
+ wxHF_CONTENTS,
+ wxHF_INDEX,
+ wxHF_SEARCH,
+ wxHF_BOOKMARKS,
+ wxHF_OPENFILES,
+ wxHF_PRINT,
+ wxHF_DEFAULTSTYLE,
+};
+
+
+class wxHtmlHelpController : public wxEvtHandler {
+public:
+ %pythonAppend wxHtmlHelpController "self._setOORInfo(self)"
+
+ wxHtmlHelpController(int style = wxHF_DEFAULTSTYLE);
+ ~wxHtmlHelpController();
+
+ void SetTitleFormat(const wxString& format);
+ void SetTempDir(const wxString& path);
+ bool AddBook(const wxString& book, int show_wait_msg = False);
+ void Display(const wxString& x);
+ %name(DisplayID) void Display(int id);
+ void DisplayContents();
+ void DisplayIndex();
+ bool KeywordSearch(const wxString& keyword);
+ void UseConfig(wxConfigBase *config, const wxString& rootpath = wxPyEmptyString);
+ void ReadCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString);
+ void WriteCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString);
+ wxHtmlHelpFrame* GetFrame();
+};
-%init %{
- inithtmlhelpc();
- wxClassInfo::CleanUpClasses();
- wxClassInfo::InitializeClasses();
- wxPyPtrTypeMap_Add("wxHtmlTagHandler", "wxPyHtmlTagHandler");
+//---------------------------------------------------------------------------
+%init %{
+ wxPyPtrTypeMap_Add("wxHtmlTagHandler", "wxPyHtmlTagHandler");
wxPyPtrTypeMap_Add("wxHtmlWinTagHandler", "wxPyHtmlWinTagHandler");
- wxPyPtrTypeMap_Add("wxHtmlWindow", "wxPyHtmlWindow");
- wxPyPtrTypeMap_Add("wxHtmlFilter", "wxPyHtmlFilter");
+ wxPyPtrTypeMap_Add("wxHtmlWindow", "wxPyHtmlWindow");
+ wxPyPtrTypeMap_Add("wxHtmlFilter", "wxPyHtmlFilter");
%}
+//---------------------------------------------------------------------------
+//---------------------------------------------------------------------------
-//----------------------------------------------------------------------
-// And this gets appended to the shadow class file.
-//----------------------------------------------------------------------
-%pragma(python) include="_htmlextras.py";
-//---------------------------------------------------------------------------
projects / wxWidgets.git / blobdiff