//
// 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
/////////////////////////////////////////////////////////////////////////////
+%define DOCSTRING
+"Classes for a simple HTML rendering window, HTML Help Window, etc."
+%enddef
-%module html
+%module(package="wx", docstring=DOCSTRING) html
%{
-#include "export.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/html/helpctrl.h>
-#include "printfw.h"
%}
+
//---------------------------------------------------------------------------
-%include typemaps.i
-%include my_typemaps.i
+%import windows.i
+%pythoncode { wx = _core }
+%pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
-%extern wx.i
-%extern windows.i
-%extern _defs.i
-%extern events.i
-%extern controls.i
-%extern controls2.i
-%extern printfw.i
+%include _html_rename.i
-%extern utils.i
-%pragma(python) code = "import wx"
+MAKE_CONST_WXSTRING_NOSWIG(EmptyString);
+MAKE_CONST_WXSTRING2(HtmlWindowNameStr, wxT("htmlWindow"))
+MAKE_CONST_WXSTRING2(HtmlPrintoutTitleStr, wxT("Printout"))
+MAKE_CONST_WXSTRING2(HtmlPrintingTitleStr, wxT("Printing"))
+// 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,
+};
+
+
+enum {
+ wxHW_SCROLLBAR_NEVER,
+ wxHW_SCROLLBAR_AUTO,
+ wxHW_NO_SELECTION,
+ wxHW_DEFAULT_STYLE,
+};
+
+
+// enums for wxHtmlWindow::OnOpeningURL
+enum wxHtmlOpeningStatus
+{
+ wxHTML_OPEN,
+ wxHTML_BLOCK,
+ wxHTML_REDIRECT
+};
+
+enum wxHtmlURLType
+{
+ wxHTML_URL_PAGE,
+ wxHTML_URL_IMAGE,
+ wxHTML_URL_OTHER
};
+
//---------------------------------------------------------------------------
class wxHtmlLinkInfo : public wxObject {
public:
- wxHtmlLinkInfo(const wxString& href, const wxString& target = wxEmptyString);
+ wxHtmlLinkInfo(const wxString& href, const wxString& target = wxPyEmptyString);
wxString GetHref();
wxString GetTarget();
wxMouseEvent* GetEvent();
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 {
void InitParser(const wxString& source);
void DoneParser();
void DoParsing(int begin_pos, int end_pos);
+ void StopParsing();
// wxObject* GetProduct();
+
void AddTagHandler(wxHtmlTagHandler *handler);
wxString* GetSource();
void PushTagHandler(wxHtmlTagHandler* handler, wxString tags);
void PopTagHandler();
+ // virtual wxFSFile *OpenURL(wxHtmlURLType type, const wxString& url) const;
// void AddText(const char* txt) = 0;
// void AddTag(const wxHtmlTag& tag);
class wxHtmlWinParser : public wxHtmlParser {
public:
- wxHtmlWinParser(wxWindow *wnd);
+ wxHtmlWinParser(wxPyHtmlWindow *wnd = NULL);
void SetDC(wxDC *dc);
wxDC* GetDC();
int GetCharHeight();
int GetCharWidth();
- wxWindow* GetWindow();
- //void SetFonts(wxString normal_face, wxString fixed_face, int *LIST);
- %addmethods {
- void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes) {
- int* temp = int_LIST_helper(sizes);
- if (temp) {
- self->SetFonts(normal_face, fixed_face, temp);
+ wxPyHtmlWindow* GetWindow();
+
+ // Sets fonts to be used when displaying HTML page. (if size null then default sizes used).
+ %extend {
+ void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes=NULL) {
+ int* temp = NULL;
+ if (sizes) temp = int_LIST_helper(sizes);
+ self->SetFonts(normal_face, fixed_face, temp);
+ if (temp)
delete [] temp;
- }
}
}
+ // Sets font sizes to be relative to the given size or the system
+ // default size; use either specified or default font
+ void SetStandardFonts(int size = -1,
+ const wxString& normal_face = wxPyEmptyString,
+ const wxString& fixed_face = wxPyEmptyString);
+
+
wxHtmlContainerCell* GetContainer();
wxHtmlContainerCell* OpenContainer();
wxHtmlContainerCell *SetContainer(wxHtmlContainerCell *c);
void SetFontFixed(int x);
int GetAlign();
void SetAlign(int a);
- const wxColour& GetLinkColor();
+ wxColour GetLinkColor();
void SetLinkColor(const wxColour& clr);
- const wxColour& GetActualColor();
+ wxColour GetActualColor();
void SetActualColor(const wxColour& clr);
+ %pythoncode {
+ GetActualColour = GetActualColor
+ SetActualColour = SetActualColor
+ }
void SetLink(const wxString& link);
wxFont* CreateCurrentFont();
wxHtmlLinkInfo GetLink();
};
-
//---------------------------------------------------------------------------
%{
%}
-%name(wxHtmlTagHandler) class wxPyHtmlTagHandler : public wxObject {
+%rename(HtmlTagHandler) wxPyHtmlTagHandler;
+class wxPyHtmlTagHandler : public wxObject {
public:
+ %pythonAppend wxPyHtmlTagHandler "self._setCallbackInfo(self, HtmlTagHandler)"
wxPyHtmlTagHandler();
- void _setSelf(PyObject* self, PyObject* _class);
- %pragma(python) addtomethod = "__init__:self._setSelf(self, wxHtmlTagHandler)"
+ void _setCallbackInfo(PyObject* self, PyObject* _class);
void SetParser(wxHtmlParser *parser);
wxHtmlParser* GetParser();
%}
-%name(wxHtmlWinTagHandler) class wxPyHtmlWinTagHandler : public wxPyHtmlTagHandler {
+%rename(HtmlWinTagHandler) wxPyHtmlWinTagHandler;
+class wxPyHtmlWinTagHandler : public wxPyHtmlTagHandler {
public:
+ %pythonAppend wxPyHtmlWinTagHandler "self._setCallbackInfo(self, HtmlWinTagHandler)"
wxPyHtmlWinTagHandler();
- void _setSelf(PyObject* self, PyObject* _class);
- %pragma(python) addtomethod = "__init__:self._setSelf(self, wxHtmlWinTagHandler)"
+ void _setCallbackInfo(PyObject* self, PyObject* _class);
void SetParser(wxHtmlParser *parser);
wxHtmlWinParser* GetParser();
}
void OnExit() {
- bool doSave = wxPyRestoreThread();
+ wxPyBlock_t 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);
}
- wxPySaveThread(doSave);
+ 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
- bool doSave = wxPyRestoreThread();
- PyObject* arg = Py_BuildValue("()");
- PyObject* obj = PyInstance_New(m_tagHandlerClass, arg, NULL);
+ wxPyBlock_t blocked = wxPyBeginBlockThreads();
+ PyObject* arg = PyTuple_New(0);
+ PyObject* obj = PyObject_CallObject(m_tagHandlerClass, arg);
Py_DECREF(arg);
- wxPySaveThread(doSave);
-
+
// 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.
+// Selection is defined by two positions (beginning and end of the selection)
+// and two leaf(!) cells at these positions.
+class wxHtmlSelection
+{
+public:
+ wxHtmlSelection();
+ ~wxHtmlSelection();
+
+ void Set(const wxPoint& fromPos, const wxHtmlCell *fromCell,
+ const wxPoint& toPos, const wxHtmlCell *toCell);
+ %Rename(SetCells, void, Set(const wxHtmlCell *fromCell, const wxHtmlCell *toCell));
+
+ const wxHtmlCell *GetFromCell() const;
+ const wxHtmlCell *GetToCell() const;
+
+ // these values are in absolute coordinates:
+ const wxPoint& GetFromPos() const;
+ const wxPoint& GetToPos() const;
+
+ // these are From/ToCell's private data
+ const wxPoint& GetFromPrivPos() const;
+ const wxPoint& GetToPrivPos() const;
+ void SetFromPrivPos(const wxPoint& pos);
+ void SetToPrivPos(const wxPoint& pos);
+ void ClearPrivPos();
+
+ const bool IsEmpty() const;
+
+};
+
+
+enum wxHtmlSelectionState
+{
+ wxHTML_SEL_OUT, // currently rendered cell is outside the selection
+ wxHTML_SEL_IN, // ... is inside 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
+{
+public:
+ wxHtmlRenderingState();
+ ~wxHtmlRenderingState();
+
+ void SetSelectionState(wxHtmlSelectionState s);
+ wxHtmlSelectionState GetSelectionState() const;
+
+ void SetFgColour(const wxColour& c);
+ const wxColour& GetFgColour() const;
+ void SetBgColour(const wxColour& c);
+ const wxColour& GetBgColour() const;
+};
+
+
+
+// HTML rendering customization. This class is used when rendering wxHtmlCells
+// as a callback:
+class wxHtmlRenderingStyle
+{
+public:
+ virtual wxColour GetSelectedTextColour(const wxColour& clr) = 0;
+ virtual wxColour GetSelectedTextBgColour(const wxColour& clr) = 0;
+};
+
+// Standard style:
+class wxDefaultHtmlRenderingStyle : public wxHtmlRenderingStyle
+{
+public:
+ virtual wxColour GetSelectedTextColour(const wxColour& clr);
+ virtual wxColour GetSelectedTextBgColour(const wxColour& clr);
+};
+
+
+
+// Information given to cells when drawing them. Contains rendering state,
+// selection information and rendering style object that can be used to
+// customize the output.
+class wxHtmlRenderingInfo
+{
+public:
+ wxHtmlRenderingInfo();
+ ~wxHtmlRenderingInfo();
+
+ void SetSelection(wxHtmlSelection *s);
+ wxHtmlSelection *GetSelection() const;
+
+ void SetStyle(wxHtmlRenderingStyle *style);
+ wxHtmlRenderingStyle& GetStyle();
+
+ wxHtmlRenderingState& GetState();
+};
+
+//---------------------------------------------------------------------------
+%newgroup
+
+
+enum
+{
+ wxHTML_FIND_EXACT = 1,
+ wxHTML_FIND_NEAREST_BEFORE = 2,
+ wxHTML_FIND_NEAREST_AFTER = 4
+};
+
class wxHtmlCell : public wxObject {
public:
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();
+ wxHtmlCell* GetFirstChild() const;
+
+ // Returns cursor to be used when mouse is over the cell:
+ wxCursor GetCursor() const;
+
+ // Formatting cells are not visible on the screen, they only alter
+ // renderer's state.
+ bool IsFormattingCell() const;
+
+
void SetLink(const wxHtmlLinkInfo& link);
void SetNext(wxHtmlCell *cell);
void SetParent(wxHtmlContainerCell *p);
void SetPos(int x, int y);
void Layout(int w);
- void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2);
- void DrawInvisible(wxDC& dc, int x, int y);
+ void Draw(wxDC& dc, int x, int y, int view_y1, int view_y2,
+ wxHtmlRenderingInfo& info);
+ void DrawInvisible(wxDC& dc, int x, int y,
+ wxHtmlRenderingInfo& info);
const wxHtmlCell* Find(int condition, const void* param);
- bool AdjustPagebreak(int * pagebreak);
+ bool AdjustPagebreak(int* INOUT);
void SetCanLiveOnPagebreak(bool can);
+ // Can the line be broken before this cell?
+ bool IsLinebreakAllowed() const;
+
+ // 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;
+
+ // Find a cell inside this cell positioned at the given coordinates
+ // (relative to this's positions). Returns NULL if no such cell exists.
+ // The flag can be used to specify whether to look for terminal or
+ // nonterminal cells or both. In either case, returned cell is deepest
+ // cell in cells tree that contains [x,y].
+ wxHtmlCell *FindCellByPos(wxCoord x, wxCoord y,
+ unsigned flags = wxHTML_FIND_EXACT) const;
+
+ // Returns absolute position of the cell on HTML canvas
+ wxPoint GetAbsPos() const;
+
+ // Returns first (last) terminal cell inside this cell. It may return NULL,
+ // but it is rare -- only if there are no terminals in the tree.
+ wxHtmlCell *GetFirstTerminal() const ;
+ wxHtmlCell *GetLastTerminal() const ;
+
+ // Returns cell's depth, i.e. how far under the root cell it is
+ // (if it is the root, depth is 0)
+ unsigned GetDepth() const;
+
+ // 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.
+ bool IsBefore(wxHtmlCell *cell) const;
+
+ // Converts the cell into text representation. If sel != NULL then
+ // only part of the cell inside the selection is converted.
+ wxString ConvertToText(wxHtmlSelection *sel) const;
};
int GetIndentUnits(int ind);
void SetAlign(const wxHtmlTag& tag);
void SetWidthFloat(int w, int units);
- %name(SetWidthFloatFromTag)void SetWidthFloat(const wxHtmlTag& tag);
+ %Rename(SetWidthFloatFromTag, void, SetWidthFloat(const wxHtmlTag& tag));
void SetMinHeight(int h, int align = wxHTML_ALIGN_TOP);
void SetBackgroundColour(const wxColour& clr);
+ wxColour GetBackgroundColour();
void SetBorder(const wxColour& clr1, const wxColour& clr2);
- wxHtmlCell* GetFirstCell();
+ wxHtmlCell* GetFirstChild();
+ %pragma(python) addtoclass = "GetFirstCell = GetFirstChild"
};
class wxHtmlColourCell : public wxHtmlCell {
public:
- wxHtmlColourCell(wxColour clr, int flags = wxHTML_CLR_FOREGROUND);
+ wxHtmlColourCell(const wxColour& clr, int flags = wxHTML_CLR_FOREGROUND);
};
+
+//---------------------------------------------------------------------------
+// wxHtmlFilter
//---------------------------------------------------------------------------
+%newgroup
+
+
+%{ // here's the C++ version
+class wxPyHtmlFilter : public wxHtmlFilter {
+ DECLARE_ABSTRACT_CLASS(wxPyHtmlFilter);
+public:
+ wxPyHtmlFilter() : wxHtmlFilter() {}
+
+ // returns True if this filter is able to open&read given file
+ virtual bool CanRead(const wxFSFile& file) const {
+ bool rval = false;
+ bool found;
+ wxPyBlock_t blocked = wxPyBeginBlockThreads();
+ if ((found = wxPyCBH_findCallback(m_myInst, "CanRead"))) {
+ PyObject* obj = wxPyMake_wxObject((wxFSFile*)&file,false); // cast away const
+ rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(O)", obj));
+ Py_DECREF(obj);
+ }
+ wxPyEndBlockThreads(blocked);
+ return rval;
+ }
+
+
+ // Reads given file and returns HTML document.
+ // Returns empty string if opening failed
+ virtual wxString ReadFile(const wxFSFile& file) const {
+ wxString rval;
+ bool found;
+ wxPyBlock_t blocked = wxPyBeginBlockThreads();
+ if ((found = wxPyCBH_findCallback(m_myInst, "ReadFile"))) {
+ PyObject* obj = wxPyMake_wxObject((wxFSFile*)&file,false); // cast away const
+ PyObject* ro;
+ ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(O)", obj));
+ Py_DECREF(obj);
+ if (ro) {
+ rval = Py2wxString(ro);
+ Py_DECREF(ro);
+ }
+ }
+ wxPyEndBlockThreads(blocked);
+ return rval;
+ }
+
+ PYPRIVATE;
+};
+
+IMPLEMENT_ABSTRACT_CLASS(wxPyHtmlFilter, wxHtmlFilter);
+%}
+
+
+// And now the version seen by SWIG
+
+%rename(HtmlFilter) wxPyHtmlFilter;
+class wxPyHtmlFilter : public wxObject {
+public:
+ %pythonAppend wxPyHtmlFilter "self._setCallbackInfo(self, HtmlFilter)"
+ wxPyHtmlFilter();
+
+ void _setCallbackInfo(PyObject* self, PyObject* _class);
+};
+
+
+// TODO: wxHtmlFilterHTML
+
+
//---------------------------------------------------------------------------
+// wxHtmlWindow
//---------------------------------------------------------------------------
+%newgroup
%{
class wxPyHtmlWindow : public wxHtmlWindow {
wxPyHtmlWindow(wxWindow *parent, wxWindowID id = -1,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
- long style = wxHW_SCROLLBAR_AUTO,
- const wxString& name = "htmlWindow")
+ long style = wxHW_DEFAULT_STYLE,
+ const wxString& name = wxPyHtmlWindowNameStr)
: wxHtmlWindow(parent, id, pos, size, style, name) {};
+ wxPyHtmlWindow() : wxHtmlWindow() {};
+
+ bool ScrollToAnchor(const wxString& anchor) {
+ return wxHtmlWindow::ScrollToAnchor(anchor);
+ }
+
+ bool HasAnchor(const wxString& anchor) {
+ const wxHtmlCell *c = m_Cell->Find(wxHTML_COND_ISANCHOR, &anchor);
+ return c!=NULL;
+ }
void OnLinkClicked(const wxHtmlLinkInfo& link);
void base_OnLinkClicked(const wxHtmlLinkInfo& link);
+ wxHtmlOpeningStatus OnOpeningURL(wxHtmlURLType type,
+ const wxString& url,
+ wxString *redirect) const;
+
DEC_PYCALLBACK__STRING(OnSetTitle);
+ DEC_PYCALLBACK__CELLINTINT(OnCellMouseHover);
+ DEC_PYCALLBACK__CELLINTINTME(OnCellClicked);
PYPRIVATE;
};
IMPLEMENT_ABSTRACT_CLASS( wxPyHtmlWindow, wxHtmlWindow );
IMP_PYCALLBACK__STRING(wxPyHtmlWindow, wxHtmlWindow, OnSetTitle);
+IMP_PYCALLBACK__CELLINTINT(wxPyHtmlWindow, wxHtmlWindow, OnCellMouseHover);
+IMP_PYCALLBACK__CELLINTINTME(wxPyHtmlWindow, wxHtmlWindow, OnCellClicked);
+
void wxPyHtmlWindow::OnLinkClicked(const wxHtmlLinkInfo& link) {
- bool doSave = wxPyRestoreThread();
- if (wxPyCBH_findCallback(m_myInst, "OnLinkClicked")) {
- PyObject* obj = wxPyConstructObject((void*)&link, "wxHtmlLinkInfo", 0);
+ bool found;
+ wxPyBlock_t 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);
}
- else
+ wxPyEndBlockThreads(blocked);
+ if (! found)
wxHtmlWindow::OnLinkClicked(link);
- wxPySaveThread(doSave);
}
void wxPyHtmlWindow::base_OnLinkClicked(const wxHtmlLinkInfo& link) {
wxHtmlWindow::OnLinkClicked(link);
}
+
+
+wxHtmlOpeningStatus wxPyHtmlWindow::OnOpeningURL(wxHtmlURLType type,
+ const wxString& url,
+ wxString *redirect) const {
+ bool found;
+ wxHtmlOpeningStatus rval;
+ wxPyBlock_t blocked = wxPyBeginBlockThreads();
+ if ((found = wxPyCBH_findCallback(m_myInst, "OnOpeningURL"))) {
+ PyObject* ro;
+ PyObject* s = wx2PyString(url);
+ ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(iO)", type, s));
+ Py_DECREF(s);
+ if (PyString_Check(ro)
+#if PYTHON_API_VERSION >= 1009
+ || PyUnicode_Check(ro)
+#endif
+ ) {
+ *redirect = Py2wxString(ro);
+ rval = wxHTML_REDIRECT;
+ }
+ else {
+ PyObject* num = PyNumber_Int(ro);
+ rval = (wxHtmlOpeningStatus)PyInt_AsLong(num);
+ Py_DECREF(num);
+ }
+ Py_DECREF(ro);
+ }
+ wxPyEndBlockThreads(blocked);
+ if (! found)
+ rval = wxHtmlWindow::OnOpeningURL(type, url, redirect);
+ return rval;
+}
+
+
%}
-%name(wxHtmlWindow) class wxPyHtmlWindow : public wxScrolledWindow {
+MustHaveApp(wxPyHtmlWindow);
+
+%rename(HtmlWindow) wxPyHtmlWindow;
+class wxPyHtmlWindow : public wxScrolledWindow {
public:
+ %pythonAppend wxPyHtmlWindow "self._setCallbackInfo(self, HtmlWindow); self._setOORInfo(self)"
+ %pythonAppend wxPyHtmlWindow() ""
+ %typemap(out) wxPyHtmlWindow*; // turn off this typemap
+
wxPyHtmlWindow(wxWindow *parent, int id = -1,
- wxPoint& pos = wxDefaultPosition,
- wxSize& size = wxDefaultSize,
- int flags=wxHW_SCROLLBAR_AUTO,
- char* name = "htmlWindow");
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ int style=wxHW_DEFAULT_STYLE,
+ const wxString& name = wxPyHtmlWindowNameStr);
+ %RenameCtor(PreHtmlWindow, wxPyHtmlWindow());
+
+ // Turn it back on again
+ %typemap(out) wxPyHtmlWindow* { $result = wxPyMake_wxObject($1, $owner); }
- void _setSelf(PyObject* self, PyObject* _class);
- %pragma(python) addtomethod = "__init__:self._setSelf(self, wxHtmlWindow)"
- %pragma(python) addtomethod = "__init__:#wx._StdWindowCallbacks(self)"
- %pragma(python) addtomethod = "__init__:#wx._StdOnScrollCallbacks(self)"
+ bool Create(wxWindow *parent, int id = -1,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ int style=wxHW_SCROLLBAR_AUTO,
+ const wxString& name = wxPyHtmlWindowNameStr);
+ void _setCallbackInfo(PyObject* self, PyObject* _class);
+
+
+ // 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
bool SetPage(const wxString& source);
+
+ // Load HTML page from given location. Location can be either
+ // a) /usr/wxGTK2/docs/html/wx.htm
+ // b) http://www.somewhere.uk/document.htm
+ // c) ftp://ftp.somesite.cz/pub/something.htm
+ // In case there is no prefix (http:,ftp:), the method
+ // will try to find it itself (1. local file, then http or ftp)
+ // After the page is loaded, the method calls SetPage() to display it.
+ // Note : you can also use path relative to previously loaded page
+ // Return value : same as SetPage
bool LoadPage(const wxString& location);
+
+ // Loads HTML page from file
+ bool LoadFile(const wxString& filename);
+
+ // Append to current page
+ bool AppendToPage(const wxString& source);
+
+ // Returns full location of opened page
wxString GetOpenedPage();
+
+ // Returns anchor within opened page
wxString GetOpenedAnchor();
+
+ // Returns <TITLE> of opened page or empty string otherwise
wxString GetOpenedPageTitle();
- void SetRelatedFrame(wxFrame* frame, const char* format);
+ // Sets frame in which page title will be displayed. Format is format of
+ // frame title, e.g. "HtmlHelp : %s". It must contain exactly one %s
+ void SetRelatedFrame(wxFrame* frame, const wxString& format);
wxFrame* GetRelatedFrame();
+
+ // After(!) calling SetRelatedFrame, this sets statusbar slot where messages
+ // will be displayed. Default is -1 = no messages.
void SetRelatedStatusBar(int bar);
- //void SetFonts(wxString normal_face, wxString fixed_face, int *LIST);
- %addmethods {
- void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes) {
- int* temp = int_LIST_helper(sizes);
- if (temp) {
- self->SetFonts(normal_face, fixed_face, temp);
+ // Sets fonts to be used when displaying HTML page.
+ %extend {
+ void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes=NULL) {
+ int* temp = NULL;
+ if (sizes) temp = int_LIST_helper(sizes);
+ self->SetFonts(normal_face, fixed_face, temp);
+ if (temp)
delete [] temp;
- }
}
}
- void SetTitle(const wxString& title);
+ // Sets font sizes to be relative to the given size or the system
+ // default size; use either specified or default font
+ void SetStandardFonts(int size = -1,
+ const wxString& normal_face = wxPyEmptyString,
+ const wxString& fixed_face = wxPyEmptyString);
+
+ DocDeclStr(
+ void, SetTitle(const wxString& title),
+ "", "");
+
+ // Sets space between text and window borders.
void SetBorders(int b);
- void ReadCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
- void WriteCustomization(wxConfigBase *cfg, wxString path = wxEmptyString);
+
+ // Sets the bitmap to use for background (currnetly it will be tiled,
+ // when/if we have CSS support we could add other possibilities...)
+ void SetBackgroundImage(const wxBitmap& bmpBg);
+
+ // Saves custom settings into cfg config. it will use the path 'path'
+ // if given, otherwise it will save info into currently selected path.
+ // saved values : things set by SetFonts, SetBorders.
+ void ReadCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString);
+ void WriteCustomization(wxConfigBase *cfg, wxString path = wxPyEmptyString);
+
+ // Goes to previous/next page (in browsing history)
+ // Returns True if successful, False otherwise
bool HistoryBack();
bool HistoryForward();
bool HistoryCanBack();
bool HistoryCanForward();
+
+ // Resets History
void HistoryClear();
+
+ // Returns pointer to conteiners/cells structure.
wxHtmlContainerCell* GetInternalRepresentation();
+
+ // Returns a pointer to the parser.
wxHtmlWinParser* GetParser();
+ bool ScrollToAnchor(const wxString& anchor);
+ bool HasAnchor(const wxString& anchor);
+
+ //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();
+
+ // Convert selection to text:
+ wxString SelectionToText();
+
+ // Converts current page to text:
+ wxString ToText();
+
void base_OnLinkClicked(const wxHtmlLinkInfo& link);
- void base_OnSetTitle(const char* title);
+ 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);
};
-// Static methods are mapped to stand-alone functions
-%inline %{
- void wxHtmlWindow_AddFilter(wxHtmlFilter *filter) {
- wxHtmlWindow::AddFilter(filter);
- }
-%}
+
//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
+%newgroup
+
+MustHaveApp(wxHtmlDCRenderer);
class wxHtmlDCRenderer : public wxObject {
public:
void SetDC(wxDC *dc, int maxwidth);
void SetSize(int width, int height);
void SetHtmlText(const wxString& html,
- const wxString& basepath = wxEmptyString,
- bool isdir = TRUE);
- int Render(int x, int y, int from = 0, int dont_render = FALSE);
+ const wxString& basepath = wxPyEmptyString,
+ bool isdir = true);
+ // Sets fonts to be used when displaying HTML page. (if size null then default sizes used).
+ %extend {
+ void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes=NULL) {
+ int* temp = NULL;
+ if (sizes) temp = int_LIST_helper(sizes);
+ self->SetFonts(normal_face, fixed_face, temp);
+ if (temp)
+ delete [] temp;
+ }
+ }
+
+ // Sets font sizes to be relative to the given size or the system
+ // default size; use either specified or default font
+ void SetStandardFonts(int size = -1,
+ const wxString& normal_face = wxPyEmptyString,
+ const wxString& fixed_face = wxPyEmptyString);
+
+ int Render(int x, int y, int from = 0, int dont_render = false, int maxHeight = INT_MAX,
+ //int *known_pagebreaks = NULL, int number_of_pages = 0
+ int* choices=NULL, int LCOUNT = 0
+ );
int GetTotalHeight();
// returns total height of the html document
// (compare Render's return value with this)
};
+
enum {
wxPAGE_ODD,
wxPAGE_EVEN,
};
+MustHaveApp(wxHtmlPrintout);
+
class wxHtmlPrintout : public wxPyPrintout {
public:
- wxHtmlPrintout(const char* title = "Printout");
+ wxHtmlPrintout(const wxString& title = wxPyHtmlPrintoutTitleStr);
//~wxHtmlPrintout(); wxPrintPreview object takes ownership...
void SetHtmlText(const wxString& html,
- const wxString &basepath = wxEmptyString,
- bool isdir = TRUE);
+ const wxString &basepath = wxPyEmptyString,
+ 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).
+ %extend {
+ void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes=NULL) {
+ int* temp = NULL;
+ if (sizes) temp = int_LIST_helper(sizes);
+ self->SetFonts(normal_face, fixed_face, temp);
+ if (temp)
+ delete [] temp;
+ }
+ }
+
+ // Sets font sizes to be relative to the given size or the system
+ // default size; use either specified or default font
+ void SetStandardFonts(int size = -1,
+ const wxString& normal_face = wxPyEmptyString,
+ const wxString& fixed_face = wxPyEmptyString);
+
void SetMargins(float top = 25.2, float bottom = 25.2,
float left = 25.2, float right = 25.2,
float spaces = 5);
+
+ // Adds input filter
+ static void AddFilter(wxHtmlFilter *filter);
+
+ // Cleanup
+ static void CleanUpStatics();
};
+MustHaveApp(wxHtmlEasyPrinting);
+
class wxHtmlEasyPrinting : public wxObject {
public:
- wxHtmlEasyPrinting(const char* name = "Printing",
- wxFrame *parent_frame = NULL);
+ wxHtmlEasyPrinting(const wxString& name = wxPyHtmlPrintingTitleStr,
+ wxWindow *parentWindow = NULL);
~wxHtmlEasyPrinting();
void PreviewFile(const wxString &htmlfile);
- void PreviewText(const wxString &htmltext, const wxString& basepath = wxEmptyString);
+ void PreviewText(const wxString &htmltext, const wxString& basepath = wxPyEmptyString);
void PrintFile(const wxString &htmlfile);
- void PrintText(const wxString &htmltext, const wxString& basepath = wxEmptyString);
- void PrinterSetup();
+ void PrintText(const wxString &htmltext, const wxString& basepath = wxPyEmptyString);
+// void PrinterSetup();
void PageSetup();
void SetHeader(const wxString& header, int pg = wxPAGE_ALL);
void SetFooter(const wxString& footer, int pg = wxPAGE_ALL);
+ %extend {
+ void SetFonts(wxString normal_face, wxString fixed_face, PyObject* sizes=NULL) {
+ int* temp = NULL;
+ if (sizes) temp = int_LIST_helper(sizes);
+ self->SetFonts(normal_face, fixed_face, temp);
+ if (temp)
+ delete [] temp;
+ }
+ }
+
+ // Sets font sizes to be relative to the given size or the system
+ // default size; use either specified or default font
+ void SetStandardFonts(int size = -1,
+ const wxString& normal_face = wxPyEmptyString,
+ const wxString& fixed_face = wxPyEmptyString);
+
wxPrintData *GetPrintData() {return m_PrintData;}
wxPageSetupDialogData *GetPageSetupData() {return m_PageSetupData;}
};
+//---------------------------------------------------------------------------
+//---------------------------------------------------------------------------
+%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; }
+ }
+};
+
//---------------------------------------------------------------------------
-%{
- extern "C" SWIGEXPORT(void) inithtmlhelpc();
-%}
+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();
+};
+//---------------------------------------------------------------------------
-%init %{
+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();
+};
+
+//---------------------------------------------------------------------------
+
+MustHaveApp(wxHtmlHelpFrame);
+
+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);
+ %Rename(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);
+};
+
+
+//---------------------------------------------------------------------------
- inithtmlhelpc();
- wxClassInfo::CleanUpClasses();
- wxClassInfo::InitializeClasses();
+enum {
+ wxHF_TOOLBAR,
+ wxHF_FLATTOOLBAR,
+ wxHF_CONTENTS,
+ wxHF_INDEX,
+ wxHF_SEARCH,
+ wxHF_BOOKMARKS,
+ wxHF_OPENFILES,
+ wxHF_PRINT,
+ wxHF_DEFAULTSTYLE,
+};
+
- wxPyPtrTypeMap_Add("wxHtmlTagHandler", "wxPyHtmlTagHandler");
+MustHaveApp(wxHtmlHelpController);
+
+class wxHtmlHelpController : public wxObject // wxHelpControllerBase
+{
+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);
+ %Rename(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 %{
+ wxPyPtrTypeMap_Add("wxHtmlTagHandler", "wxPyHtmlTagHandler");
wxPyPtrTypeMap_Add("wxHtmlWinTagHandler", "wxPyHtmlWinTagHandler");
- wxPyPtrTypeMap_Add("wxHtmlWindow", "wxPyHtmlWindow");
+ 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