wx.richtext.RichTextRange¶

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

Class Hierarchy¶

Inheritance diagram for class RichTextRange:

Methods Summary¶

`__init__`	Default constructor.
`Contains`	Returns `True` if pos was within the range.
`FromInternal`	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.
`Get`	Return the start and end properties as a tuple.
`GetEnd`	Gets the end position.
`GetIM`	Returns an immutable representation of the `wx.RichTextRange` object, based on `namedtuple`.
`GetLength`	Gets the length of the range.
`GetStart`	Returns the start position.
`IsOutside`	Returns `True` if this range is completely outside range.
`IsWithin`	Returns `True` if this range is completely within range.
`LimitTo`	Limit this range to be within range.
`SetEnd`	Sets the end position.
`SetRange`	Sets the range start and end positions.
`SetStart`	Sets the start position.
`Swap`	Swaps the start and end.
`ToInternal`	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.
`__bool__`
`__getitem__`
`__len__`
`__nonzero__`
`__reduce__`
`__repr__`
`__setitem__`
`__str__`
`__ne__`	Inequality operator.
`__add__`	Adds a range to this range.
`__sub__`	Subtracts a range from this range.
`__eq__`	Equality operator.

Properties Summary¶

`End`	See `GetEnd` and `SetEnd`
`Length`	See `GetLength`
`Start`	See `GetStart` and `SetStart`

Class API¶

class wx.richtext.RichTextRange(object)¶

Possible constructors:

RichTextRange() -> None

RichTextRange(start : int, end : int) -> None

RichTextRange(range : RichTextRange) -> None

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

Methods¶

__init__(self, *args, **kw)¶

Overloaded Implementations:

__init__ (self)

Default constructor.

Return type:: None

__init__ (self, start : int, end : int)

Constructor taking start and end positions.

Parameters:

start (long)
end (long)

Return type:

None

__init__ (self, range : RichTextRange)

Copy constructor.

Parameters:: range (wx.richtext.RichTextRange)
Return type:: None

Contains(self, pos: int)¶

Returns True if pos was within the range.

Does not match if the range is empty.

Parameters:: pos (long)
Return type:: bool

FromInternal(self)¶

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. (n, n+1) is the range of a single character.

Return type:: wx.richtext.RichTextRange

Get(self)¶

Return the start and end properties as a tuple.

Return type:: tuple
Returns:: ( start, end )

GetEnd(self)¶

Gets the end position.

Return type:: int

GetIM(self)¶

Returns an immutable representation of the wx.RichTextRange object, based on namedtuple.

This new object is hashable and can be used as a dictionary key, be added to sets, etc. It can be converted back into a real wx.RichTextRange with a simple statement like this: obj = wx.RichTextRange(imObj).

GetLength(self)¶

Gets the length of the range.

Return type:: int

GetStart(self)¶

Returns the start position.

Return type:: int

IsOutside(self, range: RichTextRange)¶

Returns True if this range is completely outside range.

Parameters:: range (wx.richtext.RichTextRange)
Return type:: bool

IsWithin(self, range: RichTextRange)¶

Returns True if this range is completely within range.

Parameters:: range (wx.richtext.RichTextRange)
Return type:: bool

LimitTo(self, range: RichTextRange)¶

Limit this range to be within range.

Parameters:: range (wx.richtext.RichTextRange)
Return type:: bool

SetEnd(self, end: int)¶

Sets the end position.

Parameters:: end (long)
Return type:: None

SetRange(self, start: int, end: int)¶

Sets the range start and end positions.

Parameters:

start (long)
end (long)

Return type:

None

SetStart(self, start: int)¶

Sets the start position.

Parameters:: start (long)
Return type:: None

Swap(self)¶

Swaps the start and end.

Return type:: None

ToInternal(self)¶

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. (n, n) is the range of a single character.