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() -> None

TextBoxAttr(attr : TextBoxAttr) -> None

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

Methods¶

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

Overloaded Implementations:

__init__ (self)

Default constructor.

Return type:: None

__init__ (self, attr : TextBoxAttr)

Copy constructor.

Parameters:: attr (wx.richtext.TextBoxAttr)
Return type:: None

AddFlag(self, flag: TextBoxAttrFlags)¶

Adds this flag.

Parameters:: flag (TextBoxAttrFlags)
Return type:: None

Apply(self, style: TextBoxAttr, compareWith: TextBoxAttr | None = 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: TextBoxAttr, clashingAttr: TextBoxAttr, absentAttr: TextBoxAttr)¶

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)

Return type:

None

EqPartial(self, attr: TextBoxAttr, weakTest: bool = 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:

attr (wx.richtext.TextBoxAttr)
weakTest (bool)

Return type:

bool

GetBorder(self)¶

Returns the borders.

Return type:: wx.richtext.TextAttrBorders

GetBottom(self)¶

Returns the bottom position.

Return type:: wx.richtext.TextAttrDimension

GetBottomBorder(self)¶

Returns the bottom border.

Return type:: wx.richtext.TextAttrBorder

GetBottomMargin(self)¶

Returns the bottom margin.

Return type:: wx.richtext.TextAttrDimension

GetBottomOutline(self)¶

Returns the bottom outline.

Return type:: wx.richtext.TextAttrBorder

GetBottomPadding(self)¶

Returns the bottom padding value.

Return type:: wx.richtext.TextAttrDimension

GetBoxStyleName(self)¶

Returns the box style name.

Return type:: str

GetClearMode(self)¶

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

Currently unimplemented.

Return type:: wx.richtext.TextBoxAttrClearStyle

GetCollapseBorders(self)¶

Returns the collapse mode - whether to collapse borders.

Return type:: wx.richtext.TextBoxAttrCollapseMode

GetCornerRadius(self)¶

Return type:: wx.richtext.TextAttrDimension

GetFlags(self)¶

Returns the flags.

Return type:: int

GetFloatMode(self)¶

Returns the float mode.

Return type:: wx.richtext.TextBoxAttrFloatStyle

GetHeight(self)¶

Returns the object height.

Return type:: wx.richtext.TextAttrDimension

GetLeft(self)¶

Returns the left position.

Return type:: wx.richtext.TextAttrDimension

GetLeftBorder(self)¶

Returns the left border.

Return type:: wx.richtext.TextAttrBorder

GetLeftMargin(self)¶

Returns the left margin.

Return type:: wx.richtext.TextAttrDimension

GetLeftOutline(self)¶

Returns the left outline.

Return type:: wx.richtext.TextAttrBorder

GetLeftPadding(self)¶

Returns the left padding value.

Return type:: wx.richtext.TextAttrDimension

GetMargins(self)¶

Returns the margin values.

Return type:: wx.richtext.TextAttrDimensions

GetMaxSize(self)¶

Returns the object maximum size.

Return type:: wx.richtext.TextAttrSize

GetMinSize(self)¶

Returns the object minimum size.

Return type:: wx.richtext.TextAttrSize

GetOutline(self)¶

Returns the outline.

Return type:: wx.richtext.TextAttrBorders

GetPadding(self)¶

Returns the padding values.

Return type:: wx.richtext.TextAttrDimensions

GetPosition(self)¶

Returns the position.

Return type:: wx.richtext.TextAttrDimensions

GetRight(self)¶

Returns the right position.

Return type:: wx.richtext.TextAttrDimension

GetRightBorder(self)¶

Returns the right border.

Return type:: wx.richtext.TextAttrBorder

GetRightMargin(self)¶

Returns the right margin.

Return type:: wx.richtext.TextAttrDimension

GetRightOutline(self)¶

Returns the right outline.

Return type:: wx.richtext.TextAttrBorder

GetRightPadding(self)¶

Returns the right padding value.

Return type:: wx.richtext.TextAttrDimension

GetShadow(self)¶

Returns the box shadow attributes.

Return type:: wx.richtext.TextAttrShadow

GetSize(self)¶

Returns the object size.

Return type:: wx.richtext.TextAttrSize

GetTop(self)¶

Returns the top position.

Return type:: wx.richtext.TextAttrDimension

GetTopBorder(self)¶

Returns the top border.

Return type:: wx.richtext.TextAttrBorder

GetTopMargin(self)¶

Returns the top margin.

Return type:: wx.richtext.TextAttrDimension

GetTopOutline(self)¶

Returns the top outline.

Return type:: wx.richtext.TextAttrBorder

GetTopPadding(self)¶

Returns the top padding value.

Return type:: wx.richtext.TextAttrDimension

GetVerticalAlignment(self)¶

Returns the vertical alignment.

Return type:: wx.richtext.TextBoxAttrVerticalAlignment

GetWhitespaceMode(self)¶

Returns the whitespace mode.

Return type:: wx.richtext.TextBoxAttrWhitespaceMode

GetWidth(self)¶

Returns the object width.

Return type:: wx.richtext.TextAttrDimension

HasBoxStyleName(self)¶

Returns True if the box style name is present.

Return type:: bool

HasClearMode(self)¶

Returns True if we have a clear flag.

Return type:: bool

HasCollapseBorders(self)¶

Returns True if the collapse borders flag is present.

Return type:: bool

HasCornerRadius(self)¶

Returns True if the corner radius flag is present.

Return type:: bool

HasFlag(self, flag: TextBoxAttrFlags)¶

Is this flag present?

Parameters:: flag (TextBoxAttrFlags)
Return type:: bool

HasFloatMode(self)¶

Returns True if float mode is active.

Return type:: bool

HasVerticalAlignment(self)¶

Returns True if a vertical alignment flag is present.

Return type:: bool

HasWhitespaceMode(self)¶

Returns True if the whitespace flag is present.

Return type:: bool

Init(self)¶

Initialises this object.

Return type:: None

IsDefault(self)¶

Returns True if no attributes are set.

Return type:: bool

IsFloating(self)¶

Returns True if this object is floating.

Return type:: bool

RemoveFlag(self, flag: TextBoxAttrFlags)¶

Removes this flag.

Parameters:: flag (TextBoxAttrFlags)
Return type:: None

RemoveStyle(self, attr: TextBoxAttr)¶

Removes the specified attributes from this object.

Parameters:: attr (wx.richtext.TextBoxAttr)
Return type:: bool

Reset(self)¶

Resets this object.

Return type:: None

SetBoxStyleName(self, name: str)¶

Sets the box style name.

Parameters:: name (string)
Return type:: None

SetClearMode(self, mode: TextBoxAttrClearStyle)¶

Set the clear mode.

Currently unimplemented.

Parameters:: mode (TextBoxAttrClearStyle)
Return type:: None

SetCollapseBorders(self, collapse: TextBoxAttrCollapseMode)¶

Sets the collapse mode - whether to collapse borders.

Parameters:: collapse (TextBoxAttrCollapseMode)
Return type:: None

SetCornerRadius(self, dim: TextAttrDimension)¶

Sets the corner radius value.

Parameters:: dim (wx.richtext.TextAttrDimension)
Return type:: None

SetFlags(self, flags: int)¶

Sets the flags.

Parameters:: flags (int)
Return type:: None

SetFloatMode(self, mode: TextBoxAttrFloatStyle)¶

Sets the float mode.

Parameters:: mode (TextBoxAttrFloatStyle)
Return type:: None

SetMaxSize(self, sz: TextAttrSize)¶

Sets the object maximum size.

Parameters:: sz (wx.richtext.TextAttrSize)
Return type:: None

SetMinSize(self, sz: TextAttrSize)¶

Sets the object minimum size.

Parameters:: sz (wx.richtext.TextAttrSize)
Return type:: None

SetSize(self, sz: TextAttrSize)¶

Sets the object size.

Parameters:: sz (wx.richtext.TextAttrSize)
Return type:: None

SetVerticalAlignment(self, verticalAlignment: TextBoxAttrVerticalAlignment)¶

Sets the vertical alignment.

Parameters:: verticalAlignment (TextBoxAttrVerticalAlignment)
Return type:: None

SetWhitespaceMode(self, whitespace: TextBoxAttrWhitespaceMode)¶

Sets the whitespace mode.

Parameters:: whitespace (TextBoxAttrWhitespaceMode)
Return type:: None

__eq__(self)¶

Equality test.

Parameters:: attr (wx.richtext.TextBoxAttr)

Properties¶

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 .

Navigation

wx.richtext.TextBoxAttr¶

Class Hierarchy¶

Methods Summary¶

Properties Summary¶

Class API¶

Methods¶

Properties¶