1.163.3 Send methods

text ->backward_kill_word: times=[int]

Deletes words backward from caret (\e DEL)

text ->caret: [int]

@see text->typed @see text<-pointed

text ->catch_all: selector=name, argument=unchecked ...

Delegate to text<-string. In addition, if text<-string does not accept the method, but class string does, the text<-string is converted to a string object holding the same characters. See also text->has_send_method.

text ->compute:

Recomputes graphical<-area from the text<-string, text<-font and text<-margin.

text ->event: event

The default event-handling for a text manipulates the visibility of the caret on focus events and invokes text->typed on itself if the event if a keyboard event and the text<-show_caret yields @on. See also graphical->keyboard_focus.

text ->format_left:

Set left alignment.

text ->format_right:

Set right alignment.

text ->format_center:

Format the text centered, left or right. These methods are defined without arguments for invoking them easily from the keyboard.

text ->geometry: x=[int], y=[int], width=[int], height=[int]

Just moves the text object as the size is determined by the text<-string, text<-font and text<-margin.

text ->has_send_method: name

Test whether the text object implements a method. Text accepts all methods of itself, of text<-string and of class string. See also text->catch_all.

text ->initialise: string=[char_array], format=[{left,center,right}], font=[font]

Create a text object from the specified string, format and font. The text<-string defaults to” , the text<-format to left and the text<-font to the text.font

text ->length: int

Sets the text<-margin in the text<-fonts ex units (see font<-ex). New code should use the more advanced text->margin method.

text ->margin: int*, [{wrap,wrap_fixed_width,clip}]

Define how the text object handles long string. Text objects may handle long strings in three different ways as described by text<-wrap:

• extend (text->margin: @nil). The graphical is as big as needed to display the string
• clip (text->margin: width, clip) The graphical has fixed width. If the string is too long it will be clipped.
• wrap-1 (text->margin: width, wrap) The graphical has a text<-margin defined. If the string is too long to fit within the margin it will be wrapped on multiple physical lines. Wrapping only happens at word boundaries.
• wrap-2 (text->margin: width, wrap_fixed_width) Similar to wrap-1, but the graphical<-width of the graphical equals the margin rather than the width occupied by the displayed characters.

  See also

  text-wrap

text ->paste: which=[{primary,clipboard}]

Paste value of the numbered X-cut-buffer. See display<-cut_buffer.

text ->resize: factor_x=real, factor_y=[real], origin=[point]

@see graphical->resize

text ->selection: from=[int]*, to=[int]

Make [from, to) the selection. If from is @nil to must be omitted and the selection is cleared. Otherwise default values do not change the corresponding end of the selection.

See also text<-selected_text, class edit_text_gesture and the Prolog library(pce_editable_text).

text ->show_caret: bool|{passive}

@see text->typed @see text<-pointed

text ->transparent: bool

Compatibilty method defining text<-background. The value @on is equivalent to text->background: @nil and @off to text->background: @default.

text ->typed: event|event_id

Handle keyboard event. Class text does not provide default event-handling, but editable text objects are easily created by forwarding keyboard-events to this method:

:- pce_global(@edit_text_recogniser,
                          new(handler(keyboard,
                                                  message(@receiver,
                                                              typed,
                                                              @arg1)))).

text_make_editable(T) :-
        send(T, recogniser, @edit_text_recogniser).

This method uses the key_binding object called text from @key_bindings to map the typed keys on selectors and then invokes methods on class text. With the above, if the user types control-U to the text the following happens:

1. Event arrives at text and is given to text->typed using @edit_text_recogniser.
2. The event<-id is processed by the text key_binding object and mapped on the selector clear. text->clear does not require arguments and the key_binding object just invokes text->clear.
3. text->clear erases all characters from the text. Diagnostics: Fails if the keyboard event could not be handled.

   See also

   - text->show_caret
   - text->caret
   - text<-pointed
   - text.key_binding
   - text<-key_binding
   - class text_item
   - class text

text ->underline: bool|colour

The text is underlines if @on using the same colour as the text or using an explicit colour if the value is a colour object.