wx.richtext.TextBoxAttr¶

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

Class Hierarchy¶

Inheritance diagram for class TextBoxAttr:

Methods Summary¶

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

Properties Summary¶

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

Class API¶

class wx.richtext.TextBoxAttr(object)¶

Possible constructors:

TextBoxAttr()

TextBoxAttr(attr)

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

Methods¶

__init__(self, *args, **kw)¶

Overloaded Implementations:

__init__ (self)

Default constructor.

__init__ (self, attr)

Copy constructor.

Parameters: attr (wx.richtext.TextBoxAttr) –

AddFlag(self, flag)¶

Adds this flag.

Parameters: flag (TextBoxAttrFlags) –

Apply(self, style, compareWith=None)¶

Merges the given attributes.

If compareWith is not None, 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.

Parameters

style (wx.richtext.TextBoxAttr) –
compareWith (wx.richtext.TextBoxAttr) –

Return type

bool

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.

Parameters

attr (wx.richtext.TextBoxAttr) –
clashingAttr (wx.richtext.TextBoxAttr) –
absentAttr (wx.richtext.TextBoxAttr) –

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.

Parameters