.. 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.html.HtmlRenderingState:
==========================================================================================================================================
|phoenix_title| **wx.html.HtmlRenderingState**
==========================================================================================================================================
Selection state is passed to :meth:`wx.html.HtmlCell.Draw` so that it can render itself differently e.g.
when inside text selection or outside it.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
HtmlRenderingState:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.html.HtmlRenderingState.__init__`
:meth:`~wx.html.HtmlRenderingState.GetBgColour`
:meth:`~wx.html.HtmlRenderingState.GetBgMode`
:meth:`~wx.html.HtmlRenderingState.GetFgColour`
:meth:`~wx.html.HtmlRenderingState.GetSelectionState`
:meth:`~wx.html.HtmlRenderingState.SetBgColour`
:meth:`~wx.html.HtmlRenderingState.SetBgMode`
:meth:`~wx.html.HtmlRenderingState.SetFgColour`
:meth:`~wx.html.HtmlRenderingState.SetSelectionState`
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.html.HtmlRenderingState.BgColour` See :meth:`~wx.html.HtmlRenderingState.GetBgColour` and :meth:`~wx.html.HtmlRenderingState.SetBgColour`
:attr:`~wx.html.HtmlRenderingState.BgMode` See :meth:`~wx.html.HtmlRenderingState.GetBgMode` and :meth:`~wx.html.HtmlRenderingState.SetBgMode`
:attr:`~wx.html.HtmlRenderingState.FgColour` See :meth:`~wx.html.HtmlRenderingState.GetFgColour` and :meth:`~wx.html.HtmlRenderingState.SetFgColour`
:attr:`~wx.html.HtmlRenderingState.SelectionState` See :meth:`~wx.html.HtmlRenderingState.GetSelectionState` and :meth:`~wx.html.HtmlRenderingState.SetSelectionState`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.html.HtmlRenderingState(object)
**Possible constructors**::
HtmlRenderingState() -> None
Selection state is passed to `HtmlCell.Draw` so that it can render
itself differently e.g.
.. method:: __init__(self)
:rtype: `None`
.. method:: GetBgColour(self)
:rtype: `Colour`
.. method:: GetBgMode(self)
:rtype: `int`
.. method:: GetFgColour(self)
:rtype: `Colour`
.. method:: GetSelectionState(self)
:rtype: :ref:`wx.html.HtmlSelectionState`
.. method:: SetBgColour(self, c : Colour)
:param `c`:
:type `c`: wx.Colour
:rtype: `None`
.. method:: SetBgMode(self, m : int)
:param `m`:
:type `m`: int
:rtype: `None`
.. method:: SetFgColour(self, c : Colour)
:param `c`:
:type `c`: wx.Colour
:rtype: `None`
.. method:: SetSelectionState(self, s : HtmlSelectionState)
:param `s`:
:type `s`: wx.html.HtmlSelectionState
:rtype: `None`
.. attribute:: BgColour
See :meth:`~wx.html.HtmlRenderingState.GetBgColour` and :meth:`~wx.html.HtmlRenderingState.SetBgColour`
.. attribute:: BgMode
See :meth:`~wx.html.HtmlRenderingState.GetBgMode` and :meth:`~wx.html.HtmlRenderingState.SetBgMode`
.. attribute:: FgColour
See :meth:`~wx.html.HtmlRenderingState.GetFgColour` and :meth:`~wx.html.HtmlRenderingState.SetFgColour`
.. attribute:: SelectionState
See :meth:`~wx.html.HtmlRenderingState.GetSelectionState` and :meth:`~wx.html.HtmlRenderingState.SetSelectionState`