]> git.saurik.com Git - wxWidgets.git/blobdiff - wxPython/src/gtk/html.py
Version
[wxWidgets.git] / wxPython / src / gtk / html.py
index 08e7c3b0ccc18f773c7e3bf45b2ac06de70b9ee7..9352e9c493ba418d773990bd59e859371f063b88 100644 (file)
@@ -1,8 +1,53 @@
 # This file was created automatically by SWIG.
 # Don't modify this file, modify the SWIG interface instead.
 
+"""
+Classes for a simple HTML rendering window, HTML Help Window, etc.
+"""
+
 import _html
 
+def _swig_setattr_nondynamic(self,class_type,name,value,static=1):
+    if (name == "this"):
+        if isinstance(value, class_type):
+            self.__dict__[name] = value.this
+            if hasattr(value,"thisown"): self.__dict__["thisown"] = value.thisown
+            del value.thisown
+            return
+    method = class_type.__swig_setmethods__.get(name,None)
+    if method: return method(self,value)
+    if (not static) or hasattr(self,name) or (name == "thisown"):
+        self.__dict__[name] = value
+    else:
+        raise AttributeError("You cannot add attributes to %s" % self)
+
+def _swig_setattr(self,class_type,name,value):
+    return _swig_setattr_nondynamic(self,class_type,name,value,0)
+
+def _swig_getattr(self,class_type,name):
+    method = class_type.__swig_getmethods__.get(name,None)
+    if method: return method(self)
+    raise AttributeError,name
+
+import types
+try:
+    _object = types.ObjectType
+    _newclass = 1
+except AttributeError:
+    class _object : pass
+    _newclass = 0
+del types
+
+
+def _swig_setattr_nondynamic_method(set):
+    def set_attr(self,name,value):
+        if hasattr(self,name) or (name in ("this", "thisown")):
+            set(self,name,value)
+        else:
+            raise AttributeError("You cannot add attributes to %s" % self)
+    return set_attr
+
+
 import _windows
 import _core
 wx = _core 
@@ -46,6 +91,7 @@ HTML_URL_PAGE = _html.HTML_URL_PAGE
 HTML_URL_IMAGE = _html.HTML_URL_IMAGE
 HTML_URL_OTHER = _html.HTML_URL_OTHER
 class HtmlLinkInfo(_core.Object):
+    """Proxy of C++ HtmlLinkInfo class"""
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxHtmlLinkInfo instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
@@ -91,6 +137,7 @@ HtmlPrintoutTitleStr = cvar.HtmlPrintoutTitleStr
 HtmlPrintingTitleStr = cvar.HtmlPrintingTitleStr
 
 class HtmlTag(_core.Object):
+    """Proxy of C++ HtmlTag class"""
     def __init__(self): raise RuntimeError, "No constructor defined"
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxHtmlTag instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
@@ -135,6 +182,7 @@ class HtmlTagPtr(HtmlTag):
 _html.HtmlTag_swigregister(HtmlTagPtr)
 
 class HtmlParser(_core.Object):
+    """Proxy of C++ HtmlParser class"""
     def __init__(self): raise RuntimeError, "No constructor defined"
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxHtmlParser instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
@@ -191,6 +239,7 @@ class HtmlParserPtr(HtmlParser):
 _html.HtmlParser_swigregister(HtmlParserPtr)
 
 class HtmlWinParser(HtmlParser):
+    """Proxy of C++ HtmlWinParser class"""
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxHtmlWinParser instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
@@ -223,6 +272,10 @@ class HtmlWinParser(HtmlParser):
         """SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None)"""
         return _html.HtmlWinParser_SetFonts(*args, **kwargs)
 
+    def SetStandardFonts(*args, **kwargs):
+        """SetStandardFonts(self, int size=-1, String normal_face=EmptyString, String fixed_face=EmptyString)"""
+        return _html.HtmlWinParser_SetStandardFonts(*args, **kwargs)
+
     def GetContainer(*args, **kwargs):
         """GetContainer(self) -> HtmlContainerCell"""
         return _html.HtmlWinParser_GetContainer(*args, **kwargs)
@@ -303,6 +356,9 @@ class HtmlWinParser(HtmlParser):
         """SetActualColor(self, Colour clr)"""
         return _html.HtmlWinParser_SetActualColor(*args, **kwargs)
 
+    GetActualColour = GetActualColor
+    SetActualColour = SetActualColor
+
     def SetLink(*args, **kwargs):
         """SetLink(self, String link)"""
         return _html.HtmlWinParser_SetLink(*args, **kwargs)
@@ -324,6 +380,7 @@ class HtmlWinParserPtr(HtmlWinParser):
 _html.HtmlWinParser_swigregister(HtmlWinParserPtr)
 
 class HtmlTagHandler(_core.Object):
+    """Proxy of C++ HtmlTagHandler class"""
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxPyHtmlTagHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
@@ -359,6 +416,7 @@ class HtmlTagHandlerPtr(HtmlTagHandler):
 _html.HtmlTagHandler_swigregister(HtmlTagHandlerPtr)
 
 class HtmlWinTagHandler(HtmlTagHandler):
+    """Proxy of C++ HtmlWinTagHandler class"""
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxPyHtmlWinTagHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
@@ -400,6 +458,7 @@ def HtmlWinParser_AddTagHandler(*args, **kwargs):
 #---------------------------------------------------------------------------
 
 class HtmlSelection(object):
+    """Proxy of C++ HtmlSelection class"""
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxHtmlSelection instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
@@ -474,6 +533,7 @@ HTML_SEL_OUT = _html.HTML_SEL_OUT
 HTML_SEL_IN = _html.HTML_SEL_IN
 HTML_SEL_CHANGING = _html.HTML_SEL_CHANGING
 class HtmlRenderingState(object):
+    """Proxy of C++ HtmlRenderingState class"""
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxHtmlRenderingState instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
@@ -521,6 +581,7 @@ class HtmlRenderingStatePtr(HtmlRenderingState):
 _html.HtmlRenderingState_swigregister(HtmlRenderingStatePtr)
 
 class HtmlRenderingStyle(object):
+    """Proxy of C++ HtmlRenderingStyle class"""
     def __init__(self): raise RuntimeError, "No constructor defined"
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxHtmlRenderingStyle instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
@@ -541,6 +602,7 @@ class HtmlRenderingStylePtr(HtmlRenderingStyle):
 _html.HtmlRenderingStyle_swigregister(HtmlRenderingStylePtr)
 
 class DefaultHtmlRenderingStyle(HtmlRenderingStyle):
+    """Proxy of C++ DefaultHtmlRenderingStyle class"""
     def __init__(self): raise RuntimeError, "No constructor defined"
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxDefaultHtmlRenderingStyle instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
@@ -561,6 +623,7 @@ class DefaultHtmlRenderingStylePtr(DefaultHtmlRenderingStyle):
 _html.DefaultHtmlRenderingStyle_swigregister(DefaultHtmlRenderingStylePtr)
 
 class HtmlRenderingInfo(object):
+    """Proxy of C++ HtmlRenderingInfo class"""
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxHtmlRenderingInfo instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
@@ -609,6 +672,7 @@ HTML_FIND_EXACT = _html.HTML_FIND_EXACT
 HTML_FIND_NEAREST_BEFORE = _html.HTML_FIND_NEAREST_BEFORE
 HTML_FIND_NEAREST_AFTER = _html.HTML_FIND_NEAREST_AFTER
 class HtmlCell(_core.Object):
+    """Proxy of C++ HtmlCell class"""
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxHtmlCell instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
@@ -758,6 +822,7 @@ class HtmlCellPtr(HtmlCell):
 _html.HtmlCell_swigregister(HtmlCellPtr)
 
 class HtmlWordCell(HtmlCell):
+    """Proxy of C++ HtmlWordCell class"""
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxHtmlWordCell instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
@@ -775,6 +840,7 @@ class HtmlWordCellPtr(HtmlWordCell):
 _html.HtmlWordCell_swigregister(HtmlWordCellPtr)
 
 class HtmlContainerCell(HtmlCell):
+    """Proxy of C++ HtmlContainerCell class"""
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxHtmlContainerCell instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
@@ -856,6 +922,7 @@ class HtmlContainerCellPtr(HtmlContainerCell):
 _html.HtmlContainerCell_swigregister(HtmlContainerCellPtr)
 
 class HtmlColourCell(HtmlCell):
+    """Proxy of C++ HtmlColourCell class"""
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxHtmlColourCell instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
@@ -873,6 +940,7 @@ class HtmlColourCellPtr(HtmlColourCell):
 _html.HtmlColourCell_swigregister(HtmlColourCellPtr)
 
 class HtmlFontCell(HtmlCell):
+    """Proxy of C++ HtmlFontCell class"""
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxHtmlFontCell instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
@@ -890,6 +958,7 @@ class HtmlFontCellPtr(HtmlFontCell):
 _html.HtmlFontCell_swigregister(HtmlFontCellPtr)
 
 class HtmlWidgetCell(HtmlCell):
+    """Proxy of C++ HtmlWidgetCell class"""
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxHtmlWidgetCell instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
@@ -909,6 +978,7 @@ _html.HtmlWidgetCell_swigregister(HtmlWidgetCellPtr)
 #---------------------------------------------------------------------------
 
 class HtmlFilter(_core.Object):
+    """Proxy of C++ HtmlFilter class"""
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxPyHtmlFilter instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
@@ -934,6 +1004,7 @@ _html.HtmlFilter_swigregister(HtmlFilterPtr)
 #---------------------------------------------------------------------------
 
 class HtmlWindow(_windows.ScrolledWindow):
+    """Proxy of C++ HtmlWindow class"""
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxPyHtmlWindow instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
@@ -1004,6 +1075,10 @@ class HtmlWindow(_windows.ScrolledWindow):
         """SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None)"""
         return _html.HtmlWindow_SetFonts(*args, **kwargs)
 
+    def SetStandardFonts(*args, **kwargs):
+        """SetStandardFonts(self, int size=-1, String normal_face=EmptyString, String fixed_face=EmptyString)"""
+        return _html.HtmlWindow_SetStandardFonts(*args, **kwargs)
+
     def SetTitle(*args, **kwargs):
         """SetTitle(self, String title)"""
         return _html.HtmlWindow_SetTitle(*args, **kwargs)
@@ -1073,6 +1148,14 @@ class HtmlWindow(_windows.ScrolledWindow):
         """SelectAll(self)"""
         return _html.HtmlWindow_SelectAll(*args, **kwargs)
 
+    def SelectionToText(*args, **kwargs):
+        """SelectionToText(self) -> String"""
+        return _html.HtmlWindow_SelectionToText(*args, **kwargs)
+
+    def ToText(*args, **kwargs):
+        """ToText(self) -> String"""
+        return _html.HtmlWindow_ToText(*args, **kwargs)
+
     def base_OnLinkClicked(*args, **kwargs):
         """base_OnLinkClicked(self, HtmlLinkInfo link)"""
         return _html.HtmlWindow_base_OnLinkClicked(*args, **kwargs)
@@ -1089,6 +1172,24 @@ class HtmlWindow(_windows.ScrolledWindow):
         """base_OnCellClicked(self, HtmlCell cell, int x, int y, MouseEvent event)"""
         return _html.HtmlWindow_base_OnCellClicked(*args, **kwargs)
 
+    def GetClassDefaultAttributes(*args, **kwargs):
+        """
+        GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+        Get the default attributes for this class.  This is useful if you want
+        to use the same font or colour in your own control as in a standard
+        control -- which is a much better idea than hard coding specific
+        colours or fonts which might look completely out of place on the
+        user's system, especially if it uses themes.
+
+        The variant parameter is only relevant under Mac currently and is
+        ignore under other platforms. Under Mac, it will change the size of
+        the returned font. See `wx.Window.SetWindowVariant` for more about
+        this.
+        """
+        return _html.HtmlWindow_GetClassDefaultAttributes(*args, **kwargs)
+
+    GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
 
 class HtmlWindowPtr(HtmlWindow):
     def __init__(self, this):
@@ -1107,9 +1208,27 @@ def HtmlWindow_AddFilter(*args, **kwargs):
     """HtmlWindow_AddFilter(HtmlFilter filter)"""
     return _html.HtmlWindow_AddFilter(*args, **kwargs)
 
+def HtmlWindow_GetClassDefaultAttributes(*args, **kwargs):
+    """
+    HtmlWindow_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
+
+    Get the default attributes for this class.  This is useful if you want
+    to use the same font or colour in your own control as in a standard
+    control -- which is a much better idea than hard coding specific
+    colours or fonts which might look completely out of place on the
+    user's system, especially if it uses themes.
+
+    The variant parameter is only relevant under Mac currently and is
+    ignore under other platforms. Under Mac, it will change the size of
+    the returned font. See `wx.Window.SetWindowVariant` for more about
+    this.
+    """
+    return _html.HtmlWindow_GetClassDefaultAttributes(*args, **kwargs)
+
 #---------------------------------------------------------------------------
 
 class HtmlDCRenderer(_core.Object):
+    """Proxy of C++ HtmlDCRenderer class"""
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxHtmlDCRenderer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
@@ -1140,9 +1259,13 @@ class HtmlDCRenderer(_core.Object):
         """SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None)"""
         return _html.HtmlDCRenderer_SetFonts(*args, **kwargs)
 
+    def SetStandardFonts(*args, **kwargs):
+        """SetStandardFonts(self, int size=-1, String normal_face=EmptyString, String fixed_face=EmptyString)"""
+        return _html.HtmlDCRenderer_SetStandardFonts(*args, **kwargs)
+
     def Render(*args, **kwargs):
         """
-        Render(self, int x, int y, int from=0, int dont_render=False, int to=INT_MAX, 
+        Render(self, int x, int y, int from=0, int dont_render=False, int maxHeight=INT_MAX, 
             int choices=None, int LCOUNT=0) -> int
         """
         return _html.HtmlDCRenderer_Render(*args, **kwargs)
@@ -1163,6 +1286,7 @@ PAGE_ODD = _html.PAGE_ODD
 PAGE_EVEN = _html.PAGE_EVEN
 PAGE_ALL = _html.PAGE_ALL
 class HtmlPrintout(_windows.Printout):
+    """Proxy of C++ HtmlPrintout class"""
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxHtmlPrintout instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
@@ -1191,6 +1315,10 @@ class HtmlPrintout(_windows.Printout):
         """SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None)"""
         return _html.HtmlPrintout_SetFonts(*args, **kwargs)
 
+    def SetStandardFonts(*args, **kwargs):
+        """SetStandardFonts(self, int size=-1, String normal_face=EmptyString, String fixed_face=EmptyString)"""
+        return _html.HtmlPrintout_SetStandardFonts(*args, **kwargs)
+
     def SetMargins(*args, **kwargs):
         """
         SetMargins(self, float top=25.2, float bottom=25.2, float left=25.2, 
@@ -1225,6 +1353,7 @@ def HtmlPrintout_CleanUpStatics(*args, **kwargs):
     return _html.HtmlPrintout_CleanUpStatics(*args, **kwargs)
 
 class HtmlEasyPrinting(_core.Object):
+    """Proxy of C++ HtmlEasyPrinting class"""
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxHtmlEasyPrinting instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
@@ -1255,10 +1384,6 @@ class HtmlEasyPrinting(_core.Object):
         """PrintText(self, String htmltext, String basepath=EmptyString)"""
         return _html.HtmlEasyPrinting_PrintText(*args, **kwargs)
 
-    def PrinterSetup(*args, **kwargs):
-        """PrinterSetup(self)"""
-        return _html.HtmlEasyPrinting_PrinterSetup(*args, **kwargs)
-
     def PageSetup(*args, **kwargs):
         """PageSetup(self)"""
         return _html.HtmlEasyPrinting_PageSetup(*args, **kwargs)
@@ -1275,6 +1400,10 @@ class HtmlEasyPrinting(_core.Object):
         """SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None)"""
         return _html.HtmlEasyPrinting_SetFonts(*args, **kwargs)
 
+    def SetStandardFonts(*args, **kwargs):
+        """SetStandardFonts(self, int size=-1, String normal_face=EmptyString, String fixed_face=EmptyString)"""
+        return _html.HtmlEasyPrinting_SetStandardFonts(*args, **kwargs)
+
     def GetPrintData(*args, **kwargs):
         """GetPrintData(self) -> PrintData"""
         return _html.HtmlEasyPrinting_GetPrintData(*args, **kwargs)
@@ -1294,6 +1423,7 @@ _html.HtmlEasyPrinting_swigregister(HtmlEasyPrintingPtr)
 #---------------------------------------------------------------------------
 
 class HtmlBookRecord(object):
+    """Proxy of C++ HtmlBookRecord class"""
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxHtmlBookRecord instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
@@ -1355,6 +1485,7 @@ class HtmlBookRecordPtr(HtmlBookRecord):
 _html.HtmlBookRecord_swigregister(HtmlBookRecordPtr)
 
 class HtmlContentsItem(object):
+    """Proxy of C++ HtmlContentsItem class"""
     def __init__(self): raise RuntimeError, "No constructor defined"
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxHtmlContentsItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
@@ -1387,6 +1518,7 @@ class HtmlContentsItemPtr(HtmlContentsItem):
 _html.HtmlContentsItem_swigregister(HtmlContentsItemPtr)
 
 class HtmlSearchStatus(object):
+    """Proxy of C++ HtmlSearchStatus class"""
     def __init__(self): raise RuntimeError, "No constructor defined"
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxHtmlSearchStatus instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
@@ -1423,6 +1555,7 @@ class HtmlSearchStatusPtr(HtmlSearchStatus):
 _html.HtmlSearchStatus_swigregister(HtmlSearchStatusPtr)
 
 class HtmlHelpData(object):
+    """Proxy of C++ HtmlHelpData class"""
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxHtmlHelpData instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
@@ -1482,6 +1615,7 @@ class HtmlHelpDataPtr(HtmlHelpData):
 _html.HtmlHelpData_swigregister(HtmlHelpDataPtr)
 
 class HtmlHelpFrame(_windows.Frame):
+    """Proxy of C++ HtmlHelpFrame class"""
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxHtmlHelpFrame instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
@@ -1552,7 +1686,8 @@ HF_BOOKMARKS = _html.HF_BOOKMARKS
 HF_OPENFILES = _html.HF_OPENFILES
 HF_PRINT = _html.HF_PRINT
 HF_DEFAULTSTYLE = _html.HF_DEFAULTSTYLE
-class HtmlHelpController(_core.EvtHandler):
+class HtmlHelpController(_core.Object):
+    """Proxy of C++ HtmlHelpController class"""
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxHtmlHelpController instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
@@ -1561,8 +1696,6 @@ class HtmlHelpController(_core.EvtHandler):
         self.this = newobj.this
         self.thisown = 1
         del newobj.thisown
-        self._setOORInfo(self)
-
     def __del__(self, destroy=_html.delete_HtmlHelpController):
         """__del__(self)"""
         try: