#include <wx/richtext/richtextbuffer.h>
A class representing a shadow.
Public Member Functions | |
wxTextAttrShadow () | |
Default constructor. | |
bool | operator== (const wxTextAttrShadow &shadow) const |
Equality operator. | |
void | Reset () |
Resets the shadow. | |
bool | EqPartial (const wxTextAttrShadow &shadow, bool weakTest=true) const |
Partial equality test. | |
bool | Apply (const wxTextAttrShadow &shadow, const wxTextAttrShadow *compareWith=NULL) |
Applies the border to this object, but not if the same as compareWith. | |
bool | RemoveStyle (const wxTextAttrShadow &attr) |
Removes the specified attributes from this object. | |
void | CollectCommonAttributes (const wxTextAttrShadow &attr, wxTextAttrShadow &clashingAttr, wxTextAttrShadow &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. | |
void | SetColour (unsigned long colour) |
Sets the shadow colour. | |
void | SetColour (const wxColour &colour) |
Sets the shadow colour. | |
unsigned long | GetColourLong () const |
Gets the colour as a long. | |
wxColour | GetColour () const |
Gets the colour. | |
bool | HasColour () const |
True if the shadow has a valid colour. | |
wxTextAttrDimension & | GetOffsetX () |
Gets the shadow horizontal offset. | |
const wxTextAttrDimension & | GetOffsetX () const |
void | SetOffsetX (const wxTextAttrDimension &offset) |
Sets the shadow horizontal offset. | |
wxTextAttrDimension & | GetOffsetY () |
Gets the shadow vertical offset. | |
const wxTextAttrDimension & | GetOffsetY () const |
void | SetOffsetY (const wxTextAttrDimension &offset) |
Sets the shadow vertical offset. | |
wxTextAttrDimension & | GetSpread () |
Gets the shadow spread size. | |
const wxTextAttrDimension & | GetSpread () const |
void | SetSpread (const wxTextAttrDimension &spread) |
Sets the shadow spread size. | |
wxTextAttrDimension & | GetBlurDistance () |
Gets the shadow blur distance. | |
const wxTextAttrDimension & | GetBlurDistance () const |
void | SetBlurDistance (const wxTextAttrDimension &blur) |
Sets the shadow blur distance. | |
wxTextAttrDimension & | GetOpacity () |
Gets the shadow opacity. | |
const wxTextAttrDimension & | GetOpacity () const |
bool | IsValid () const |
Returns true if the dimension is valid. | |
void | SetValid (bool b) |
Sets the valid flag. | |
int | GetFlags () const |
Returns the border flags. | |
void | SetFlags (int flags) |
Sets the border flags. | |
void | AddFlag (int flag) |
Adds a border flag. | |
void | RemoveFlag (int flag) |
Removes a border flag. | |
void | SetOpacity (const wxTextAttrDimension &opacity) |
Sets the shadow opacity. | |
bool | IsDefault () const |
True if the shadow has no attributes set. | |
Public Attributes | |
int | m_flags |
unsigned long | m_shadowColour |
wxTextAttrDimension | m_offsetX |
wxTextAttrDimension | m_offsetY |
wxTextAttrDimension | m_spread |
wxTextAttrDimension | m_blurDistance |
wxTextAttrDimension | m_opacity |
|
inline |
Default constructor.
|
inline |
Adds a border flag.
bool wxTextAttrShadow::Apply | ( | const wxTextAttrShadow & | shadow, |
const wxTextAttrShadow * | compareWith = NULL ) |
Applies the border to this object, but not if the same as compareWith.
void wxTextAttrShadow::CollectCommonAttributes | ( | const wxTextAttrShadow & | attr, |
wxTextAttrShadow & | clashingAttr, | ||
wxTextAttrShadow & | 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 wxTextAttrShadow::EqPartial | ( | const wxTextAttrShadow & | shadow, |
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 border are present. If weakTest is false , the function will fail if an attribute is present in border but not in this object.
|
inline |
Gets the shadow blur distance.
|
inline |
|
inline |
Gets the colour.
|
inline |
Gets the colour as a long.
|
inline |
Returns the border flags.
|
inline |
Gets the shadow horizontal offset.
|
inline |
|
inline |
Gets the shadow vertical offset.
|
inline |
|
inline |
Gets the shadow opacity.
|
inline |
|
inline |
Gets the shadow spread size.
|
inline |
|
inline |
True if the shadow has a valid colour.
|
inline |
True if the shadow has no attributes set.
|
inline |
Returns true if the dimension is valid.
bool wxTextAttrShadow::operator== | ( | const wxTextAttrShadow & | shadow | ) | const |
Equality operator.
|
inline |
Removes a border flag.
bool wxTextAttrShadow::RemoveStyle | ( | const wxTextAttrShadow & | attr | ) |
Removes the specified attributes from this object.
void wxTextAttrShadow::Reset | ( | ) |
Resets the shadow.
|
inline |
Sets the shadow blur distance.
|
inline |
Sets the shadow colour.
|
inline |
Sets the shadow colour.
|
inline |
Sets the border flags.
|
inline |
Sets the shadow horizontal offset.
|
inline |
Sets the shadow vertical offset.
|
inline |
Sets the shadow opacity.
|
inline |
Sets the shadow spread size.
|
inline |
Sets the valid flag.
wxTextAttrDimension wxTextAttrShadow::m_blurDistance |
int wxTextAttrShadow::m_flags |
wxTextAttrDimension wxTextAttrShadow::m_offsetX |
wxTextAttrDimension wxTextAttrShadow::m_offsetY |
wxTextAttrDimension wxTextAttrShadow::m_opacity |
unsigned long wxTextAttrShadow::m_shadowColour |
wxTextAttrDimension wxTextAttrShadow::m_spread |