VSS.Strings.Cursors.Iterators.Words

Entities

Tagged Types

Subprograms

Description

Iterator to iterate over word boundaries. Pointing element is not necessary a word, it may point to the sequence of word separators too.

Backward

function Backward (Self : in out Word_Iterator) return Boolean

Move iterator to previous word.

Parameters
Self
Return Value

On_Line_Break

function On_Line_Break (Self : Word_Iterator'Class) return Boolean

Returns True when current text element is a line separator.

Parameters
Self
Return Value

On_Whitespace

function On_Whitespace (Self : Word_Iterator'Class) return Boolean

Returns True when current text element is sequence of horizontal whitespace characters.

Note, this function returns False when horizontal whitespace character is followed by some combining character.

Parameters
Self
Return Value

Set_After_Last

procedure Set_After_Last
  (Self : in out Word_Iterator'Class;
   On   : VSS.Strings.Virtual_String'Class)

Set iterator to point after the last word of the string.

Parameters
Self
On

Set_At

procedure Set_At
  (Self     : in out Word_Iterator'Class;
   Position : VSS.Strings.Cursors.Abstract_Character_Cursor'Class)

Set iterator to point to the word segment at the given position.

Parameters
Self
Position

Set_At_First

procedure Set_At_First
  (Self : in out Word_Iterator'Class;
   On   : VSS.Strings.Virtual_String'Class)

Set iterator to point to the first word segment of the string.

Parameters
Self
On

Set_At_Last

procedure Set_At_Last
  (Self : in out Word_Iterator'Class;
   On   : VSS.Strings.Virtual_String'Class)

Set iterator to point to the last word segment of the string.

Parameters
Self
On

Set_Before_First

procedure Set_Before_First
  (Self : in out Word_Iterator'Class;
   On   : VSS.Strings.Virtual_String'Class)

Set iterator to point before the first word of the string.

Parameters
Self
On

Word_Iterator

type Word_Iterator is new Abstract_Segment_Iterator with private;