UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
uLang::STextRange Struct Reference

#include <TextRange.h>

Public Member Functions

uint32_t BeginRow () const
 
uint32_t BeginColumn () const
 
uint32_t EndRow () const
 
uint32_t EndColumn () const
 
void SetBeginRow (uint32_t Row)
 
void SetBeginColumn (uint32_t Col)
 
void SetEndRow (uint32_t Row)
 
void SetEndColumn (uint32_t Col)
 
ULANG_FORCEINLINE STextRange ()
 
ULANG_FORCEINLINE STextRange (ENoInit)
 
ULANG_FORCEINLINE STextRange (uint32_t BeginRow, uint32_t BeginColumn, uint32_t EndRow, uint32_t EndColumn)
 
ULANG_FORCEINLINE STextRange (const STextPosition &Begin, const STextPosition &End)
 
ULANG_FORCEINLINE STextRange (const STextPosition &BeginAndEnd)
 
ULANG_FORCEINLINE STextPosition GetBegin () const
 
ULANG_FORCEINLINE STextPosition GetEnd () const
 
ULANG_FORCEINLINE void SetBegin (const STextPosition &Begin)
 
ULANG_FORCEINLINE void SetEnd (const STextPosition &End)
 
ULANG_FORCEINLINE void Invalidate ()
 
ULANG_FORCEINLINE void InvalidateEnd ()
 
ULANG_FORCEINLINE void Reset ()
 
ULANG_FORCEINLINE bool IsEmpty () const
 
ULANG_FORCEINLINE bool IsOrdered () const
 
ULANG_FORCEINLINE bool IsRowSingle () const
 
ULANG_FORCEINLINE bool IsRowMulti () const
 
ULANG_FORCEINLINE bool IsInvalid () const
 
ULANG_FORCEINLINE bool IsValid () const
 
ULANG_FORCEINLINE bool IsInvalidEnd () const
 
ULANG_FORCEINLINE bool IsValidEnd () const
 
ULANG_FORCEINLINE bool operator== (const STextRange &Other) const
 
ULANG_FORCEINLINE bool operator!= (const STextRange &Other) const
 
ULANG_FORCEINLINE bool Overlaps (const STextRange &Other) const
 
ULANG_FORCEINLINE bool IsContainedIn (const STextRange &ContainingRange) const
 
ULANG_FORCEINLINE bool IsInRange (const STextPosition &Position) const
 
ULANG_FORCEINLINE bool IsInRangeInclusive (const STextPosition &Position) const
 
ULANG_FORCEINLINE STextRange operator| (const STextRange &Other) const
 
ULANG_FORCEINLINE STextRange & operator|= (const STextRange &Other)
 

Detailed Description

A range in a text document/string expressed as (zero-based) begin and end row/column. A range is comparable to a selection in an editor. Therefore the end position is exclusive. Columns are byte offsets into the UTF-8 encoded line.

To specify a range that contains a line including the line ending character(s), use an end position denoting the start of the next line (or) same row and the column just past the last character on the row.

Often used with CUTF8StringView and SIdxRange. CUTF8StringView should do the converting to and from SIdxRange and STextRange.

Similar to a LSP Range - https://microsoft.github.io/language-server-protocol/specifications/specification-3-14/#range Also similar to UE FIntRect

Constructor & Destructor Documentation

◆ STextRange() [1/5]

ULANG_FORCEINLINE uLang::STextRange::STextRange ( )
inline

◆ STextRange() [2/5]

ULANG_FORCEINLINE uLang::STextRange::STextRange ( ENoInit  )
inline

◆ STextRange() [3/5]

ULANG_FORCEINLINE uLang::STextRange::STextRange ( uint32_t  BeginRow,
uint32_t  BeginColumn,
uint32_t  EndRow,
uint32_t  EndColumn 
)
inline

◆ STextRange() [4/5]

ULANG_FORCEINLINE uLang::STextRange::STextRange ( const STextPosition &  Begin,
const STextPosition &  End 
)
inline

◆ STextRange() [5/5]

ULANG_FORCEINLINE uLang::STextRange::STextRange ( const STextPosition &  BeginAndEnd)
inline

Member Function Documentation

◆ BeginColumn()

uint32_t uLang::STextRange::BeginColumn ( ) const
inline

◆ BeginRow()

uint32_t uLang::STextRange::BeginRow ( ) const
inline

◆ EndColumn()

uint32_t uLang::STextRange::EndColumn ( ) const
inline

◆ EndRow()

uint32_t uLang::STextRange::EndRow ( ) const
inline

◆ GetBegin()

ULANG_FORCEINLINE STextPosition uLang::STextRange::GetBegin ( ) const
inline

◆ GetEnd()

ULANG_FORCEINLINE STextPosition uLang::STextRange::GetEnd ( ) const
inline

◆ Invalidate()

ULANG_FORCEINLINE void uLang::STextRange::Invalidate ( )
inline

◆ InvalidateEnd()

ULANG_FORCEINLINE void uLang::STextRange::InvalidateEnd ( )
inline

◆ IsContainedIn()

ULANG_FORCEINLINE bool uLang::STextRange::IsContainedIn ( const STextRange &  ContainingRange) const
inline

◆ IsEmpty()

ULANG_FORCEINLINE bool uLang::STextRange::IsEmpty ( ) const
inline

◆ IsInRange()

ULANG_FORCEINLINE bool uLang::STextRange::IsInRange ( const STextPosition &  Position) const
inline

◆ IsInRangeInclusive()

ULANG_FORCEINLINE bool uLang::STextRange::IsInRangeInclusive ( const STextPosition &  Position) const
inline

◆ IsInvalid()

ULANG_FORCEINLINE bool uLang::STextRange::IsInvalid ( ) const
inline

◆ IsInvalidEnd()

ULANG_FORCEINLINE bool uLang::STextRange::IsInvalidEnd ( ) const
inline

◆ IsOrdered()

ULANG_FORCEINLINE bool uLang::STextRange::IsOrdered ( ) const
inline

◆ IsRowMulti()

ULANG_FORCEINLINE bool uLang::STextRange::IsRowMulti ( ) const
inline

◆ IsRowSingle()

ULANG_FORCEINLINE bool uLang::STextRange::IsRowSingle ( ) const
inline

◆ IsValid()

ULANG_FORCEINLINE bool uLang::STextRange::IsValid ( ) const
inline

◆ IsValidEnd()

ULANG_FORCEINLINE bool uLang::STextRange::IsValidEnd ( ) const
inline

◆ operator!=()

ULANG_FORCEINLINE bool uLang::STextRange::operator!= ( const STextRange &  Other) const
inline

◆ operator==()

ULANG_FORCEINLINE bool uLang::STextRange::operator== ( const STextRange &  Other) const
inline

◆ operator|()

ULANG_FORCEINLINE STextRange uLang::STextRange::operator| ( const STextRange &  Other) const
inline

◆ operator|=()

ULANG_FORCEINLINE STextRange & uLang::STextRange::operator|= ( const STextRange &  Other)
inline

◆ Overlaps()

ULANG_FORCEINLINE bool uLang::STextRange::Overlaps ( const STextRange &  Other) const
inline

◆ Reset()

ULANG_FORCEINLINE void uLang::STextRange::Reset ( )
inline

◆ SetBegin()

ULANG_FORCEINLINE void uLang::STextRange::SetBegin ( const STextPosition &  Begin)
inline

◆ SetBeginColumn()

void uLang::STextRange::SetBeginColumn ( uint32_t  Col)
inline

◆ SetBeginRow()

void uLang::STextRange::SetBeginRow ( uint32_t  Row)
inline

◆ SetEnd()

ULANG_FORCEINLINE void uLang::STextRange::SetEnd ( const STextPosition &  End)
inline

◆ SetEndColumn()

void uLang::STextRange::SetEndColumn ( uint32_t  Col)
inline

◆ SetEndRow()

void uLang::STextRange::SetEndRow ( uint32_t  Row)
inline
The documentation for this struct was generated from the following file: