Version: 3.1.2
wxTextAttrShadow Class Reference

#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=NULL)
 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...
 
wxTextAttrDimensionGetOffsetX ()
 Gets the shadow horizontal offset. More...
 
const wxTextAttrDimensionGetOffsetX () const
 
void SetOffsetX (const wxTextAttrDimension &offset)
 Sets the shadow horizontal offset. More...
 
wxTextAttrDimensionGetOffsetY ()
 Gets the shadow vertical offset. More...
 
const wxTextAttrDimensionGetOffsetY () const
 
void SetOffsetY (const wxTextAttrDimension &offset)
 Sets the shadow vertical offset. More...
 
wxTextAttrDimensionGetSpread ()
 Gets the shadow spread size. More...
 
const wxTextAttrDimensionGetSpread () const
 
void SetSpread (const wxTextAttrDimension &spread)
 Sets the shadow spread size. More...
 
wxTextAttrDimensionGetBlurDistance ()
 Gets the shadow blur distance. More...
 
const wxTextAttrDimensionGetBlurDistance () const
 
void SetBlurDistance (const wxTextAttrDimension &blur)
 Sets the shadow blur distance. More...
 
wxTextAttrDimensionGetOpacity ()
 Gets the shadow opacity. More...
 
const wxTextAttrDimensionGetOpacity () 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 ( )
inline

Default constructor.

Member Function Documentation

void wxTextAttrShadow::AddFlag ( int  flag)
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.

wxTextAttrDimension& wxTextAttrShadow::GetBlurDistance ( )
inline

Gets the shadow blur distance.

const wxTextAttrDimension& wxTextAttrShadow::GetBlurDistance ( ) const
inline
wxColour wxTextAttrShadow::GetColour ( ) const
inline

Gets the colour.

unsigned long wxTextAttrShadow::GetColourLong ( ) const
inline

Gets the colour as a long.

int wxTextAttrShadow::GetFlags ( ) const
inline

Returns the border flags.

wxTextAttrDimension& wxTextAttrShadow::GetOffsetX ( )
inline

Gets the shadow horizontal offset.

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

Gets the shadow vertical offset.

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

Gets the shadow opacity.

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

Gets the shadow spread size.

const wxTextAttrDimension& wxTextAttrShadow::GetSpread ( ) const
inline
bool wxTextAttrShadow::HasColour ( ) const
inline

True if the shadow has a valid colour.

bool wxTextAttrShadow::IsDefault ( ) const
inline

True if the shadow has no attributes set.

bool wxTextAttrShadow::IsValid ( ) const
inline

Returns true if the dimension is valid.

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

Equality operator.

void wxTextAttrShadow::RemoveFlag ( int  flag)
inline

Removes a border flag.

bool wxTextAttrShadow::RemoveStyle ( const wxTextAttrShadow attr)

Removes the specified attributes from this object.

void wxTextAttrShadow::Reset ( )

Resets the shadow.

void wxTextAttrShadow::SetBlurDistance ( const wxTextAttrDimension blur)
inline

Sets the shadow blur distance.

void wxTextAttrShadow::SetColour ( unsigned long  colour)
inline

Sets the shadow colour.

void wxTextAttrShadow::SetColour ( const wxColour colour)
inline

Sets the shadow colour.

void wxTextAttrShadow::SetFlags ( int  flags)
inline

Sets the border flags.

void wxTextAttrShadow::SetOffsetX ( const wxTextAttrDimension offset)
inline

Sets the shadow horizontal offset.

void wxTextAttrShadow::SetOffsetY ( const wxTextAttrDimension offset)
inline

Sets the shadow vertical offset.

void wxTextAttrShadow::SetOpacity ( const wxTextAttrDimension opacity)
inline

Sets the shadow opacity.

void wxTextAttrShadow::SetSpread ( const wxTextAttrDimension spread)
inline

Sets the shadow spread size.

void wxTextAttrShadow::SetValid ( bool  b)
inline

Sets the valid flag.

Member Data Documentation

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