Contents Up Previous Next

wxRichTextRange

This class stores beginning and end positions for a range of data.

Derived from

No base class

Include files

<wx/richtext/richtextbuffer.h>

Data structures

Members

wxRichTextRange::wxRichTextRange
wxRichTextRange::~wxRichTextRange
wxRichTextRange::Contains
wxRichTextRange::GetEnd
wxRichTextRange::GetLength
wxRichTextRange::GetStart
wxRichTextRange::FromInternal
wxRichTextRange::IsOutside
wxRichTextRange::IsWithin
wxRichTextRange::LimitTo
wxRichTextRange::SetEnd
wxRichTextRange::SetRange
wxRichTextRange::SetStart
wxRichTextRange::Swap
wxRichTextRange::ToInternal
wxRichTextRange::operator+
wxRichTextRange::operator-
wxRichTextRange::operator=
wxRichTextRange::operator==


wxRichTextRange::wxRichTextRange

wxRichTextRange(long start, long end)

wxRichTextRange(const wxRichTextRange& range)

wxRichTextRange()

Constructors.


wxRichTextRange::~wxRichTextRange

~wxRichTextRange()

Destructor.


wxRichTextRange::Contains

bool Contains(long pos) const

Returns true if the given position is within this range. Does not match if the range is empty.


wxRichTextRange::GetEnd

long GetEnd() const

Returns the end position.


wxRichTextRange::GetLength

long GetLength() const

Returns the length of the range.


wxRichTextRange::GetStart

long GetStart() const

Returns the start of the range.


wxRichTextRange::FromInternal

wxRichTextRange FromInternal() const

Converts the internal range, which uses the first and last character positions of the range, to the API-standard range, whose end is one past the last character in the range. In other words, one is added to the end position.


wxRichTextRange::IsOutside

bool IsOutside(const wxRichTextRange& range) const

Returns true if this range is completely outside range.


wxRichTextRange::IsWithin

bool IsWithin(const wxRichTextRange& range) const

Returns true if this range is completely within range.


wxRichTextRange::LimitTo

bool LimitTo(const wxRichTextRange& range)

Limits this range to be within range.


wxRichTextRange::SetEnd

void SetEnd(long end)

Sets the end of the range.


wxRichTextRange::SetRange

void SetRange(long start, long end)

Sets the range.


wxRichTextRange::SetStart

void SetStart(long start)

Sets the start of the range.


wxRichTextRange::Swap

void Swap()

Swaps the start and end.


wxRichTextRange::ToInternal

wxRichTextRange ToInternal() const

Converts the API-standard range, whose end is one past the last character in the range, to the internal form, which uses the first and last character positions of the range. In other words, one is subtracted from the end position.


wxRichTextRange::operator+

wxRichTextRange operator+(const wxRichTextRange& range) const

Adds range to this range.


wxRichTextRange::operator-

wxRichTextRange operator-(const wxRichTextRange& range) const

Subtracts range from this range.


wxRichTextRange::operator=

void operator=(const wxRichTextRange& range)

Assigns range to this range.


wxRichTextRange::operator==

bool operator==(const wxRichTextRange& range) const

Returns true if range is the same as this range.