1.62.2 Send methods

fragment ->end: int

Inherits description from: fragment<-end

fragment ->does_include: what={start,end}

Test whether start or end is included.

fragment ->include: what=[{start,end,both}], include=[bool]

Define whether start and end are included. If text insertion takes place exactly on the corresponding end of the fragment, the fragment is expanded if include equals @on or left untouched if include equals @off.

What defaults to both (include both start and end). include defaults to @on. Initially neither of the ends is included. See also fragment->insert.

fragment ->initialise: text=text_buffer, start=int, length=int, style=[name]

Create a fragment on the specified text_buffer object. The fragment starts are fragment<-start and is fragment<-length (may be 0) characters long. fragment<-style is a logical indicating the category of the fragment (e.g. title, example, glossary, refers_to, ...). The visual implication of a style-name is determined using editor->style and/or list_browser->style.

fragment ->insert: [int], char_array

Insert text in the fragment. The fragment actually invokes‘text_buffer fragment->insert’with the properly translated arguments. If the index is @default, the text is appended to the fragment. For example, the PceEmacs shell mode uses a fragment to insert the output of the sub-process. See xpce/prolog/lib/emacs/shell_mode.pl.

fragment ->overlap: int|fragment|point

Succeed if the fragment overlaps the specified index, overlaps with the specified fragment or with a range starting at point<-x to point<-y. Often used in combination with text_buffer<-find to find a fragment overlapping the caret.

fragment ->start: int, move_end=[bool]

Start index (0-based). If move_end equals @off, the end-point is not moved. Otherwise the end-point is moved by the same amount (fragment<-length is not changed).

fragment ->unlink:

Unlinks the fragment from the fragment<-text_buffer and inform the possible related editors of the change.