| Version: 3.3.1

Public Member Functions | Public Attributes | List of all members
wxTextAttrShadow Class Reference
Class List by Category » Rich Text

`#include <wx/richtext/richtextbuffer.h>`

## Detailed Description

A class representing a shadow.

##

Library: wxRichText
Category: Rich Text

See also
  wxRichTextAttr, wxRichTextCtrl

## Public Member Functions
| wxTextAttrShadow ()
| Default constructor. More...
bool | operator== (const wxTextAttrShadow &shadow) const
| Equality operator. More...
void | Reset ()
| Resets the shadow. More...
bool | EqPartial (const wxTextAttrShadow &shadow, bool weakTest=true) const
| Partial equality test. More...
bool | Apply (const wxTextAttrShadow &shadow, const wxTextAttrShadow *compareWith=nullptr)
| Applies the border to this object, but not if the same as compareWith. More...
bool | RemoveStyle (const wxTextAttrShadow &attr)
| Removes the specified attributes from this object. More...
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. More...
void | SetColour (unsigned long colour)
| Sets the shadow colour. More...
void | SetColour (const wxColour &colour)
| Sets the shadow colour. More...
unsigned long | GetColourLong () const
| Gets the colour as a long. More...
wxColour | GetColour () const
| Gets the colour. More...
bool | HasColour () const
| True if the shadow has a valid colour. More...
wxTextAttrDimension & | GetOffsetX ()
| Gets the shadow horizontal offset. More...
const wxTextAttrDimension & | GetOffsetX () const
void | SetOffsetX (const wxTextAttrDimension &offset)
| Sets the shadow horizontal offset. More...
wxTextAttrDimension & | GetOffsetY ()
| Gets the shadow vertical offset. More...
const wxTextAttrDimension & | GetOffsetY () const
void | SetOffsetY (const wxTextAttrDimension &offset)
| Sets the shadow vertical offset. More...
wxTextAttrDimension & | GetSpread ()
| Gets the shadow spread size. More...
const wxTextAttrDimension & | GetSpread () const
void | SetSpread (const wxTextAttrDimension &spread)
| Sets the shadow spread size. More...
wxTextAttrDimension & | GetBlurDistance ()
| Gets the shadow blur distance. More...
const wxTextAttrDimension & | GetBlurDistance () const
void | SetBlurDistance (const wxTextAttrDimension &blur)
| Sets the shadow blur distance. More...
wxTextAttrDimension & | GetOpacity ()
| Gets the shadow opacity. More...
const wxTextAttrDimension & | GetOpacity () const
bool | IsValid () const
| Returns true if the dimension is valid. More...
void | SetValid (bool b)
| Sets the valid flag. More...
int | GetFlags () const
| Returns the border flags. More...
void | SetFlags (int flags)
| Sets the border flags. More...
void | AddFlag (int flag)
| Adds a border flag. More...
void | RemoveFlag (int flag)
| Removes a border flag. More...
void | SetOpacity (const wxTextAttrDimension &opacity)
| Sets the shadow opacity. More...
bool | IsDefault () const
| True if the shadow has no attributes set. More...

## Public Attributes
int | m_flags
unsigned long | m_shadowColour
wxTextAttrDimension | m_offsetX
wxTextAttrDimension | m_offsetY
wxTextAttrDimension | m_spread
wxTextAttrDimension | m_blurDistance
wxTextAttrDimension | m_opacity

## Constructor & Destructor Documentation

## ◆ wxTextAttrShadow()

wxTextAttrShadow::wxTextAttrShadow | ( |  | ) |
| inline

Default constructor.

## Member Function Documentation

## ◆ AddFlag()

void wxTextAttrShadow::AddFlag | ( | int | flag | ) |
| inline

Adds a border flag.

## ◆ Apply()

bool wxTextAttrShadow::Apply | ( | const wxTextAttrShadow & | shadow,
|  | const wxTextAttrShadow * | compareWith = `nullptr`
| ) |  |

Applies the border to this object, but not if the same as compareWith.

## ◆ CollectCommonAttributes()

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.

## ◆ EqPartial()

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.

## ◆ GetBlurDistance() [1/2]

wxTextAttrDimension& wxTextAttrShadow::GetBlurDistance | ( |  | ) |
| inline

Gets the shadow blur distance.

## ◆ GetBlurDistance() [2/2]

const wxTextAttrDimension& wxTextAttrShadow::GetBlurDistance | ( |  | ) | const
| inline

## ◆ GetColour()

wxColour wxTextAttrShadow::GetColour | ( |  | ) | const
| inline

Gets the colour.

## ◆ GetColourLong()

unsigned long wxTextAttrShadow::GetColourLong | ( |  | ) | const
| inline

Gets the colour as a long.

## ◆ GetFlags()

int wxTextAttrShadow::GetFlags | ( |  | ) | const
| inline

Returns the border flags.

## ◆ GetOffsetX() [1/2]

wxTextAttrDimension& wxTextAttrShadow::GetOffsetX | ( |  | ) |
| inline

Gets the shadow horizontal offset.

## ◆ GetOffsetX() [2/2]

const wxTextAttrDimension& wxTextAttrShadow::GetOffsetX | ( |  | ) | const
| inline

## ◆ GetOffsetY() [1/2]

wxTextAttrDimension& wxTextAttrShadow::GetOffsetY | ( |  | ) |
| inline

Gets the shadow vertical offset.

## ◆ GetOffsetY() [2/2]

const wxTextAttrDimension& wxTextAttrShadow::GetOffsetY | ( |  | ) | const
| inline

## ◆ GetOpacity() [1/2]

wxTextAttrDimension& wxTextAttrShadow::GetOpacity | ( |  | ) |
| inline

Gets the shadow opacity.

## ◆ GetOpacity() [2/2]

const wxTextAttrDimension& wxTextAttrShadow::GetOpacity | ( |  | ) | const
| inline

## ◆ GetSpread() [1/2]

wxTextAttrDimension& wxTextAttrShadow::GetSpread | ( |  | ) |
| inline

Gets the shadow spread size.

## ◆ GetSpread() [2/2]

const wxTextAttrDimension& wxTextAttrShadow::GetSpread | ( |  | ) | const
| inline

## ◆ HasColour()

bool wxTextAttrShadow::HasColour | ( |  | ) | const
| inline

True if the shadow has a valid colour.

## ◆ IsDefault()

bool wxTextAttrShadow::IsDefault | ( |  | ) | const
| inline

True if the shadow has no attributes set.

## ◆ IsValid()

bool wxTextAttrShadow::IsValid | ( |  | ) | const
| inline

Returns true if the dimension is valid.

## ◆ operator==()

bool wxTextAttrShadow::operator== | ( | const wxTextAttrShadow & | shadow | ) | const

Equality operator.

## ◆ RemoveFlag()

void wxTextAttrShadow::RemoveFlag | ( | int | flag | ) |
| inline

Removes a border flag.

## ◆ RemoveStyle()

bool wxTextAttrShadow::RemoveStyle | ( | const wxTextAttrShadow & | attr | ) |

Removes the specified attributes from this object.

## ◆ Reset()

void wxTextAttrShadow::Reset | ( |  | ) |

Resets the shadow.

## ◆ SetBlurDistance()

void wxTextAttrShadow::SetBlurDistance | ( | const wxTextAttrDimension & | blur | ) |
| inline

Sets the shadow blur distance.

## ◆ SetColour() [1/2]

void wxTextAttrShadow::SetColour | ( | const wxColour & | colour | ) |
| inline

Sets the shadow colour.

## ◆ SetColour() [2/2]

void wxTextAttrShadow::SetColour | ( | unsigned long | colour | ) |
| inline

Sets the shadow colour.

## ◆ SetFlags()

void wxTextAttrShadow::SetFlags | ( | int | flags | ) |
| inline

Sets the border flags.

## ◆ SetOffsetX()

void wxTextAttrShadow::SetOffsetX | ( | const wxTextAttrDimension & | offset | ) |
| inline

Sets the shadow horizontal offset.

## ◆ SetOffsetY()

void wxTextAttrShadow::SetOffsetY | ( | const wxTextAttrDimension & | offset | ) |
| inline

Sets the shadow vertical offset.

## ◆ SetOpacity()

void wxTextAttrShadow::SetOpacity | ( | const wxTextAttrDimension & | opacity | ) |
| inline

Sets the shadow opacity.

## ◆ SetSpread()

void wxTextAttrShadow::SetSpread | ( | const wxTextAttrDimension & | spread | ) |
| inline

Sets the shadow spread size.

## ◆ SetValid()

void wxTextAttrShadow::SetValid | ( | bool | b | ) |
| inline

Sets the valid flag.

## Member Data Documentation

## ◆ m_blurDistance

wxTextAttrDimension wxTextAttrShadow::m_blurDistance

## ◆ m_flags

int wxTextAttrShadow::m_flags

## ◆ m_offsetX

wxTextAttrDimension wxTextAttrShadow::m_offsetX

## ◆ m_offsetY

wxTextAttrDimension wxTextAttrShadow::m_offsetY

## ◆ m_opacity

wxTextAttrDimension wxTextAttrShadow::m_opacity

## ◆ m_shadowColour

unsigned long wxTextAttrShadow::m_shadowColour

## ◆ m_spread

wxTextAttrDimension wxTextAttrShadow::m_spread