Version: 3.1.2
wxTextAttrBorders Class Reference

#include <wx/richtext/richtextbuffer.h>

Detailed Description

A class representing a rich text object's borders.

Library:  wxRichText
Category:  Rich Text
See also
wxRichTextAttr, wxRichTextCtrl, wxRichTextAttrBorder

Public Member Functions

 wxTextAttrBorders ()
 Default constructor. More...
 
bool operator== (const wxTextAttrBorders &borders) const
 Equality operator. More...
 
void SetStyle (int style)
 Sets the style of all borders. More...
 
void SetColour (unsigned long colour)
 Sets colour of all borders. More...
 
void SetColour (const wxColour &colour)
 Sets the colour for all borders. More...
 
void SetWidth (const wxTextAttrDimension &width)
 Sets the width of all borders. More...
 
void SetWidth (int value, wxTextAttrUnits units=wxTEXT_ATTR_UNITS_TENTHS_MM)
 Sets the width of all borders. More...
 
void Reset ()
 Resets all borders. More...
 
bool EqPartial (const wxTextAttrBorders &borders, bool weakTest=true) const
 Partial equality test. More...
 
bool Apply (const wxTextAttrBorders &borders, const wxTextAttrBorders *compareWith=NULL)
 Applies border to this object, but not if the same as compareWith. More...
 
bool RemoveStyle (const wxTextAttrBorders &attr)
 Removes the specified attributes from this object. More...
 
void CollectCommonAttributes (const wxTextAttrBorders &attr, wxTextAttrBorders &clashingAttr, wxTextAttrBorders &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...
 
bool IsValid () const
 Returns true if at least one border is valid. More...
 
const wxTextAttrBorderGetLeft () const
 Returns the left border. More...
 
wxTextAttrBorderGetLeft ()
 
const wxTextAttrBorderGetRight () const
 Returns the right border. More...
 
wxTextAttrBorderGetRight ()
 
const wxTextAttrBorderGetTop () const
 Returns the top border. More...
 
wxTextAttrBorderGetTop ()
 
const wxTextAttrBorderGetBottom () const
 Returns the bottom border. More...
 
wxTextAttrBorderGetBottom ()
 

Public Attributes

wxTextAttrBorder m_left
 
wxTextAttrBorder m_right
 
wxTextAttrBorder m_top
 
wxTextAttrBorder m_bottom
 

Constructor & Destructor Documentation

wxTextAttrBorders::wxTextAttrBorders ( )
inline

Default constructor.

Member Function Documentation

bool wxTextAttrBorders::Apply ( const wxTextAttrBorders borders,
const wxTextAttrBorders compareWith = NULL 
)

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

void wxTextAttrBorders::CollectCommonAttributes ( const wxTextAttrBorders attr,
wxTextAttrBorders clashingAttr,
wxTextAttrBorders 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 wxTextAttrBorders::EqPartial ( const wxTextAttrBorders borders,
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 borders are present. If weakTest is false, the function will fail if an attribute is present in borders but not in this object.

const wxTextAttrBorder& wxTextAttrBorders::GetBottom ( ) const
inline

Returns the bottom border.

wxTextAttrBorder& wxTextAttrBorders::GetBottom ( )
inline
const wxTextAttrBorder& wxTextAttrBorders::GetLeft ( ) const
inline

Returns the left border.

wxTextAttrBorder& wxTextAttrBorders::GetLeft ( )
inline
const wxTextAttrBorder& wxTextAttrBorders::GetRight ( ) const
inline

Returns the right border.

wxTextAttrBorder& wxTextAttrBorders::GetRight ( )
inline
const wxTextAttrBorder& wxTextAttrBorders::GetTop ( ) const
inline

Returns the top border.

wxTextAttrBorder& wxTextAttrBorders::GetTop ( )
inline
bool wxTextAttrBorders::IsValid ( ) const
inline

Returns true if at least one border is valid.

bool wxTextAttrBorders::operator== ( const wxTextAttrBorders borders) const
inline

Equality operator.

bool wxTextAttrBorders::RemoveStyle ( const wxTextAttrBorders attr)

Removes the specified attributes from this object.

void wxTextAttrBorders::Reset ( )
inline

Resets all borders.

void wxTextAttrBorders::SetColour ( unsigned long  colour)

Sets colour of all borders.

void wxTextAttrBorders::SetColour ( const wxColour colour)

Sets the colour for all borders.

void wxTextAttrBorders::SetStyle ( int  style)

Sets the style of all borders.

void wxTextAttrBorders::SetWidth ( const wxTextAttrDimension width)

Sets the width of all borders.

void wxTextAttrBorders::SetWidth ( int  value,
wxTextAttrUnits  units = wxTEXT_ATTR_UNITS_TENTHS_MM 
)
inline

Sets the width of all borders.

Member Data Documentation

wxTextAttrBorder wxTextAttrBorders::m_bottom
wxTextAttrBorder wxTextAttrBorders::m_left
wxTextAttrBorder wxTextAttrBorders::m_right
wxTextAttrBorder wxTextAttrBorders::m_top