.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.HTMLDataObject:
==========================================================================================================================================
|phoenix_title| **wx.HTMLDataObject**
==========================================================================================================================================
:ref:`wx.HTMLDataObject` is used for working with HTML-formatted text.
.. seealso:: :ref:`wx.DataObject`, :ref:`wx.DataObjectSimple`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
HTMLDataObject:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.HTMLDataObject.__init__` Constructor.
:meth:`~wx.HTMLDataObject.GetAllFormats` Returns a list of wx.DataFormat objects which this data object
:meth:`~wx.HTMLDataObject.GetHTML` Returns the HTML string.
:meth:`~wx.HTMLDataObject.SetData`
:meth:`~wx.HTMLDataObject.SetHTML` Sets the HTML string.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.HTMLDataObject.AllFormats` See :meth:`~wx.HTMLDataObject.GetAllFormats`
:attr:`~wx.HTMLDataObject.HTML` See :meth:`~wx.HTMLDataObject.GetHTML` and :meth:`~wx.HTMLDataObject.SetHTML`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.HTMLDataObject(DataObjectSimple)
**Possible constructors**::
HTMLDataObject(html: str='') -> None
HTMLDataObject is used for working with HTML-formatted text.
.. method:: __init__(self, html: str='')
Constructor.
:param `html`:
:type `html`: string
:rtype: `None`
.. method:: GetAllFormats(self, dir=DataObject.Get)
Returns a list of wx.DataFormat objects which this data object
supports transferring in the given direction.
.. method:: GetHTML(self)
Returns the HTML string.
:rtype: `str`
.. method:: SetData(self, format: DataFormat, buf: PyBuffer)
:rtype: `bool`
.. method:: SetHTML(self, html : str)
Sets the HTML string.
:param `html`:
:type `html`: string
:rtype: `None`
.. attribute:: AllFormats
See :meth:`~wx.HTMLDataObject.GetAllFormats`
.. attribute:: HTML
See :meth:`~wx.HTMLDataObject.GetHTML` and :meth:`~wx.HTMLDataObject.SetHTML`