wx.richtext.TextBoxAttr¶A class representing the box attributes of a rich text object.
See also
wx.richtext.RichTextAttr, wx.richtext.RichTextCtrl
Class Hierarchy¶
Inheritance diagram for class TextBoxAttr:

Methods Summary¶Default constructor. |
|
Adds this flag. |
|
Merges the given attributes. |
|
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. |
|
Partial equality test, ignoring unset attributes. |
|
Returns the borders. |
|
Returns the bottom position. |
|
Returns the bottom border. |
|
Returns the bottom margin. |
|
Returns the bottom outline. |
|
Returns the bottom padding value. |
|
Returns the box style name. |
|
Returns the clear mode - whether to wrap text after object. |
|
Returns the collapse mode - whether to collapse borders. |
|
Returns the flags. |
|
Returns the float mode. |
|
Returns the object height. |
|
Returns the left position. |
|
Returns the left border. |
|
Returns the left margin. |
|
Returns the left outline. |
|
Returns the left padding value. |
|
Returns the margin values. |
|
Returns the object maximum size. |
|
Returns the object minimum size. |
|
Returns the outline. |
|
Returns the padding values. |
|
Returns the position. |
|
Returns the right position. |
|
Returns the right border. |
|
Returns the right margin. |
|
Returns the right outline. |
|
Returns the right padding value. |
|
Returns the box shadow attributes. |
|
Returns the object size. |
|
Returns the top position. |
|
Returns the top border. |
|
Returns the top margin. |
|
Returns the top outline. |
|
Returns the top padding value. |
|
Returns the vertical alignment. |
|
Returns the whitespace mode. |
|
Returns the object width. |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Is this flag present? |
|
Returns |
|
Returns |
|
Returns |
|
Initialises this object. |
|
Returns |
|
Returns |
|
Removes this flag. |
|
Removes the specified attributes from this object. |
|
Resets this object. |
|
Sets the box style name. |
|
Set the clear mode. |
|
Sets the collapse mode - whether to collapse borders. |
|
Sets the corner radius value. |
|
Sets the flags. |
|
Sets the float mode. |
|
Sets the object maximum size. |
|
Sets the object minimum size. |
|
Sets the object size. |
|
Sets the vertical alignment. |
|
Sets the whitespace mode. |
|
Equality test. |
Properties Summary¶See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
Class API¶wx.richtext.TextBoxAttr(object)¶Possible constructors:
TextBoxAttr()
TextBoxAttr(attr)
A class representing the box attributes of a rich text object.
__init__(self, *args, **kw)¶__init__ (self)
Default constructor.
__init__ (self, attr)
Copy constructor.
attr (wx.richtext.TextBoxAttr) –
AddFlag(self, flag)¶Adds this flag.
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.
style (wx.richtext.TextBoxAttr) –
compareWith (wx.richtext.TextBoxAttr) –
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.
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.
attr (wx.richtext.TextBoxAttr) –
weakTest (bool) –
bool
GetBorder(self)¶Returns the borders.
GetBottom(self)¶Returns the bottom position.
GetBottomBorder(self)¶Returns the bottom border.
GetBottomMargin(self)¶Returns the bottom margin.
GetBottomOutline(self)¶Returns the bottom outline.
GetBottomPadding(self)¶Returns the bottom padding value.
GetBoxStyleName(self)¶Returns the box style name.
string
GetClearMode(self)¶Returns the clear mode - whether to wrap text after object.
Currently unimplemented.
GetCollapseBorders(self)¶Returns the collapse mode - whether to collapse borders.
GetCornerRadius(self)¶GetFlags(self)¶Returns the flags.
int
GetFloatMode(self)¶Returns the float mode.
GetHeight(self)¶Returns the object height.
GetLeft(self)¶Returns the left position.
GetLeftBorder(self)¶Returns the left border.
GetLeftMargin(self)¶Returns the left margin.
GetLeftOutline(self)¶Returns the left outline.
GetLeftPadding(self)¶Returns the left padding value.
GetMargins(self)¶Returns the margin values.
GetMaxSize(self)¶Returns the object maximum size.
GetMinSize(self)¶Returns the object minimum size.
GetOutline(self)¶Returns the outline.
GetPadding(self)¶Returns the padding values.
GetPosition(self)¶Returns the position.
GetRight(self)¶Returns the right position.
GetRightBorder(self)¶Returns the right border.
GetRightMargin(self)¶Returns the right margin.
GetRightOutline(self)¶Returns the right outline.
GetRightPadding(self)¶Returns the right padding value.
GetShadow(self)¶Returns the box shadow attributes.
GetSize(self)¶Returns the object size.
GetTop(self)¶Returns the top position.
GetTopBorder(self)¶Returns the top border.
GetTopMargin(self)¶Returns the top margin.
GetTopOutline(self)¶Returns the top outline.
GetTopPadding(self)¶Returns the top padding value.
GetVerticalAlignment(self)¶Returns the vertical alignment.
GetWhitespaceMode(self)¶Returns the whitespace mode.
GetWidth(self)¶Returns the object width.
HasBoxStyleName(self)¶Returns True if the box style name is present.
bool
HasClearMode(self)¶Returns True if we have a clear flag.
bool
HasCollapseBorders(self)¶Returns True if the collapse borders flag is present.
bool
HasCornerRadius(self)¶Returns True if the corner radius flag is present.
bool
HasFlag(self, flag)¶Is this flag present?
flag (TextBoxAttrFlags) –
bool
HasFloatMode(self)¶Returns True if float mode is active.
bool
HasVerticalAlignment(self)¶Returns True if a vertical alignment flag is present.
bool
HasWhitespaceMode(self)¶Returns True if the whitespace flag is present.
bool
Init(self)¶Initialises this object.
IsDefault(self)¶Returns True if no attributes are set.
bool
IsFloating(self)¶Returns True if this object is floating.
bool
RemoveFlag(self, flag)¶Removes this flag.
flag (TextBoxAttrFlags) –
RemoveStyle(self, attr)¶Removes the specified attributes from this object.
attr (wx.richtext.TextBoxAttr) –
bool
Reset(self)¶Resets this object.
SetBoxStyleName(self, name)¶Sets the box style name.
name (string) –
SetClearMode(self, mode)¶Set the clear mode.
Currently unimplemented.
mode (TextBoxAttrClearStyle) –
SetCollapseBorders(self, collapse)¶Sets the collapse mode - whether to collapse borders.
collapse (TextBoxAttrCollapseMode) –
SetCornerRadius(self, dim)¶Sets the corner radius value.
dim (wx.richtext.TextAttrDimension) –
SetFlags(self, flags)¶Sets the flags.
flags (int) –
SetFloatMode(self, mode)¶Sets the float mode.
mode (TextBoxAttrFloatStyle) –
SetMaxSize(self, sz)¶Sets the object maximum size.
sz (wx.richtext.TextAttrSize) –
SetMinSize(self, sz)¶Sets the object minimum size.
sz (wx.richtext.TextAttrSize) –
SetSize(self, sz)¶Sets the object size.
sz (wx.richtext.TextAttrSize) –
SetVerticalAlignment(self, verticalAlignment)¶Sets the vertical alignment.
verticalAlignment (TextBoxAttrVerticalAlignment) –
SetWhitespaceMode(self, whitespace)¶Sets the whitespace mode.
whitespace (TextBoxAttrWhitespaceMode) –
__eq__(self)¶Equality test.
attr (wx.richtext.TextBoxAttr) –
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
FloatMode¶See GetFloatMode and SetFloatMode
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
RightBorder¶See GetRightBorder
RightMargin¶See GetRightMargin
RightOutline¶See GetRightOutline
RightPadding¶See GetRightPadding
TopBorder¶See GetTopBorder
TopMargin¶See GetTopMargin
TopOutline¶See GetTopOutline
TopPadding¶See GetTopPadding
VerticalAlignment¶WhitespaceMode¶See GetWhitespaceMode and SetWhitespaceMode
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 .