#include <wx/richtext/richtextbuffer.h>
A class representing a rich text dimension, including units and position.
- See also
- wxRichTextAttr, wxRichTextCtrl, wxTextAttrDimensions
|
| wxTextAttrDimension () |
| Default constructor.
|
|
| wxTextAttrDimension (int value, wxTextAttrUnits units=wxTEXT_ATTR_UNITS_TENTHS_MM) |
| Constructor taking value and units flag.
|
|
void | Reset () |
| Resets the dimension value and flags.
|
|
bool | EqPartial (const wxTextAttrDimension &dim, bool weakTest=true) const |
| Partial equality test.
|
|
bool | Apply (const wxTextAttrDimension &dim, const wxTextAttrDimension *compareWith=NULL) |
| Apply the dimension, but not those identical to compareWith if present.
|
|
void | CollectCommonAttributes (const wxTextAttrDimension &attr, wxTextAttrDimension &clashingAttr, wxTextAttrDimension &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 | operator== (const wxTextAttrDimension &dim) const |
| Equality operator.
|
|
int | GetValue () const |
| Returns the integer value of the dimension.
|
|
float | GetValueMM () const |
| Returns the floating-pointing value of the dimension in mm.
|
|
void | SetValueMM (float value) |
| Sets the value of the dimension in mm.
|
|
void | SetValue (int value) |
| Sets the integer value of the dimension.
|
|
void | SetValue (int value, wxTextAttrDimensionFlags flags) |
| Sets the integer value of the dimension, passing dimension flags.
|
|
void | SetValue (int value, wxTextAttrUnits units) |
| Sets the integer value and units.
|
|
void | SetValue (const wxTextAttrDimension &dim) |
| Sets the dimension.
|
|
wxTextAttrUnits | GetUnits () const |
| Gets the units of the dimension.
|
|
void | SetUnits (wxTextAttrUnits units) |
| Sets the units of the dimension.
|
|
wxTextBoxAttrPosition | GetPosition () const |
| Gets the position flags.
|
|
void | SetPosition (wxTextBoxAttrPosition pos) |
| Sets the position flags.
|
|
bool | IsValid () const |
| Returns true if the dimension is valid.
|
|
void | SetValid (bool b) |
| Sets the valid flag.
|
|
wxTextAttrDimensionFlags | GetFlags () const |
| Gets the dimension flags.
|
|
void | SetFlags (wxTextAttrDimensionFlags flags) |
| Sets the dimension flags.
|
|
◆ wxTextAttrDimension() [1/2]
wxTextAttrDimension::wxTextAttrDimension |
( |
| ) |
|
|
inline |
◆ wxTextAttrDimension() [2/2]
Constructor taking value and units flag.
◆ Apply()
Apply the dimension, but not those identical to compareWith if present.
◆ 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()
bool wxTextAttrDimension::EqPartial |
( |
const wxTextAttrDimension & | dim, |
|
|
bool | weakTest = true ) const |
Partial equality test.
If weakTest is true , attributes of this object do not have to be present if those attributes of dim are present. If weakTest is false , the function will fail if an attribute is present in dim but not in this object.
◆ GetFlags()
Gets the dimension flags.
◆ GetPosition()
◆ GetUnits()
Gets the units of the dimension.
◆ GetValue()
int wxTextAttrDimension::GetValue |
( |
| ) |
const |
|
inline |
Returns the integer value of the dimension.
◆ GetValueMM()
float wxTextAttrDimension::GetValueMM |
( |
| ) |
const |
|
inline |
Returns the floating-pointing value of the dimension in mm.
◆ IsValid()
bool wxTextAttrDimension::IsValid |
( |
| ) |
const |
|
inline |
Returns true if the dimension is valid.
◆ operator==()
◆ Reset()
void wxTextAttrDimension::Reset |
( |
| ) |
|
|
inline |
Resets the dimension value and flags.
◆ SetFlags()
Sets the dimension flags.
◆ SetPosition()
◆ SetUnits()
Sets the units of the dimension.
◆ SetValid()
void wxTextAttrDimension::SetValid |
( |
bool | b | ) |
|
|
inline |
◆ SetValue() [1/4]
◆ SetValue() [2/4]
void wxTextAttrDimension::SetValue |
( |
int | value | ) |
|
|
inline |
Sets the integer value of the dimension.
◆ SetValue() [3/4]
Sets the integer value of the dimension, passing dimension flags.
◆ SetValue() [4/4]
Sets the integer value and units.
◆ SetValueMM()
void wxTextAttrDimension::SetValueMM |
( |
float | value | ) |
|
|
inline |
Sets the value of the dimension in mm.
◆ m_flags
◆ m_value
int wxTextAttrDimension::m_value |