.. 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.richtext.TextAttrDimensions:
==========================================================================================================================================
|phoenix_title| **wx.richtext.TextAttrDimensions**
==========================================================================================================================================
A class for left, right, top and bottom dimensions.
.. seealso:: :ref:`wx.richtext.RichTextAttr`, :ref:`wx.richtext.RichTextCtrl`, :ref:`wx.richtext.TextAttrDimension`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
TextAttrDimensions:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.richtext.TextAttrDimensions.__init__` Default constructor.
:meth:`~wx.richtext.TextAttrDimensions.Apply` Apply to 'this', but not if the same as `compareWith`.
:meth:`~wx.richtext.TextAttrDimensions.CollectCommonAttributes` Collects the attributes that are common to a range of content, building up a note of which attributes are absent in some objects and which clash in some objects.
:meth:`~wx.richtext.TextAttrDimensions.EqPartial` Partial equality test.
:meth:`~wx.richtext.TextAttrDimensions.GetBottom`
:meth:`~wx.richtext.TextAttrDimensions.GetLeft`
:meth:`~wx.richtext.TextAttrDimensions.GetRight`
:meth:`~wx.richtext.TextAttrDimensions.GetTop`
:meth:`~wx.richtext.TextAttrDimensions.IsValid` Are all dimensions valid?
:meth:`~wx.richtext.TextAttrDimensions.RemoveStyle` Remove specified attributes from this object.
:meth:`~wx.richtext.TextAttrDimensions.Reset` Resets the value and flags for all dimensions.
:meth:`~wx.richtext.TextAttrDimensions.__bool__`
:meth:`~wx.richtext.TextAttrDimensions.__nonzero__`
:meth:`~wx.richtext.TextAttrDimensions.__eq__` Equality operator.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.richtext.TextAttrDimensions.Bottom` See :meth:`~wx.richtext.TextAttrDimensions.GetBottom`
:attr:`~wx.richtext.TextAttrDimensions.Left` See :meth:`~wx.richtext.TextAttrDimensions.GetLeft`
:attr:`~wx.richtext.TextAttrDimensions.Right` See :meth:`~wx.richtext.TextAttrDimensions.GetRight`
:attr:`~wx.richtext.TextAttrDimensions.Top` See :meth:`~wx.richtext.TextAttrDimensions.GetTop`
:attr:`~wx.richtext.TextAttrDimensions.m_bottom` A public C++ attribute of type `~wx.richtext.TextAttrDimension` .
:attr:`~wx.richtext.TextAttrDimensions.m_left` A public C++ attribute of type `~wx.richtext.TextAttrDimension` .
:attr:`~wx.richtext.TextAttrDimensions.m_right` A public C++ attribute of type `~wx.richtext.TextAttrDimension` .
:attr:`~wx.richtext.TextAttrDimensions.m_top` A public C++ attribute of type `~wx.richtext.TextAttrDimension` .
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.richtext.TextAttrDimensions(object)
**Possible constructors**::
TextAttrDimensions() -> None
A class for left, right, top and bottom dimensions.
.. method:: __init__(self)
Default constructor.
:rtype: `None`
.. method:: Apply(self, dims : TextAttrDimensions, compareWith: Optional[TextAttrDimensions]=None)
Apply to 'this', but not if the same as `compareWith`.
:param `dims`:
:type `dims`: wx.richtext.TextAttrDimensions
:param `compareWith`:
:type `compareWith`: wx.richtext.TextAttrDimensions
:rtype: `bool`
.. method:: CollectCommonAttributes(self, attr : TextAttrDimensions, clashingAttr : TextAttrDimensions, absentAttr : TextAttrDimensions)
Collects the attributes that are common to a range of content, building up a note of which attributes are absent in some objects and which clash in some objects.
:param `attr`:
:type `attr`: wx.richtext.TextAttrDimensions
:param `clashingAttr`:
:type `clashingAttr`: wx.richtext.TextAttrDimensions
:param `absentAttr`:
:type `absentAttr`: wx.richtext.TextAttrDimensions
:rtype: `None`
.. method:: EqPartial(self, dims : TextAttrDimensions, weakTest: bool=True)
Partial equality test.
If `weakTest` is ``True``, attributes of this object do not have to be present if those attributes of `dims` are present. If `weakTest` is ``False``, the function will fail if an attribute is present in `dims` but not in this object.
:param `dims`:
:type `dims`: wx.richtext.TextAttrDimensions
:param `weakTest`:
:type `weakTest`: bool
:rtype: `bool`
.. method:: GetBottom(self)
:rtype: :ref:`wx.richtext.TextAttrDimension`
.. method:: GetLeft(self)
:rtype: :ref:`wx.richtext.TextAttrDimension`
.. method:: GetRight(self)
:rtype: :ref:`wx.richtext.TextAttrDimension`
.. method:: GetTop(self)
:rtype: :ref:`wx.richtext.TextAttrDimension`
.. method:: IsValid(self)
Are all dimensions valid?
:rtype: `bool`
.. method:: RemoveStyle(self, attr : TextAttrDimensions)
Remove specified attributes from this object.
:param `attr`:
:type `attr`: wx.richtext.TextAttrDimensions
:rtype: `bool`
.. method:: Reset(self)
Resets the value and flags for all dimensions.
:rtype: `None`
.. method:: __bool__(self)
:rtype: `int`
.. method:: __nonzero__(self)
:rtype: `int`
.. method:: __eq__(self)
Equality operator.
:param `dims`:
:type `dims`: wx.richtext.TextAttrDimensions
.. attribute:: Bottom
See :meth:`~wx.richtext.TextAttrDimensions.GetBottom`
.. attribute:: Left
See :meth:`~wx.richtext.TextAttrDimensions.GetLeft`
.. attribute:: Right
See :meth:`~wx.richtext.TextAttrDimensions.GetRight`
.. attribute:: Top
See :meth:`~wx.richtext.TextAttrDimensions.GetTop`
.. attribute:: m_bottom
A public C++ attribute of type `~wx.richtext.TextAttrDimension` .
.. attribute:: m_left
A public C++ attribute of type `~wx.richtext.TextAttrDimension` .
.. attribute:: m_right
A public C++ attribute of type `~wx.richtext.TextAttrDimension` .
.. attribute:: m_top
A public C++ attribute of type `~wx.richtext.TextAttrDimension` .