.. 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.TextBoxAttr:

==========================================================================================================================================
|phoenix_title|  **wx.richtext.TextBoxAttr**
==========================================================================================================================================

A class representing the box attributes of a rich text object.          







         



.. seealso:: :ref:`wx.richtext.RichTextAttr`, :ref:`wx.richtext.RichTextCtrl`    







|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>TextBoxAttr</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.richtext.TextBoxAttr_inheritance.png" alt="Inheritance diagram of TextBoxAttr" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.richtext.TextBoxAttr.html" title="wx.richtext.TextBoxAttr" alt="" coords="5,5,180,35"/> </map> 
   </p>
   </div>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.richtext.TextBoxAttr.__init__`                                        Default constructor.
:meth:`~wx.richtext.TextBoxAttr.AddFlag`                                         Adds this flag.
:meth:`~wx.richtext.TextBoxAttr.Apply`                                           Merges the given attributes.
:meth:`~wx.richtext.TextBoxAttr.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.TextBoxAttr.EqPartial`                                       Partial equality test, ignoring unset attributes.
:meth:`~wx.richtext.TextBoxAttr.GetBorder`                                       Returns the borders.
:meth:`~wx.richtext.TextBoxAttr.GetBottom`                                       Returns the bottom position.
:meth:`~wx.richtext.TextBoxAttr.GetBottomBorder`                                 Returns the bottom border.
:meth:`~wx.richtext.TextBoxAttr.GetBottomMargin`                                 Returns the bottom margin.
:meth:`~wx.richtext.TextBoxAttr.GetBottomOutline`                                Returns the bottom outline.
:meth:`~wx.richtext.TextBoxAttr.GetBottomPadding`                                Returns the bottom padding value.
:meth:`~wx.richtext.TextBoxAttr.GetBoxStyleName`                                 Returns the box style name.
:meth:`~wx.richtext.TextBoxAttr.GetClearMode`                                    Returns the clear mode - whether to wrap text after object.
:meth:`~wx.richtext.TextBoxAttr.GetCollapseBorders`                              Returns the collapse mode - whether to collapse borders.
:meth:`~wx.richtext.TextBoxAttr.GetCornerRadius`                                 
:meth:`~wx.richtext.TextBoxAttr.GetFlags`                                        Returns the flags.
:meth:`~wx.richtext.TextBoxAttr.GetFloatMode`                                    Returns the float mode.
:meth:`~wx.richtext.TextBoxAttr.GetHeight`                                       Returns the object height.
:meth:`~wx.richtext.TextBoxAttr.GetLeft`                                         Returns the left position.
:meth:`~wx.richtext.TextBoxAttr.GetLeftBorder`                                   Returns the left border.
:meth:`~wx.richtext.TextBoxAttr.GetLeftMargin`                                   Returns the left margin.
:meth:`~wx.richtext.TextBoxAttr.GetLeftOutline`                                  Returns the left outline.
:meth:`~wx.richtext.TextBoxAttr.GetLeftPadding`                                  Returns the left padding value.
:meth:`~wx.richtext.TextBoxAttr.GetMargins`                                      Returns the margin values.
:meth:`~wx.richtext.TextBoxAttr.GetMaxSize`                                      Returns the object maximum size.
:meth:`~wx.richtext.TextBoxAttr.GetMinSize`                                      Returns the object minimum size.
:meth:`~wx.richtext.TextBoxAttr.GetOutline`                                      Returns the outline.
:meth:`~wx.richtext.TextBoxAttr.GetPadding`                                      Returns the padding values.
:meth:`~wx.richtext.TextBoxAttr.GetPosition`                                     Returns the position.
:meth:`~wx.richtext.TextBoxAttr.GetRight`                                        Returns the right position.
:meth:`~wx.richtext.TextBoxAttr.GetRightBorder`                                  Returns the right border.
:meth:`~wx.richtext.TextBoxAttr.GetRightMargin`                                  Returns the right margin.
:meth:`~wx.richtext.TextBoxAttr.GetRightOutline`                                 Returns the right outline.
:meth:`~wx.richtext.TextBoxAttr.GetRightPadding`                                 Returns the right padding value.
:meth:`~wx.richtext.TextBoxAttr.GetShadow`                                       Returns the box shadow attributes.
:meth:`~wx.richtext.TextBoxAttr.GetSize`                                         Returns the object size.
:meth:`~wx.richtext.TextBoxAttr.GetTop`                                          Returns the top position.
:meth:`~wx.richtext.TextBoxAttr.GetTopBorder`                                    Returns the top border.
:meth:`~wx.richtext.TextBoxAttr.GetTopMargin`                                    Returns the top margin.
:meth:`~wx.richtext.TextBoxAttr.GetTopOutline`                                   Returns the top outline.
:meth:`~wx.richtext.TextBoxAttr.GetTopPadding`                                   Returns the top padding value.
:meth:`~wx.richtext.TextBoxAttr.GetVerticalAlignment`                            Returns the vertical alignment.
:meth:`~wx.richtext.TextBoxAttr.GetWhitespaceMode`                               Returns the whitespace mode.
:meth:`~wx.richtext.TextBoxAttr.GetWidth`                                        Returns the object width.
:meth:`~wx.richtext.TextBoxAttr.HasBoxStyleName`                                 Returns ``True`` if the box style name is present.
:meth:`~wx.richtext.TextBoxAttr.HasClearMode`                                    Returns ``True`` if we have a clear flag.
:meth:`~wx.richtext.TextBoxAttr.HasCollapseBorders`                              Returns ``True`` if the collapse borders flag is present.
:meth:`~wx.richtext.TextBoxAttr.HasCornerRadius`                                 Returns ``True`` if the corner radius flag is present.
:meth:`~wx.richtext.TextBoxAttr.HasFlag`                                         Is this flag present?
:meth:`~wx.richtext.TextBoxAttr.HasFloatMode`                                    Returns ``True`` if float mode is active.
:meth:`~wx.richtext.TextBoxAttr.HasVerticalAlignment`                            Returns ``True`` if a vertical alignment flag is present.
:meth:`~wx.richtext.TextBoxAttr.HasWhitespaceMode`                               Returns ``True`` if the whitespace flag is present.
:meth:`~wx.richtext.TextBoxAttr.Init`                                            Initialises this object.
:meth:`~wx.richtext.TextBoxAttr.IsDefault`                                       Returns ``True`` if no attributes are set.
:meth:`~wx.richtext.TextBoxAttr.IsFloating`                                      Returns ``True`` if this object is floating.
:meth:`~wx.richtext.TextBoxAttr.RemoveFlag`                                      Removes this flag.
:meth:`~wx.richtext.TextBoxAttr.RemoveStyle`                                     Removes the specified attributes from this object.
:meth:`~wx.richtext.TextBoxAttr.Reset`                                           Resets this object.
:meth:`~wx.richtext.TextBoxAttr.SetBoxStyleName`                                 Sets the box style name.
:meth:`~wx.richtext.TextBoxAttr.SetClearMode`                                    Set the clear mode.
:meth:`~wx.richtext.TextBoxAttr.SetCollapseBorders`                              Sets the collapse mode - whether to collapse borders.
:meth:`~wx.richtext.TextBoxAttr.SetCornerRadius`                                 Sets the corner radius value.
:meth:`~wx.richtext.TextBoxAttr.SetFlags`                                        Sets the flags.
:meth:`~wx.richtext.TextBoxAttr.SetFloatMode`                                    Sets the float mode.
:meth:`~wx.richtext.TextBoxAttr.SetMaxSize`                                      Sets the object maximum size.
:meth:`~wx.richtext.TextBoxAttr.SetMinSize`                                      Sets the object minimum size.
:meth:`~wx.richtext.TextBoxAttr.SetSize`                                         Sets the object size.
:meth:`~wx.richtext.TextBoxAttr.SetVerticalAlignment`                            Sets the vertical alignment.
:meth:`~wx.richtext.TextBoxAttr.SetWhitespaceMode`                               Sets the whitespace mode.
:meth:`~wx.richtext.TextBoxAttr.__eq__`                                          Equality test.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~wx.richtext.TextBoxAttr.Border`                                          See :meth:`~wx.richtext.TextBoxAttr.GetBorder`
:attr:`~wx.richtext.TextBoxAttr.Bottom`                                          See :meth:`~wx.richtext.TextBoxAttr.GetBottom`
:attr:`~wx.richtext.TextBoxAttr.BottomBorder`                                    See :meth:`~wx.richtext.TextBoxAttr.GetBottomBorder`
:attr:`~wx.richtext.TextBoxAttr.BottomMargin`                                    See :meth:`~wx.richtext.TextBoxAttr.GetBottomMargin`
:attr:`~wx.richtext.TextBoxAttr.BottomOutline`                                   See :meth:`~wx.richtext.TextBoxAttr.GetBottomOutline`
:attr:`~wx.richtext.TextBoxAttr.BottomPadding`                                   See :meth:`~wx.richtext.TextBoxAttr.GetBottomPadding`
:attr:`~wx.richtext.TextBoxAttr.BoxStyleName`                                    See :meth:`~wx.richtext.TextBoxAttr.GetBoxStyleName` and :meth:`~wx.richtext.TextBoxAttr.SetBoxStyleName`
:attr:`~wx.richtext.TextBoxAttr.ClearMode`                                       See :meth:`~wx.richtext.TextBoxAttr.GetClearMode` and :meth:`~wx.richtext.TextBoxAttr.SetClearMode`
:attr:`~wx.richtext.TextBoxAttr.CollapseBorders`                                 See :meth:`~wx.richtext.TextBoxAttr.GetCollapseBorders` and :meth:`~wx.richtext.TextBoxAttr.SetCollapseBorders`
:attr:`~wx.richtext.TextBoxAttr.CornerRadius`                                    See :meth:`~wx.richtext.TextBoxAttr.GetCornerRadius` and :meth:`~wx.richtext.TextBoxAttr.SetCornerRadius`
:attr:`~wx.richtext.TextBoxAttr.Flags`                                           See :meth:`~wx.richtext.TextBoxAttr.GetFlags` and :meth:`~wx.richtext.TextBoxAttr.SetFlags`
:attr:`~wx.richtext.TextBoxAttr.FloatMode`                                       See :meth:`~wx.richtext.TextBoxAttr.GetFloatMode` and :meth:`~wx.richtext.TextBoxAttr.SetFloatMode`
:attr:`~wx.richtext.TextBoxAttr.Height`                                          See :meth:`~wx.richtext.TextBoxAttr.GetHeight`
:attr:`~wx.richtext.TextBoxAttr.Left`                                            See :meth:`~wx.richtext.TextBoxAttr.GetLeft`
:attr:`~wx.richtext.TextBoxAttr.LeftBorder`                                      See :meth:`~wx.richtext.TextBoxAttr.GetLeftBorder`
:attr:`~wx.richtext.TextBoxAttr.LeftMargin`                                      See :meth:`~wx.richtext.TextBoxAttr.GetLeftMargin`
:attr:`~wx.richtext.TextBoxAttr.LeftOutline`                                     See :meth:`~wx.richtext.TextBoxAttr.GetLeftOutline`
:attr:`~wx.richtext.TextBoxAttr.LeftPadding`                                     See :meth:`~wx.richtext.TextBoxAttr.GetLeftPadding`
:attr:`~wx.richtext.TextBoxAttr.Margins`                                         See :meth:`~wx.richtext.TextBoxAttr.GetMargins`
:attr:`~wx.richtext.TextBoxAttr.MaxSize`                                         See :meth:`~wx.richtext.TextBoxAttr.GetMaxSize` and :meth:`~wx.richtext.TextBoxAttr.SetMaxSize`
:attr:`~wx.richtext.TextBoxAttr.MinSize`                                         See :meth:`~wx.richtext.TextBoxAttr.GetMinSize` and :meth:`~wx.richtext.TextBoxAttr.SetMinSize`
:attr:`~wx.richtext.TextBoxAttr.Outline`                                         See :meth:`~wx.richtext.TextBoxAttr.GetOutline`
:attr:`~wx.richtext.TextBoxAttr.Padding`                                         See :meth:`~wx.richtext.TextBoxAttr.GetPadding`
:attr:`~wx.richtext.TextBoxAttr.Position`                                        See :meth:`~wx.richtext.TextBoxAttr.GetPosition`
:attr:`~wx.richtext.TextBoxAttr.Right`                                           See :meth:`~wx.richtext.TextBoxAttr.GetRight`
:attr:`~wx.richtext.TextBoxAttr.RightBorder`                                     See :meth:`~wx.richtext.TextBoxAttr.GetRightBorder`
:attr:`~wx.richtext.TextBoxAttr.RightMargin`                                     See :meth:`~wx.richtext.TextBoxAttr.GetRightMargin`
:attr:`~wx.richtext.TextBoxAttr.RightOutline`                                    See :meth:`~wx.richtext.TextBoxAttr.GetRightOutline`
:attr:`~wx.richtext.TextBoxAttr.RightPadding`                                    See :meth:`~wx.richtext.TextBoxAttr.GetRightPadding`
:attr:`~wx.richtext.TextBoxAttr.Shadow`                                          See :meth:`~wx.richtext.TextBoxAttr.GetShadow`
:attr:`~wx.richtext.TextBoxAttr.Size`                                            See :meth:`~wx.richtext.TextBoxAttr.GetSize` and :meth:`~wx.richtext.TextBoxAttr.SetSize`
:attr:`~wx.richtext.TextBoxAttr.Top`                                             See :meth:`~wx.richtext.TextBoxAttr.GetTop`
:attr:`~wx.richtext.TextBoxAttr.TopBorder`                                       See :meth:`~wx.richtext.TextBoxAttr.GetTopBorder`
:attr:`~wx.richtext.TextBoxAttr.TopMargin`                                       See :meth:`~wx.richtext.TextBoxAttr.GetTopMargin`
:attr:`~wx.richtext.TextBoxAttr.TopOutline`                                      See :meth:`~wx.richtext.TextBoxAttr.GetTopOutline`
:attr:`~wx.richtext.TextBoxAttr.TopPadding`                                      See :meth:`~wx.richtext.TextBoxAttr.GetTopPadding`
:attr:`~wx.richtext.TextBoxAttr.VerticalAlignment`                               See :meth:`~wx.richtext.TextBoxAttr.GetVerticalAlignment` and :meth:`~wx.richtext.TextBoxAttr.SetVerticalAlignment`
:attr:`~wx.richtext.TextBoxAttr.WhitespaceMode`                                  See :meth:`~wx.richtext.TextBoxAttr.GetWhitespaceMode` and :meth:`~wx.richtext.TextBoxAttr.SetWhitespaceMode`
:attr:`~wx.richtext.TextBoxAttr.Width`                                           See :meth:`~wx.richtext.TextBoxAttr.GetWidth`
:attr:`~wx.richtext.TextBoxAttr.m_border`                                        A public C++ attribute of type :ref:`~wx.richtext.TextAttrBorders`.
:attr:`~wx.richtext.TextBoxAttr.m_boxStyleName`                                  A public C++ attribute of type ``string``.
:attr:`~wx.richtext.TextBoxAttr.m_clearMode`                                     A public C++ attribute of type :ref:`~wx.richtext.TextBoxAttrClearStyle`.
:attr:`~wx.richtext.TextBoxAttr.m_collapseMode`                                  A public C++ attribute of type :ref:`~wx.richtext.TextBoxAttrCollapseMode`.
:attr:`~wx.richtext.TextBoxAttr.m_cornerRadius`                                  A public C++ attribute of type :ref:`~wx.richtext.TextAttrDimension`.
:attr:`~wx.richtext.TextBoxAttr.m_flags`                                         A public C++ attribute of type ``int``.
:attr:`~wx.richtext.TextBoxAttr.m_floatMode`                                     A public C++ attribute of type :ref:`~wx.richtext.TextBoxAttrFloatStyle`.
:attr:`~wx.richtext.TextBoxAttr.m_margins`                                       A public C++ attribute of type :ref:`~wx.richtext.TextAttrDimensions`.
:attr:`~wx.richtext.TextBoxAttr.m_maxSize`                                       A public C++ attribute of type :ref:`~wx.richtext.TextAttrSize`.
:attr:`~wx.richtext.TextBoxAttr.m_minSize`                                       A public C++ attribute of type :ref:`~wx.richtext.TextAttrSize`.
:attr:`~wx.richtext.TextBoxAttr.m_outline`                                       A public C++ attribute of type :ref:`~wx.richtext.TextAttrBorders`.
:attr:`~wx.richtext.TextBoxAttr.m_padding`                                       A public C++ attribute of type :ref:`~wx.richtext.TextAttrDimensions`.
:attr:`~wx.richtext.TextBoxAttr.m_position`                                      A public C++ attribute of type :ref:`~wx.richtext.TextAttrDimensions`.
:attr:`~wx.richtext.TextBoxAttr.m_shadow`                                        A public C++ attribute of type :ref:`~wx.richtext.TextAttrShadow`.
:attr:`~wx.richtext.TextBoxAttr.m_size`                                          A public C++ attribute of type :ref:`~wx.richtext.TextAttrSize`.
:attr:`~wx.richtext.TextBoxAttr.m_verticalAlignment`                             A public C++ attribute of type :ref:`~wx.richtext.TextBoxAttrVerticalAlignment`.
:attr:`~wx.richtext.TextBoxAttr.m_whitespaceMode`                                A public C++ attribute of type :ref:`~wx.richtext.TextBoxAttrWhitespaceMode`.
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: wx.richtext.TextBoxAttr(object)

   **Possible constructors**::

       TextBoxAttr()
       
       TextBoxAttr(attr)
       
   
   A class representing the box attributes of a rich text object.



   .. method:: __init__(self, *args, **kw)



      |overload| Overloaded Implementations:

      :html:`<hr class="overloadsep" /><br />`

      
      **__init__** `(self)`
      
      Default constructor.                   
      
      
      
      
      :html:`<hr class="overloadsep" /><br />`

      
      **__init__** `(self, attr)`
      
      Copy constructor.                  
      
      
      :param `attr`: 
      :type `attr`: wx.richtext.TextBoxAttr
      
      
      
      
      
      
      :html:`<hr class="overloadsep" /><br />`






   .. method:: AddFlag(self, flag)

      Adds this flag.                  


      :param `flag`: 
      :type `flag`: wx.richtext.TextBoxAttrFlags







   .. method:: Apply(self, style, compareWith=None)

      Merges the given attributes.                  

      If `compareWith`  is non-NULL, then it will be used to mask out those attributes that are the same in style and `compareWith`, for situations where we don't want to explicitly set inherited attributes.                  


      :param `style`: 
      :type `style`: wx.richtext.TextBoxAttr
      :param `compareWith`: 
      :type `compareWith`: wx.richtext.TextBoxAttr




      :rtype: `bool`








   .. method:: CollectCommonAttributes(self, attr, clashingAttr, absentAttr)

      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.TextBoxAttr
      :param `clashingAttr`: 
      :type `clashingAttr`: wx.richtext.TextBoxAttr
      :param `absentAttr`: 
      :type `absentAttr`: wx.richtext.TextBoxAttr







   .. method:: EqPartial(self, attr, weakTest=True)

      Partial equality test, ignoring unset attributes.                  

      If `weakTest`  is ``True``, attributes of this object do not have to be present if those attributes of `attr`  are present. If `weakTest`  is ``False``, the function will fail if an attribute is present in `attr`  but not in this object.                  


      :param `attr`: 
      :type `attr`: wx.richtext.TextBoxAttr
      :param `weakTest`: 
      :type `weakTest`: bool




      :rtype: `bool`








   .. method:: GetBorder(self)

      Returns the borders.                  

      :rtype: :ref:`wx.richtext.TextAttrBorders`








   .. method:: GetBottom(self)

      Returns the bottom position.                  

      :rtype: :ref:`wx.richtext.TextAttrDimension`








   .. method:: GetBottomBorder(self)

      Returns the bottom border.                  

      :rtype: :ref:`wx.richtext.TextAttrBorder`








   .. method:: GetBottomMargin(self)

      Returns the bottom margin.                  

      :rtype: :ref:`wx.richtext.TextAttrDimension`








   .. method:: GetBottomOutline(self)

      Returns the bottom outline.                  

      :rtype: :ref:`wx.richtext.TextAttrBorder`








   .. method:: GetBottomPadding(self)

      Returns the bottom padding value.                  

      :rtype: :ref:`wx.richtext.TextAttrDimension`








   .. method:: GetBoxStyleName(self)

      Returns the box style name.                  

      :rtype: `string`








   .. method:: GetClearMode(self)

      Returns the clear mode - whether to wrap text after object.                  

      Currently unimplemented.                  

      :rtype: :ref:`wx.richtext.TextBoxAttrClearStyle`








   .. method:: GetCollapseBorders(self)

      Returns the collapse mode - whether to collapse borders.                  

      :rtype: :ref:`wx.richtext.TextBoxAttrCollapseMode`








   .. method:: GetCornerRadius(self)



      :rtype: :ref:`wx.richtext.TextAttrDimension`








   .. method:: GetFlags(self)

      Returns the flags.                  

      :rtype: `int`








   .. method:: GetFloatMode(self)

      Returns the float mode.                  

      :rtype: :ref:`wx.richtext.TextBoxAttrFloatStyle`








   .. method:: GetHeight(self)

      Returns the object height.                  

      :rtype: :ref:`wx.richtext.TextAttrDimension`








   .. method:: GetLeft(self)

      Returns the left position.                  

      :rtype: :ref:`wx.richtext.TextAttrDimension`








   .. method:: GetLeftBorder(self)

      Returns the left border.                  

      :rtype: :ref:`wx.richtext.TextAttrBorder`








   .. method:: GetLeftMargin(self)

      Returns the left margin.                  

      :rtype: :ref:`wx.richtext.TextAttrDimension`








   .. method:: GetLeftOutline(self)

      Returns the left outline.                  

      :rtype: :ref:`wx.richtext.TextAttrBorder`








   .. method:: GetLeftPadding(self)

      Returns the left padding value.                  

      :rtype: :ref:`wx.richtext.TextAttrDimension`








   .. method:: GetMargins(self)

      Returns the margin values.                  

      :rtype: :ref:`wx.richtext.TextAttrDimensions`








   .. method:: GetMaxSize(self)

      Returns the object maximum size.                  

      :rtype: :ref:`wx.richtext.TextAttrSize`








   .. method:: GetMinSize(self)

      Returns the object minimum size.                  

      :rtype: :ref:`wx.richtext.TextAttrSize`








   .. method:: GetOutline(self)

      Returns the outline.                  

      :rtype: :ref:`wx.richtext.TextAttrBorders`








   .. method:: GetPadding(self)

      Returns the padding values.                  

      :rtype: :ref:`wx.richtext.TextAttrDimensions`








   .. method:: GetPosition(self)

      Returns the position.                  

      :rtype: :ref:`wx.richtext.TextAttrDimensions`








   .. method:: GetRight(self)

      Returns the right position.                  

      :rtype: :ref:`wx.richtext.TextAttrDimension`








   .. method:: GetRightBorder(self)

      Returns the right border.                  

      :rtype: :ref:`wx.richtext.TextAttrBorder`








   .. method:: GetRightMargin(self)

      Returns the right margin.                  

      :rtype: :ref:`wx.richtext.TextAttrDimension`








   .. method:: GetRightOutline(self)

      Returns the right outline.                  

      :rtype: :ref:`wx.richtext.TextAttrBorder`








   .. method:: GetRightPadding(self)

      Returns the right padding value.                  

      :rtype: :ref:`wx.richtext.TextAttrDimension`








   .. method:: GetShadow(self)

      Returns the box shadow attributes.                  

      :rtype: :ref:`wx.richtext.TextAttrShadow`








   .. method:: GetSize(self)

      Returns the object size.                  

      :rtype: :ref:`wx.richtext.TextAttrSize`








   .. method:: GetTop(self)

      Returns the top position.                  

      :rtype: :ref:`wx.richtext.TextAttrDimension`








   .. method:: GetTopBorder(self)

      Returns the top border.                  

      :rtype: :ref:`wx.richtext.TextAttrBorder`








   .. method:: GetTopMargin(self)

      Returns the top margin.                  

      :rtype: :ref:`wx.richtext.TextAttrDimension`








   .. method:: GetTopOutline(self)

      Returns the top outline.                  

      :rtype: :ref:`wx.richtext.TextAttrBorder`








   .. method:: GetTopPadding(self)

      Returns the top padding value.                  

      :rtype: :ref:`wx.richtext.TextAttrDimension`








   .. method:: GetVerticalAlignment(self)

      Returns the vertical alignment.                  

      :rtype: :ref:`wx.richtext.TextBoxAttrVerticalAlignment`








   .. method:: GetWhitespaceMode(self)

      Returns the whitespace mode.                  

      :rtype: :ref:`wx.richtext.TextBoxAttrWhitespaceMode`








   .. method:: GetWidth(self)

      Returns the object width.                  

      :rtype: :ref:`wx.richtext.TextAttrDimension`








   .. method:: HasBoxStyleName(self)

      Returns ``True`` if the box style name is present.                  

      :rtype: `bool`








   .. method:: HasClearMode(self)

      Returns ``True`` if we have a clear flag.                  

      :rtype: `bool`








   .. method:: HasCollapseBorders(self)

      Returns ``True`` if the collapse borders flag is present.                  

      :rtype: `bool`








   .. method:: HasCornerRadius(self)

      Returns ``True`` if the corner radius flag is present.                  

      :rtype: `bool`








   .. method:: HasFlag(self, flag)

      Is this flag present?                  


      :param `flag`: 
      :type `flag`: wx.richtext.TextBoxAttrFlags




      :rtype: `bool`








   .. method:: HasFloatMode(self)

      Returns ``True`` if float mode is active.                  

      :rtype: `bool`








   .. method:: HasVerticalAlignment(self)

      Returns ``True`` if a vertical alignment flag is present.                  

      :rtype: `bool`








   .. method:: HasWhitespaceMode(self)

      Returns ``True`` if the whitespace flag is present.                  

      :rtype: `bool`








   .. method:: Init(self)

      Initialises this object.                   





   .. method:: IsDefault(self)

      Returns ``True`` if no attributes are set.                  

      :rtype: `bool`








   .. method:: IsFloating(self)

      Returns ``True`` if this object is floating.                  

      :rtype: `bool`








   .. method:: RemoveFlag(self, flag)

      Removes this flag.                  


      :param `flag`: 
      :type `flag`: wx.richtext.TextBoxAttrFlags







   .. method:: RemoveStyle(self, attr)

      Removes the specified attributes from this object.                  


      :param `attr`: 
      :type `attr`: wx.richtext.TextBoxAttr




      :rtype: `bool`








   .. method:: Reset(self)

      Resets this object.                   





   .. method:: SetBoxStyleName(self, name)

      Sets the box style name.                  


      :param `name`: 
      :type `name`: string







   .. method:: SetClearMode(self, mode)

      Set the clear mode.                  

      Currently unimplemented.                  


      :param `mode`: 
      :type `mode`: wx.richtext.TextBoxAttrClearStyle







   .. method:: SetCollapseBorders(self, collapse)

      Sets the collapse mode - whether to collapse borders.                  


      :param `collapse`: 
      :type `collapse`: wx.richtext.TextBoxAttrCollapseMode







   .. method:: SetCornerRadius(self, dim)

      Sets the corner radius value.                  


      :param `dim`: 
      :type `dim`: wx.richtext.TextAttrDimension







   .. method:: SetFlags(self, flags)

      Sets the flags.                  


      :param `flags`: 
      :type `flags`: int







   .. method:: SetFloatMode(self, mode)

      Sets the float mode.                  


      :param `mode`: 
      :type `mode`: wx.richtext.TextBoxAttrFloatStyle







   .. method:: SetMaxSize(self, sz)

      Sets the object maximum size.                  


      :param `sz`: 
      :type `sz`: wx.richtext.TextAttrSize







   .. method:: SetMinSize(self, sz)

      Sets the object minimum size.                  


      :param `sz`: 
      :type `sz`: wx.richtext.TextAttrSize







   .. method:: SetSize(self, sz)

      Sets the object size.                  


      :param `sz`: 
      :type `sz`: wx.richtext.TextAttrSize







   .. method:: SetVerticalAlignment(self, verticalAlignment)

      Sets the vertical alignment.                  


      :param `verticalAlignment`: 
      :type `verticalAlignment`: wx.richtext.TextBoxAttrVerticalAlignment







   .. method:: SetWhitespaceMode(self, whitespace)

      Sets the whitespace mode.                  


      :param `whitespace`: 
      :type `whitespace`: wx.richtext.TextBoxAttrWhitespaceMode







   .. method:: __eq__(self)

      Equality test.                  


      :param `attr`: 
      :type `attr`: wx.richtext.TextBoxAttr







   .. attribute:: Border

      See :meth:`~wx.richtext.TextBoxAttr.GetBorder`


   .. attribute:: Bottom

      See :meth:`~wx.richtext.TextBoxAttr.GetBottom`


   .. attribute:: BottomBorder

      See :meth:`~wx.richtext.TextBoxAttr.GetBottomBorder`


   .. attribute:: BottomMargin

      See :meth:`~wx.richtext.TextBoxAttr.GetBottomMargin`


   .. attribute:: BottomOutline

      See :meth:`~wx.richtext.TextBoxAttr.GetBottomOutline`


   .. attribute:: BottomPadding

      See :meth:`~wx.richtext.TextBoxAttr.GetBottomPadding`


   .. attribute:: BoxStyleName

      See :meth:`~wx.richtext.TextBoxAttr.GetBoxStyleName` and :meth:`~wx.richtext.TextBoxAttr.SetBoxStyleName`


   .. attribute:: ClearMode

      See :meth:`~wx.richtext.TextBoxAttr.GetClearMode` and :meth:`~wx.richtext.TextBoxAttr.SetClearMode`


   .. attribute:: CollapseBorders

      See :meth:`~wx.richtext.TextBoxAttr.GetCollapseBorders` and :meth:`~wx.richtext.TextBoxAttr.SetCollapseBorders`


   .. attribute:: CornerRadius

      See :meth:`~wx.richtext.TextBoxAttr.GetCornerRadius` and :meth:`~wx.richtext.TextBoxAttr.SetCornerRadius`


   .. attribute:: Flags

      See :meth:`~wx.richtext.TextBoxAttr.GetFlags` and :meth:`~wx.richtext.TextBoxAttr.SetFlags`


   .. attribute:: FloatMode

      See :meth:`~wx.richtext.TextBoxAttr.GetFloatMode` and :meth:`~wx.richtext.TextBoxAttr.SetFloatMode`


   .. attribute:: Height

      See :meth:`~wx.richtext.TextBoxAttr.GetHeight`


   .. attribute:: Left

      See :meth:`~wx.richtext.TextBoxAttr.GetLeft`


   .. attribute:: LeftBorder

      See :meth:`~wx.richtext.TextBoxAttr.GetLeftBorder`


   .. attribute:: LeftMargin

      See :meth:`~wx.richtext.TextBoxAttr.GetLeftMargin`


   .. attribute:: LeftOutline

      See :meth:`~wx.richtext.TextBoxAttr.GetLeftOutline`


   .. attribute:: LeftPadding

      See :meth:`~wx.richtext.TextBoxAttr.GetLeftPadding`


   .. attribute:: Margins

      See :meth:`~wx.richtext.TextBoxAttr.GetMargins`


   .. attribute:: MaxSize

      See :meth:`~wx.richtext.TextBoxAttr.GetMaxSize` and :meth:`~wx.richtext.TextBoxAttr.SetMaxSize`


   .. attribute:: MinSize

      See :meth:`~wx.richtext.TextBoxAttr.GetMinSize` and :meth:`~wx.richtext.TextBoxAttr.SetMinSize`


   .. attribute:: Outline

      See :meth:`~wx.richtext.TextBoxAttr.GetOutline`


   .. attribute:: Padding

      See :meth:`~wx.richtext.TextBoxAttr.GetPadding`


   .. attribute:: Position

      See :meth:`~wx.richtext.TextBoxAttr.GetPosition`


   .. attribute:: Right

      See :meth:`~wx.richtext.TextBoxAttr.GetRight`


   .. attribute:: RightBorder

      See :meth:`~wx.richtext.TextBoxAttr.GetRightBorder`


   .. attribute:: RightMargin

      See :meth:`~wx.richtext.TextBoxAttr.GetRightMargin`


   .. attribute:: RightOutline

      See :meth:`~wx.richtext.TextBoxAttr.GetRightOutline`


   .. attribute:: RightPadding

      See :meth:`~wx.richtext.TextBoxAttr.GetRightPadding`


   .. attribute:: Shadow

      See :meth:`~wx.richtext.TextBoxAttr.GetShadow`


   .. attribute:: Size

      See :meth:`~wx.richtext.TextBoxAttr.GetSize` and :meth:`~wx.richtext.TextBoxAttr.SetSize`


   .. attribute:: Top

      See :meth:`~wx.richtext.TextBoxAttr.GetTop`


   .. attribute:: TopBorder

      See :meth:`~wx.richtext.TextBoxAttr.GetTopBorder`


   .. attribute:: TopMargin

      See :meth:`~wx.richtext.TextBoxAttr.GetTopMargin`


   .. attribute:: TopOutline

      See :meth:`~wx.richtext.TextBoxAttr.GetTopOutline`


   .. attribute:: TopPadding

      See :meth:`~wx.richtext.TextBoxAttr.GetTopPadding`


   .. attribute:: VerticalAlignment

      See :meth:`~wx.richtext.TextBoxAttr.GetVerticalAlignment` and :meth:`~wx.richtext.TextBoxAttr.SetVerticalAlignment`


   .. attribute:: WhitespaceMode

      See :meth:`~wx.richtext.TextBoxAttr.GetWhitespaceMode` and :meth:`~wx.richtext.TextBoxAttr.SetWhitespaceMode`


   .. attribute:: Width

      See :meth:`~wx.richtext.TextBoxAttr.GetWidth`


   .. attribute:: m_border

      A public C++ attribute of type :ref:`~wx.richtext.TextAttrBorders`.


   .. attribute:: m_boxStyleName

      A public C++ attribute of type ``string``.


   .. attribute:: m_clearMode

      A public C++ attribute of type :ref:`~wx.richtext.TextBoxAttrClearStyle`.


   .. attribute:: m_collapseMode

      A public C++ attribute of type :ref:`~wx.richtext.TextBoxAttrCollapseMode`.


   .. attribute:: m_cornerRadius

      A public C++ attribute of type :ref:`~wx.richtext.TextAttrDimension`.


   .. attribute:: m_flags

      A public C++ attribute of type ``int``.


   .. attribute:: m_floatMode

      A public C++ attribute of type :ref:`~wx.richtext.TextBoxAttrFloatStyle`.


   .. attribute:: m_margins

      A public C++ attribute of type :ref:`~wx.richtext.TextAttrDimensions`.


   .. attribute:: m_maxSize

      A public C++ attribute of type :ref:`~wx.richtext.TextAttrSize`.


   .. attribute:: m_minSize

      A public C++ attribute of type :ref:`~wx.richtext.TextAttrSize`.


   .. attribute:: m_outline

      A public C++ attribute of type :ref:`~wx.richtext.TextAttrBorders`.


   .. attribute:: m_padding

      A public C++ attribute of type :ref:`~wx.richtext.TextAttrDimensions`.


   .. attribute:: m_position

      A public C++ attribute of type :ref:`~wx.richtext.TextAttrDimensions`.


   .. attribute:: m_shadow

      A public C++ attribute of type :ref:`~wx.richtext.TextAttrShadow`.


   .. attribute:: m_size

      A public C++ attribute of type :ref:`~wx.richtext.TextAttrSize`.


   .. attribute:: m_verticalAlignment

      A public C++ attribute of type :ref:`~wx.richtext.TextBoxAttrVerticalAlignment`.


   .. attribute:: m_whitespaceMode

      A public C++ attribute of type :ref:`~wx.richtext.TextBoxAttrWhitespaceMode`.

