wxRichTextRange Class Reference
[Rich Text]

#include <wx/richtext/richtextbuffer.h>


Detailed Description

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

Library:  wxRichText
Category:  Rich Text

Public Member Functions

 ~wxRichTextRange ()
 Destructor.
bool Contains (long pos) const
 Returns true if the given position is within this range.
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.
long GetEnd () const
 Returns the end position.
long GetLength () const
 Returns the length of the range.
long GetStart () const
 Returns the start of the range.
bool IsOutside (const wxRichTextRange &range) const
 Returns true if this range is completely outside range.
bool IsWithin (const wxRichTextRange &range) const
 Returns true if this range is completely within range.
bool LimitTo (const wxRichTextRange &range)
 Limits this range to be within range.
void SetEnd (long end)
 Sets the end of the range.
void SetRange (long start, long end)
 Sets the range.
void SetStart (long start)
 Sets the start of the range.
void Swap ()
 Swaps the start and end.
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.
wxRichTextRange operator+ (const wxRichTextRange &range) const
 Adds range to this range.
wxRichTextRange operator- (const wxRichTextRange &range) const
 Subtracts range from this range.
void operator= (const wxRichTextRange &range)
 Assigns range to this range.
bool operator== (const wxRichTextRange &range) const
 Returns true if range is the same as this range.

 wxRichTextRange (long start, long end)
 Constructors.
 wxRichTextRange (const wxRichTextRange &range)
 Constructors.
 wxRichTextRange ()
 Constructors.

List of all members.


Constructor & Destructor Documentation

wxRichTextRange::wxRichTextRange ( long  start,
long  end 
)

Constructors.

wxRichTextRange::wxRichTextRange ( const wxRichTextRange range  ) 

Constructors.

wxRichTextRange::wxRichTextRange (  ) 

Constructors.

wxRichTextRange::~wxRichTextRange (  ) 

Destructor.


Member Function Documentation

bool wxRichTextRange::Contains ( long  pos  )  const

Returns true if the given position is within this range.

Does not match if the range is empty.

wxRichTextRange 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.

long wxRichTextRange::GetEnd (  )  const

Returns the end position.

long wxRichTextRange::GetLength (  )  const

Returns the length of the range.

long wxRichTextRange::GetStart (  )  const

Returns the start of the range.

bool wxRichTextRange::IsOutside ( const wxRichTextRange range  )  const

Returns true if this range is completely outside range.

bool wxRichTextRange::IsWithin ( const wxRichTextRange range  )  const

Returns true if this range is completely within range.

bool wxRichTextRange::LimitTo ( const wxRichTextRange range  ) 

Limits this range to be within range.

wxRichTextRange wxRichTextRange::operator+ ( const wxRichTextRange range  )  const

Adds range to this range.

wxRichTextRange wxRichTextRange::operator- ( const wxRichTextRange range  )  const

Subtracts range from this range.

void wxRichTextRange::operator= ( const wxRichTextRange range  ) 

Assigns range to this range.

bool wxRichTextRange::operator== ( const wxRichTextRange range  )  const

Returns true if range is the same as this range.

void wxRichTextRange::SetEnd ( long  end  ) 

Sets the end of the range.

void wxRichTextRange::SetRange ( long  start,
long  end 
)

Sets the range.

void wxRichTextRange::SetStart ( long  start  ) 

Sets the start of the range.

void wxRichTextRange::Swap (  ) 

Swaps the start and end.

wxRichTextRange 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.

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines



wxWidgets logo

[ top ]