#include <wx/richtext/richtextbuffer.h>
A class representing the box attributes of a rich text object.
Public Member Functions | |
| wxTextBoxAttr () | |
| Default constructor. | |
| wxTextBoxAttr (const wxTextBoxAttr &attr) | |
| Copy constructor. | |
| void | Init () |
| Initialises this object. | |
| void | Reset () |
| Resets this object. | |
| bool | operator== (const wxTextBoxAttr &attr) const |
| Equality test. | |
| bool | EqPartial (const wxTextBoxAttr &attr, bool weakTest=true) const |
| Partial equality test, ignoring unset attributes. | |
| bool | Apply (const wxTextBoxAttr &style, const wxTextBoxAttr *compareWith=NULL) |
| Merges the given attributes. | |
| void | CollectCommonAttributes (const wxTextBoxAttr &attr, wxTextBoxAttr &clashingAttr, wxTextBoxAttr &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. | |
| bool | RemoveStyle (const wxTextBoxAttr &attr) |
| Removes the specified attributes from this object. | |
| void | SetFlags (int flags) |
| Sets the flags. | |
| int | GetFlags () const |
| Returns the flags. | |
| bool | HasFlag (wxTextBoxAttrFlags flag) const |
| Is this flag present? | |
| void | RemoveFlag (wxTextBoxAttrFlags flag) |
| Removes this flag. | |
| void | AddFlag (wxTextBoxAttrFlags flag) |
| Adds this flag. | |
| bool | IsDefault () const |
| Returns true if no attributes are set. | |
| wxTextBoxAttrFloatStyle | GetFloatMode () const |
| Returns the float mode. | |
| void | SetFloatMode (wxTextBoxAttrFloatStyle mode) |
| Sets the float mode. | |
| bool | HasFloatMode () const |
| Returns true if float mode is active. | |
| bool | IsFloating () const |
| Returns true if this object is floating. | |
| wxTextBoxAttrClearStyle | GetClearMode () const |
| Returns the clear mode - whether to wrap text after object. | |
| void | SetClearMode (wxTextBoxAttrClearStyle mode) |
| Set the clear mode. | |
| bool | HasClearMode () const |
| Returns true if we have a clear flag. | |
| wxTextBoxAttrCollapseMode | GetCollapseBorders () const |
| Returns the collapse mode - whether to collapse borders. | |
| void | SetCollapseBorders (wxTextBoxAttrCollapseMode collapse) |
| Sets the collapse mode - whether to collapse borders. | |
| bool | HasCollapseBorders () const |
| Returns true if the collapse borders flag is present. | |
| wxTextBoxAttrWhitespaceMode | GetWhitespaceMode () const |
| Returns the whitespace mode. | |
| void | SetWhitespaceMode (wxTextBoxAttrWhitespaceMode whitespace) |
| Sets the whitespace mode. | |
| bool | HasWhitespaceMode () const |
| Returns true if the whitespace flag is present. | |
| bool | HasCornerRadius () const |
| Returns true if the corner radius flag is present. | |
| const wxTextAttrDimension & | GetCornerRadius () const |
| Returns the corner radius value. | |
| wxTextAttrDimension & | GetCornerRadius () |
| void | SetCornerRadius (const wxTextAttrDimension &dim) |
| Sets the corner radius value. | |
| wxTextBoxAttrVerticalAlignment | GetVerticalAlignment () const |
| Returns the vertical alignment. | |
| void | SetVerticalAlignment (wxTextBoxAttrVerticalAlignment verticalAlignment) |
| Sets the vertical alignment. | |
| bool | HasVerticalAlignment () const |
| Returns true if a vertical alignment flag is present. | |
| wxTextAttrDimensions & | GetMargins () |
| Returns the margin values. | |
| const wxTextAttrDimensions & | GetMargins () const |
| wxTextAttrDimension & | GetLeftMargin () |
| Returns the left margin. | |
| const wxTextAttrDimension & | GetLeftMargin () const |
| wxTextAttrDimension & | GetRightMargin () |
| Returns the right margin. | |
| const wxTextAttrDimension & | GetRightMargin () const |
| wxTextAttrDimension & | GetTopMargin () |
| Returns the top margin. | |
| const wxTextAttrDimension & | GetTopMargin () const |
| wxTextAttrDimension & | GetBottomMargin () |
| Returns the bottom margin. | |
| const wxTextAttrDimension & | GetBottomMargin () const |
| wxTextAttrDimensions & | GetPosition () |
| Returns the position. | |
| const wxTextAttrDimensions & | GetPosition () const |
| wxTextAttrDimension & | GetLeft () |
| Returns the left position. | |
| const wxTextAttrDimension & | GetLeft () const |
| wxTextAttrDimension & | GetRight () |
| Returns the right position. | |
| const wxTextAttrDimension & | GetRight () const |
| wxTextAttrDimension & | GetTop () |
| Returns the top position. | |
| const wxTextAttrDimension & | GetTop () const |
| wxTextAttrDimension & | GetBottom () |
| Returns the bottom position. | |
| const wxTextAttrDimension & | GetBottom () const |
| wxTextAttrDimensions & | GetPadding () |
| Returns the padding values. | |
| const wxTextAttrDimensions & | GetPadding () const |
| wxTextAttrDimension & | GetLeftPadding () |
| Returns the left padding value. | |
| const wxTextAttrDimension & | GetLeftPadding () const |
| wxTextAttrDimension & | GetRightPadding () |
| Returns the right padding value. | |
| const wxTextAttrDimension & | GetRightPadding () const |
| wxTextAttrDimension & | GetTopPadding () |
| Returns the top padding value. | |
| const wxTextAttrDimension & | GetTopPadding () const |
| wxTextAttrDimension & | GetBottomPadding () |
| Returns the bottom padding value. | |
| const wxTextAttrDimension & | GetBottomPadding () const |
| wxTextAttrBorders & | GetBorder () |
| Returns the borders. | |
| const wxTextAttrBorders & | GetBorder () const |
| wxTextAttrBorder & | GetLeftBorder () |
| Returns the left border. | |
| const wxTextAttrBorder & | GetLeftBorder () const |
| wxTextAttrBorder & | GetTopBorder () |
| Returns the top border. | |
| const wxTextAttrBorder & | GetTopBorder () const |
| wxTextAttrBorder & | GetRightBorder () |
| Returns the right border. | |
| const wxTextAttrBorder & | GetRightBorder () const |
| wxTextAttrBorder & | GetBottomBorder () |
| Returns the bottom border. | |
| const wxTextAttrBorder & | GetBottomBorder () const |
| wxTextAttrBorders & | GetOutline () |
| Returns the outline. | |
| const wxTextAttrBorders & | GetOutline () const |
| wxTextAttrBorder & | GetLeftOutline () |
| Returns the left outline. | |
| const wxTextAttrBorder & | GetLeftOutline () const |
| wxTextAttrBorder & | GetTopOutline () |
| Returns the top outline. | |
| const wxTextAttrBorder & | GetTopOutline () const |
| wxTextAttrBorder & | GetRightOutline () |
| Returns the right outline. | |
| const wxTextAttrBorder & | GetRightOutline () const |
| wxTextAttrBorder & | GetBottomOutline () |
| Returns the bottom outline. | |
| const wxTextAttrBorder & | GetBottomOutline () const |
| wxTextAttrSize & | GetSize () |
| Returns the object size. | |
| const wxTextAttrSize & | GetSize () const |
| wxTextAttrSize & | GetMinSize () |
| Returns the object minimum size. | |
| const wxTextAttrSize & | GetMinSize () const |
| wxTextAttrSize & | GetMaxSize () |
| Returns the object maximum size. | |
| const wxTextAttrSize & | GetMaxSize () const |
| void | SetSize (const wxTextAttrSize &sz) |
| Sets the object size. | |
| void | SetMinSize (const wxTextAttrSize &sz) |
| Sets the object minimum size. | |
| void | SetMaxSize (const wxTextAttrSize &sz) |
| Sets the object maximum size. | |
| wxTextAttrDimension & | GetWidth () |
| Returns the object width. | |
| const wxTextAttrDimension & | GetWidth () const |
| wxTextAttrDimension & | GetHeight () |
| Returns the object height. | |
| const wxTextAttrDimension & | GetHeight () const |
| const wxString & | GetBoxStyleName () const |
| Returns the box style name. | |
| void | SetBoxStyleName (const wxString &name) |
| Sets the box style name. | |
| bool | HasBoxStyleName () const |
| Returns true if the box style name is present. | |
| wxTextAttrShadow & | GetShadow () |
| Returns the box shadow attributes. | |
| const wxTextAttrShadow & | GetShadow () const |
|
inline |
Default constructor.
|
inline |
Copy constructor.
|
inline |
Adds this flag.
| bool wxTextBoxAttr::Apply | ( | const wxTextBoxAttr & | style, |
| const wxTextBoxAttr * | compareWith = NULL ) |
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.
| void wxTextBoxAttr::CollectCommonAttributes | ( | const wxTextBoxAttr & | attr, |
| wxTextBoxAttr & | clashingAttr, | ||
| wxTextBoxAttr & | 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.
| bool wxTextBoxAttr::EqPartial | ( | const wxTextBoxAttr & | attr, |
| bool | weakTest = true ) const |
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.
|
inline |
Returns the borders.
|
inline |
|
inline |
Returns the bottom position.
|
inline |
|
inline |
Returns the bottom border.
|
inline |
|
inline |
Returns the bottom margin.
|
inline |
|
inline |
Returns the bottom outline.
|
inline |
|
inline |
Returns the bottom padding value.
|
inline |
|
inline |
Returns the box style name.
|
inline |
Returns the clear mode - whether to wrap text after object.
Currently unimplemented.
|
inline |
Returns the collapse mode - whether to collapse borders.
|
inline |
|
inline |
Returns the corner radius value.
|
inline |
Returns the flags.
|
inline |
Returns the float mode.
|
inline |
Returns the object height.
|
inline |
|
inline |
Returns the left position.
|
inline |
|
inline |
Returns the left border.
|
inline |
|
inline |
Returns the left margin.
|
inline |
|
inline |
Returns the left outline.
|
inline |
|
inline |
Returns the left padding value.
|
inline |
|
inline |
Returns the margin values.
|
inline |
|
inline |
Returns the object maximum size.
|
inline |
|
inline |
Returns the object minimum size.
|
inline |
|
inline |
Returns the outline.
|
inline |
|
inline |
Returns the padding values.
|
inline |
|
inline |
Returns the position.
|
inline |
|
inline |
Returns the right position.
|
inline |
|
inline |
Returns the right border.
|
inline |
|
inline |
Returns the right margin.
|
inline |
|
inline |
Returns the right outline.
|
inline |
|
inline |
Returns the right padding value.
|
inline |
|
inline |
Returns the box shadow attributes.
|
inline |
|
inline |
Returns the object size.
|
inline |
|
inline |
Returns the top position.
|
inline |
|
inline |
Returns the top border.
|
inline |
|
inline |
Returns the top margin.
|
inline |
|
inline |
Returns the top outline.
|
inline |
|
inline |
Returns the top padding value.
|
inline |
|
inline |
Returns the vertical alignment.
|
inline |
Returns the whitespace mode.
|
inline |
Returns the object width.
|
inline |
|
inline |
Returns true if the box style name is present.
|
inline |
Returns true if we have a clear flag.
|
inline |
Returns true if the collapse borders flag is present.
|
inline |
Returns true if the corner radius flag is present.
|
inline |
Is this flag present?
|
inline |
Returns true if float mode is active.
|
inline |
Returns true if a vertical alignment flag is present.
|
inline |
Returns true if the whitespace flag is present.
|
inline |
Initialises this object.
| bool wxTextBoxAttr::IsDefault | ( | ) | const |
Returns true if no attributes are set.
|
inline |
Returns true if this object is floating.
| bool wxTextBoxAttr::operator== | ( | const wxTextBoxAttr & | attr | ) | const |
Equality test.
|
inline |
Removes this flag.
| bool wxTextBoxAttr::RemoveStyle | ( | const wxTextBoxAttr & | attr | ) |
Removes the specified attributes from this object.
| void wxTextBoxAttr::Reset | ( | ) |
Resets this object.
|
inline |
Sets the box style name.
|
inline |
Set the clear mode.
Currently unimplemented.
|
inline |
Sets the collapse mode - whether to collapse borders.
|
inline |
Sets the corner radius value.
|
inline |
Sets the flags.
|
inline |
Sets the float mode.
|
inline |
Sets the object maximum size.
|
inline |
Sets the object minimum size.
|
inline |
Sets the object size.
|
inline |
Sets the vertical alignment.
|
inline |
Sets the whitespace mode.
| wxTextAttrBorders wxTextBoxAttr::m_border |
| wxString wxTextBoxAttr::m_boxStyleName |
| wxTextBoxAttrClearStyle wxTextBoxAttr::m_clearMode |
| wxTextBoxAttrCollapseMode wxTextBoxAttr::m_collapseMode |
| wxTextAttrDimension wxTextBoxAttr::m_cornerRadius |
| int wxTextBoxAttr::m_flags |
| wxTextBoxAttrFloatStyle wxTextBoxAttr::m_floatMode |
| wxTextAttrDimensions wxTextBoxAttr::m_margins |
| wxTextAttrSize wxTextBoxAttr::m_maxSize |
| wxTextAttrSize wxTextBoxAttr::m_minSize |
| wxTextAttrBorders wxTextBoxAttr::m_outline |
| wxTextAttrDimensions wxTextBoxAttr::m_padding |
| wxTextAttrDimensions wxTextBoxAttr::m_position |
| wxTextAttrShadow wxTextBoxAttr::m_shadow |
| wxTextAttrSize wxTextBoxAttr::m_size |
| wxTextBoxAttrVerticalAlignment wxTextBoxAttr::m_verticalAlignment |
| wxTextBoxAttrWhitespaceMode wxTextBoxAttr::m_whitespaceMode |