wx.richtext.TextBoxAttr¶A class representing the box attributes of a rich text object.
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¶Possible constructors:
TextBoxAttr() -> None
TextBoxAttr(attr) -> None
A class representing the box attributes of a rich text object.
__init__ (self)
Default constructor.
None
__init__ (self, attr)
Copy constructor.
attr (wx.richtext.TextBoxAttr)
None
Adds this flag.
flag (TextBoxAttrFlags)
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
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)
None
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
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.
str
Returns the clear mode - whether to wrap text after object.
Currently unimplemented.
Returns the collapse mode - whether to collapse borders.
Returns the flags.
int
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 True if the box style name is present.
bool
Returns True if we have a clear flag.
bool
Returns True if the collapse borders flag is present.
bool
Returns True if the corner radius flag is present.
bool
Is this flag present?
flag (TextBoxAttrFlags)
bool
Returns True if float mode is active.
bool
Returns True if a vertical alignment flag is present.
bool
Returns True if the whitespace flag is present.
bool
Initialises this object.
None
Returns True if no attributes are set.
bool
Returns True if this object is floating.
bool
Removes this flag.
flag (TextBoxAttrFlags)
None
Removes the specified attributes from this object.
attr (wx.richtext.TextBoxAttr)
bool
Resets this object.
None
Sets the box style name.
name (string)
None
Set the clear mode.
Currently unimplemented.
mode (TextBoxAttrClearStyle)
None
Sets the collapse mode - whether to collapse borders.
collapse (TextBoxAttrCollapseMode)
None
Sets the corner radius value.
None
Sets the flags.
flags (int)
None
Sets the float mode.
mode (TextBoxAttrFloatStyle)
None
Sets the object maximum size.
None
Sets the object minimum size.
None
Sets the object size.
None
Sets the vertical alignment.
verticalAlignment (TextBoxAttrVerticalAlignment)
None
Sets the whitespace mode.
whitespace (TextBoxAttrWhitespaceMode)
None
Equality test.
attr (wx.richtext.TextBoxAttr)
bool
See GetBottomBorder
See GetBottomMargin
See GetBottomOutline
See GetBottomPadding
See GetBoxStyleName and SetBoxStyleName
See GetClearMode and SetClearMode
See GetCollapseBorders and SetCollapseBorders
See GetCornerRadius and SetCornerRadius
See GetFloatMode and SetFloatMode
See GetLeftBorder
See GetLeftMargin
See GetLeftOutline
See GetLeftPadding
See GetMargins
See GetMaxSize and SetMaxSize
See GetMinSize and SetMinSize
See GetOutline
See GetPadding
See GetPosition
See GetRightBorder
See GetRightMargin
See GetRightOutline
See GetRightPadding
See GetTopBorder
See GetTopMargin
See GetTopOutline
See GetTopPadding
See GetWhitespaceMode and SetWhitespaceMode
A public C++ attribute of type TextAttrBorders .
A public C++ attribute of type string.
A public C++ attribute of type TextBoxAttrClearStyle .
A public C++ attribute of type TextBoxAttrCollapseMode .
A public C++ attribute of type TextAttrDimension .
A public C++ attribute of type int.
A public C++ attribute of type TextBoxAttrFloatStyle .
A public C++ attribute of type TextAttrDimensions .
A public C++ attribute of type TextAttrSize .
A public C++ attribute of type TextAttrSize .
A public C++ attribute of type TextAttrBorders .
A public C++ attribute of type TextAttrDimensions .
A public C++ attribute of type TextAttrDimensions .
A public C++ attribute of type TextAttrShadow .
A public C++ attribute of type TextAttrSize .
A public C++ attribute of type TextBoxAttrVerticalAlignment .
A public C++ attribute of type TextBoxAttrWhitespaceMode .