Scintilla::Range Class Reference

The range class represents a range of text in a document. More...

#include <Document.h>

Public Member Functions
	Range (Sci::Position pos=0) noexcept
	Range (Sci::Position start_, Sci::Position end_) noexcept
bool	operator== (const Range &other) const noexcept
bool	Valid () const noexcept
Sci::Position	First () const noexcept
Sci::Position	Last () const noexcept
bool	Contains (Sci::Position pos) const noexcept
bool	ContainsCharacter (Sci::Position pos) const noexcept
bool	Contains (Range other) const noexcept
bool	Overlaps (Range other) const noexcept

Public Attributes
Sci::Position	start
Sci::Position	end

Detailed Description

The range class represents a range of text in a document.

The two values are not sorted as one end may be more significant than the other as is the case for the selection where the end position is the position of the caret. If either position is invalidPosition then the range is invalid and most operations will fail.

Definition at line 29 of file Document.h.

Constructor & Destructor Documentation

Range() [1/2]

Scintilla::Range::Range ( Sci::Position  pos = 0 )

inlineexplicitnoexcept

Definition at line 34 of file Document.h.

Range() [2/2]

Scintilla::Range::Range ( Sci::Position  start_, Sci::Position  end_  )

inlinenoexcept

Definition at line 37 of file Document.h.

Member Function Documentation

Contains() [1/2]

bool Scintilla::Range::Contains ( Range  other ) const

inlinenoexcept

Definition at line 75 of file Document.h.

References Contains().

Contains() [2/2]

bool Scintilla::Range::Contains ( Sci::Position  pos ) const

inlinenoexcept

Definition at line 58 of file Document.h.

References end, pos, and start.

Referenced by Contains(), and Overlaps().

ContainsCharacter()

bool Scintilla::Range::ContainsCharacter ( Sci::Position  pos ) const

inlinenoexcept

Definition at line 67 of file Document.h.

References end, pos, and start.

Referenced by Scintilla::EditView::DrawBackground(), Scintilla::EditView::DrawForeground(), DrawIndicators(), Scintilla::LineLayout::RestoreBracesHighlight(), and Scintilla::LineLayout::SetBracesHighlight().

First()

Sci::Position Scintilla::Range::First ( ) const

inlinenoexcept

Definition at line 49 of file Document.h.

References end, and start.

Referenced by DrawIndicators(), and Scintilla::Editor::RectangleFromRange().

Last()

Sci::Position Scintilla::Range::Last ( ) const

inlinenoexcept

Definition at line 53 of file Document.h.

References end, and start.

Referenced by Scintilla::Editor::RectangleFromRange().

operator==()

bool Scintilla::Range::operator== ( const Range &  other ) const

inlinenoexcept

Definition at line 41 of file Document.h.

References end, and start.

Overlaps()

bool Scintilla::Range::Overlaps ( Range  other ) const

inlinenoexcept

Definition at line 79 of file Document.h.

References Contains(), end, and start.

Referenced by Scintilla::Editor::MultipleSelectAdd().

Valid()

bool Scintilla::Range::Valid ( ) const

inlinenoexcept

Definition at line 45 of file Document.h.

References end, Sci::invalidPosition, and start.

Referenced by Scintilla::Editor::ButtonMoveWithModifiers(), Scintilla::Editor::CheckForChangeOutsidePaint(), Scintilla::EditView::DrawBackground(), Scintilla::EditView::DrawForeground(), and Scintilla::Editor::SetHotSpotRange().

Member Data Documentation

end

Sci::Position Scintilla::Range::end

Definition at line 32 of file Document.h.

Referenced by Scintilla::BreakFinder::BreakFinder(), Contains(), ContainsCharacter(), Scintilla::Editor::DelWordOrLine(), DrawIndicators(), Scintilla::EditView::DrawLine(), DrawTranslucentSelection(), First(), Last(), Scintilla::BreakFinder::More(), Scintilla::Editor::MultipleSelectAdd(), Scintilla::BreakFinder::Next(), operator==(), Overlaps(), Scintilla::LineLayout::PointFromPosition(), Scintilla::EditView::RangeDisplayLine(), Scintilla::LineLayout::SetBracesHighlight(), Scintilla::Editor::SetHotSpotRange(), Scintilla::EditView::SPositionFromLineX(), Scintilla::EditView::SPositionFromLocation(), and Valid().

start

Sci::Position Scintilla::Range::start

Definition at line 31 of file Document.h.

Referenced by Scintilla::BreakFinder::BreakFinder(), Contains(), ContainsCharacter(), Scintilla::Editor::DelWordOrLine(), Scintilla::EditView::DrawBackground(), DrawEdgeLine(), Scintilla::EditView::DrawForeground(), Scintilla::EditView::DrawLine(), DrawTranslucentSelection(), First(), Last(), Scintilla::Editor::MultipleSelectAdd(), operator==(), Overlaps(), Scintilla::LineLayout::PointFromPosition(), Scintilla::EditView::RangeDisplayLine(), Scintilla::LineLayout::RestoreBracesHighlight(), Scintilla::LineLayout::SetBracesHighlight(), Scintilla::Editor::SetHotSpotRange(), Scintilla::EditView::SPositionFromLineX(), Scintilla::EditView::SPositionFromLocation(), and Valid().

---

The documentation for this class was generated from the following file:

• scintilla/src/Document.h