1.168.3 Get methods

text_item <-completions: char_array|tuple -> chain

This method is normally invoked by text_item->complete. The argument is the return-value of text_item<-split_completion.

If the argument is a char_array the text_item completes from a plain list. It should return a chain of objects that match the indicated start of their object<-print_name. The chain may contain objects whose name does

• not* start with the indicated char_array. These will be filtered out by text_item->complete.

  If the argument is a tuple the text_item is used for a hierarchical structure. This method should return a chain of files matching tuple<-second in the directory tuple<-first.

  The default implementation exploits text_item<-value_set.

  See also

  - text_item<-split_completion
  - text_item-value_set

text_item <-default: -> any

If the value of -default is a function, execute it. Otherwise just return the value of this slot.

text_item <-displayed_value: -> char_array

Currently visible text. Equivalent to text<-string of text_item<-value_text.

text_item <-has_completions: -> bool

Return @on if item can generate completions. Used by text_item->style: @default to see whether the item should appear as a normal entry-field or as a combo-box.

text_item <-modified: -> bool

Test if the user has modified the selection. Succeeds if the current value of the text entry field is not equal to object<-print_name.

See also

text_item-print_name

object <-print_name: -> text=char_array

Convert the current text_item<-selection into a textual format. It attempts the following conversions:

• object<-print_name
• type(char_array) text_item<-check (calling char_array<-convert).
• Internal pretty printing format used by the debugger. @see text_item-type

text_item <-print_name_of_value: any -> char_array

This method is called whenever the text_item wants to convert a value into a string. The default implementation just calls object<-print_name. May be redefined. See also -print_name.

text_item <-selection: -> any

Recompute the text_item<-selection from the entered value. Performs the following steps:

1. text_item->enter_completer
2. If text_item<-modified equals @on, convert the text<-string of the text_item<-value_text (i.e. the displayed value) using type<-check to the requested type. If this succeed assign text_item<-selection and object<-print_name. If it fails generate a connot_convert_text error.
3. Finally return the text_item<-selection slot value

text_item <-split_completion: value=char_array -> char_array|tuple

The task of this method is to split the current text_item<-displayed_value (passed as argument) into a directory- and a file-part to deal with hierarchically organised data. This method should return:

• its argument If the text_item is used to select from a flat list of (named) objects. This is the default behaviour of this method.
• A tuple object with the directory and file component if the text_item is used to select from a hierarchical structure.

  Note that the return-value of this message is passed to text_item<-completions.

  See also

  text_item<-completions