1.49.6 Instance variables

editor <-> auto_newline: bool

If @on, a newline is appended automatically after each editor->append. Backward compatibility only.

See also

editor->append

editor <-> bindings: key_binding

Key_binding object used to map typing onto methods defined on the editor. It is filled with an empty key_binding object that has key_binding<-defaults bound to the built-in key_binding object named editor. This implies that bindings created using editor->key_binding are local to the editor.

See also

editor->typed

editor <- caret: int

The editor<-caret is the current insertion point. In ranges from 0 up to and including editor<-size. Zero implies insert at the beginning; editor<-size implies append at the end.

The method editor->caret is invoked explicitly from all internal methods that manipulate the caret and this method may thus be redefined to keep track of the users caret-movements.

The editor<-mark is a mark that moves with inserts and, together with the editor<-caret, defines the region. The region can be in various modes as described by editor<-mark_status.

To get the caret from an event, see text_image<-index. The location of the caret is visualised by a text_cursor object that can be requested using editor<-text_cursor.

See also

editor-mark

editor-dabbrev_origin: int*

Caret index for the beginning of the word on which dynamic expansion was started.

See also

editor->dabbrev_expand

editor-dabbrev_pos: int*

Caret index at which the dynamic expansion was initiated. The string expanded ranges from dabbrev_origin to dabbrev_pos.

See also

editor->dabbrev_expand

editor-dabbrev_reject: chain*

Chain of names of expansion alternatives already rejected by the user.

See also

editor->dabbrev_expand

editor-dabbrev_target: name*

Name, representing the start of the word to be expanded.

See also

editor->dabbrev_expand

editor <-> editable: bool

Boolean that indicates whether or not the text can be edited. If @off, a warning is generated whenever the user attempts to invoke an interactive command that would change the contents of the associated text_buffer.

See also editor->show_caret for hiding the caret on read-only editors.

BUG: In the original design, methods were fixed and methods

either implemented behaviour intended for user interaction or methods intended for program interaction. The editor->editable flag only affected interactive methods. Some of this distinction still remains. It is adviced to set editable to @on before modifying a read-only editor object from the program to avoid confusion.

See also

text_buffer-modified

editor <-> error_message: code*

When an error is trapped in a method, it is reported to the editor using editor->report. When defined, editor->report will execute this message with arguments given below:

@receiver:	The editor (or view)
@arg1		idem
@arg2		The type (status/warning/inform/error)
@arg3		String representing the message itself

See visual->report for a general discussion on the reporting system.

Defaults: @nil

See also

- display->inform
- graphical->alert

editor <-> exact_case: bool

Determines whether or not search and replace is case-sensitive. editor->switch_case_mode sets editor<-exact case according to the argument:

@default	toggle editor<-exact_case
> 0	editor->exact_case: @on
<= 0	editor<-exact_case: @off

Defaults: @off (Resource determined).

See also

- editor->isearch_forward
- editor->isearch_backward
- editor->switch_case_mode
- editor.exact_case

editor <- file: source_sink*

File that is associated with the editor.

See also

- editor->save_buffer
- editor->save
- editor->load

editor <-> fill_mode: bool

If @on, the current paragraph will be automatically reformated if the current line exceeds the editor<->right_margin while inserting text. editor->auto_fill_mode may be used to set editor<-fill_mode interactively:

@default:	toggle editor<-fill_mode
> 0	editor->fill_mode: @on
<= 0	editor->fill_mode: @off

See also

- editor->insert_self_fill
- editor->insert_self

editor <-> focus_function: name*

The editor<->focus_function variable is used to process commands that start a kind of sub-mode, such as entering a numeric argument, doing incremental search, doing a dabbrev expansion, etc.

An interactive behaviour that uses such a sub-loop sets this variable to the selector that handles the loop. As a consequence, editor->typed will invoke this method on each subsequent character typed until

1. The method fails. In this case the character is handled just as if no focus_function was defined.
2. The method resets editor<->focus_function to @nil. If the method invoked via editor<->focus_function succeeds, editor->typed assumes the character is handled.

   By convention, the method that is invoked by the focus function has the same name than the method that set the focus preceded by an underscore:

   quoted_insert ->
           _quoted_insert

editor <- font: font

Font used to display the contents of the associated text_buffer. Class editor can handle both proportional and non-proportional fonts.

editor <- image: text_image

Text_image object used for actually displaying the text. Direct access to this object may be necessary to exploit the following methods:

text_image->tab_stops	Set vector of tab-stops
text_image->wrap	Control line-wrapping

Direct access may also be used to attach event-handling to the editor. For example, if a popup is attached to the editor as a whole it might contradict with the editor<-scroll_bar. Associating the popup with the editor<-image ensures it only operates in the text area.

See also

class text_image

editor <-> indent_increment: int

Number of characters with which the indentation is incremented/decremented by the indentation-manipulation commands.

This group of commands is intended for editing source-code.

Defaults: 4 (Resource defined)

See also

- editor->undent_selection
- editor->undent_region
- editor->undent_line
- editor->indent_selection
- editor->indent_region
- editor->indent_line
- editor.indent_increment

editor-internal_mark: alien:int

Additional (floating) mark, used by some internal functions.

editor <- label_text: text*

Text object that displays the label. Initially @nil. A label is associated using editor->label. See also editor<->show_label.

editor <-> left_margin: int

Margins used for filling text. See editor->fill, editor->justify_paragraph, editor->fill_mode, etc. The method editor->set_fill_column may be used to set both methods interactively (Dope compatibility):

@default	Report current margins
> 0	Set editor->right_margin
< 0	Set editor->left_margin to the absolute value.

Defaults: 0

See also

- editor->append
- editor->fill_selection
- editor->fill_region
- editor->fill_paragraph
- editor-right_margin
- editor->set_fill_column

editor <- margin: text_margin*

Margin with icons that indicate the position of fragments. See fragment<-style, and editor->style. When the editor->margin_width is set to a value > 0 and there is no editor<-margin, a margin is created.

Defaults: @nil (no margin)

See also

- class fragment
- editor->margin_width
- class text_margin

editor <- mark: int

Inherits description from: editor-caret

See also

- editor->set_mark
- editor->point_to_mark
- editor->exchange_point_and_mark
- editor-caret

editor <- mark_ring: vector

Ring of old marks. If a new mark is set using editor->mark, the old mark is pushed into the ring. The maximum size of the ring is hard-coded to 16. The command editor->set_mark with a prefix argument cycles throught the saved marks.

editor <- mark_status: {active,inactive,highlight}

Status of the mark/region. Defined values are:

active

The region (selection) is highlighted using editor<-selection_style. Region commands are effective if the mark is in this state.

inactive

The mark is there, but the region is not visible and region commands are not executed. The current region can be made active using editor->exchange_point_and_mark (C-x C-x). The regions is made inactive with the command editor->keyboard_quit (C-g).

highlight

The region is highlighted, but not available for region-commands. This mode is used for highting parts of the text, such as using the comment editor->select_line.

See also editor->caret and editor->selection.

editor <-> modified_message: code*

When the value of the editor<->modified attribute of the associated text_buffer changes and this message is not @nil, this message is executed with the following arguments:

@receiver	Editor or view
@arg1	New value of editor<->modified

See also

text_buffer-modified

editor <-> right_margin: int

Defaults: 72 (Resource determined).

Inherits description from: editor-left_margin

See also

- editor->fill_selection
- editor->fill_region
- editor->fill_paragraph
- editor->set_fill_column
- editor->insert_self_fill
- editor-left_margin

editor <- scroll_bar: scroll_bar

Scroll_bar object attached to the editor. In the current implementation it is not possible to remove the scrollbar or place it at the right-side of the editor. However, setting the graphical->width to 0 before the editor is displayed effectively removes it.

See also

class scroll_bar

editor-search_base: int

Character index from which the last search was started.

See also

editor->isearch_forward

editor-search_direction: {forward,backward}

Current direction of the search. Set by editor->isearch_forward and editor->isearch_backward to resp. forward and backward.

See also

- editor->isearch_backward
- editor->isearch_forward

editor-search_origin: int

Place where the search was initiated. Set by editor->isearch_forward and editor->isearch_backward. Used to return when the search is canceled.

See also

editor->isearch_forward

editor <-> search_string: string*

Current target string for incremental search.

See also

editor->isearch_forward

editor <- selected_fragment: fragment*

Currently selected fragment. The visual appearance of this fragment is determined by editor<-selected_fragment_style. There is no default user-interface for selecting fragments. text_buffer<-find_fragment and text_margin<-fragment may be useful methods for defining a user-interface.

See also

- editor-selected_fragment_style
- class fragment

editor <- selected_fragment_style: style

@see class style @see editor-selected_fragment @see text_margin-styles @see class fragment

editor <- size: size

Size management of class editor has been redefined to communicate in character units rather then in pixel units. Width is expressed in font<-ex of the current editor<-font., height in font<-height.

The methods editor->_size, graphical->area and graphical->set may still be used to handle the pixel size directly.

editor <- styles: sheet

Mapping from style names as stored in fragment<-style onto style objects that determine the actual appearance of a fragment. This separates semantical information represented by the fragment from visualisation as achieved in the editor. Setting the style to @nil deletes the visual appearance of fragments with this name.

The following skeleton illustrates this. E is an editor. The final code fragment creates a fragment to turn the current selection into a title.

:- pce_global(@title_style,
                          new(style(font :=
                                                font(helvetica, bold, 16)))).

        ...
        send(E, style, title, @title_style),
        ...

        ...
        get(E, selection, point(Start, End)),
        Length is End - Start,
        new(F, fragment(E, Start, Length, title)),
        ...

See also

- text_margin-styles
- class fragment

editor <- tab_distance: characters=int

Distance between tab-stops in font<-ex units of the current editor<-font. Mainly used for handling source-code. When editor->tab_stops is defined the value of this variable is ignored.

editor <- text_buffer: text_buffer

The editor<-text_buffer stores the text. Class editor delegates messages not understood to the editor<-text_buffer. A text_buffer can have multiple editors operating on it simultaneously. The text_buffer object associated to an editor may be changed anytime.

editor <- text_cursor: text_cursor

Visualisation of the caret. It may be displayed in various styles. See class text_cursor. The default caret is a static inverting block for fixed-width fonts and a line with triangle for proportional fonts.