wxRichTextRange Class Reference
[Rich Text]

#include <wx/richtext/richtextbuffer.h>

List of all members.


Detailed Description

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

Library:  wxRichText

Category:  Rich Text

Public Member Functions

 ~wxRichTextRange ()
bool Contains (long pos) const
wxRichTextRange FromInternal () const
long GetEnd () const
long GetLength () const
long GetStart () const
bool IsOutside (const wxRichTextRange &range) const
bool IsWithin (const wxRichTextRange &range) const
bool LimitTo (const wxRichTextRange &range)
void SetEnd (long end)
void SetRange (long start, long end)
void SetStart (long start)
void Swap ()
wxRichTextRange ToInternal () const
wxRichTextRange operator+ (const wxRichTextRange &range) const
wxRichTextRange operator- (const wxRichTextRange &range) const
void operator= (const wxRichTextRange &range)
bool operator== (const wxRichTextRange &range) const
 wxRichTextRange (long start, long end)
 wxRichTextRange (const wxRichTextRange &range)
 wxRichTextRange ()

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.

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.

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.



wxWidgets logo

[ top ]