Public Member Functions | Public Attributes

wxTextAttrDimensions Class Reference
[Rich Text]

#include </home/zeitlin/src/wx/git/interface/wx/richtext/richtextbuffer.h>


Detailed Description

A class for left, right, top and bottom dimensions.

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

Public Member Functions

 wxTextAttrDimensions ()
 Default constructor.
void Reset ()
 Resets the value and flags for all dimensions.
bool operator== (const wxTextAttrDimensions &dims) const
 Equality operator.
bool EqPartial (const wxTextAttrDimensions &dims) const
 Partial equality test.
bool Apply (const wxTextAttrDimensions &dims, const wxTextAttrDimensions *compareWith=NULL)
 Apply border to 'this', but not if the same as compareWith.
void CollectCommonAttributes (const wxTextAttrDimensions &attr, wxTextAttrDimensions &clashingAttr, wxTextAttrDimensions &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 RemoveStyle (const wxTextAttrDimensions &attr)
 Remove specified attributes from this object.
const wxTextAttrDimensionGetLeft () const
 Gets the left dimension.
wxTextAttrDimensionGetLeft ()
const wxTextAttrDimensionGetRight () const
 Gets the right dimension.
wxTextAttrDimensionGetRight ()
const wxTextAttrDimensionGetTop () const
 Gets the top dimension.
wxTextAttrDimensionGetTop ()
const wxTextAttrDimensionGetBottom () const
 Gets the bottom dimension.
wxTextAttrDimensionGetBottom ()

Public Attributes

wxTextAttrDimension m_left
wxTextAttrDimension m_top
wxTextAttrDimension m_right
wxTextAttrDimension m_bottom

List of all members.


Constructor & Destructor Documentation

wxTextAttrDimensions::wxTextAttrDimensions (  )  [inline]

Default constructor.


Member Function Documentation

bool wxTextAttrDimensions::Apply ( const wxTextAttrDimensions dims,
const wxTextAttrDimensions compareWith = NULL 
)

Apply border to 'this', but not if the same as compareWith.

void wxTextAttrDimensions::CollectCommonAttributes ( const wxTextAttrDimensions attr,
wxTextAttrDimensions clashingAttr,
wxTextAttrDimensions 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 wxTextAttrDimensions::EqPartial ( const wxTextAttrDimensions dims  )  const

Partial equality test.

const wxTextAttrDimension& wxTextAttrDimensions::GetBottom (  )  const [inline]

Gets the bottom dimension.

wxTextAttrDimension& wxTextAttrDimensions::GetBottom (  )  [inline]
wxTextAttrDimension& wxTextAttrDimensions::GetLeft (  )  [inline]
const wxTextAttrDimension& wxTextAttrDimensions::GetLeft (  )  const [inline]

Gets the left dimension.

const wxTextAttrDimension& wxTextAttrDimensions::GetRight (  )  const [inline]

Gets the right dimension.

wxTextAttrDimension& wxTextAttrDimensions::GetRight (  )  [inline]
wxTextAttrDimension& wxTextAttrDimensions::GetTop (  )  [inline]
const wxTextAttrDimension& wxTextAttrDimensions::GetTop (  )  const [inline]

Gets the top dimension.

bool wxTextAttrDimensions::operator== ( const wxTextAttrDimensions dims  )  const [inline]

Equality operator.

bool wxTextAttrDimensions::RemoveStyle ( const wxTextAttrDimensions attr  ) 

Remove specified attributes from this object.

void wxTextAttrDimensions::Reset (  )  [inline]

Resets the value and flags for all dimensions.


Member Data Documentation

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines



wxWidgets logo

[ top ]