(send a-text:basic highlight-range   start             end             color            [ caret-space             priority             style])   →   (-> void?)

start : exact-nonnegative-integer?

end : exact-nonnegative-integer?

color : (or/c string? (is-a?/c color%))

caret-space : boolean? = #f

priority : (symbols 'high 'low) = 'low

style   :   (symbols 'rectangle 'ellipse 'hollow-ellipse 'dot)       =   'rectangle

This function highlights a region of text in the buffer.

The range between start and end will be highlighted with the color in color, if the style is 'rectangle (the default). If the style is 'ellipse, then an ellipse is drawn around the range in the editor, using the color. If the style is 'hollow-ellipse, then the outline of an ellipse is drawn around the range in the editor, using the color.

If the style is 'dot, then start and end must be the same, and a dot is drawn at the bottom of that position in the editor.

If caret-space? is not #f, the left edge of the range will be one pixel short, to leave space for the caret. The caret does not interfere with the right hand side of the range. Note that under some platforms, the caret is drawn with XOR, which means almost anything can happen. So if the caret is in the middle of the range it may be hard to see, or if it is on the left of the range and caret-space? is #f it may also be hard to see.

The priority argument indicates the relative priority for drawing overlapping regions. If two regions overlap and have different priorities, the region with 'high priority will be drawn second and only it will be visible in the overlapping region.

This method returns a thunk, which, when invoked, will turn off the highlighting from this range.

See also unhighlight-range.

(send a-text:basic unhighlight-range   start             end             color            [ caret-space             style])   →   void?

start : exact-nonnegative-integer?

end : exact-nonnegative-integer?

color : (or/c string? (is-a?/c color%))

caret-space : boolean? = #f

style   :   (symbols 'rectangle 'ellipse 'hollow-ellipse)       =   'rectangle

This method removes the highlight from a region of text in the buffer.

The region must match up to a region specified from an earlier call to highlight-range.

(send a-text:basic get-highlighted-ranges)

→ (listof text:range?)

Returns a list of (opaque) values representing the active ranges in the editor.

(send a-text:basic get-styles-fixed) → boolean?

If the result of this function is #t, the styles in this text:basic<%> will be fixed. This means that any text inserted to this editor has its style set to this editor’s style-list%’s "Standard" style.

See also set-styles-fixed.

(send a-text:basic get-fixed-style) → (is-a?/c style<%>)

Returns the style used by set-styles-fixedwhen setting the styles.

(send a-text:basic set-styles-fixed fixed?) → void?

fixed? : boolean?

Sets the styles fixed parameter of this text%. See also get-styles-fixed and get-fixed-style.

(send a-text:basic move/copy-to-edit       dest-text       start       end       dest-pos      [ #:try-to-move? try-to-move?])

→ void?

dest-text : (is-a?/c text%)

start : exact-integer?

end : exact-integer?

dest-pos : exact-integer?

try-to-move? : boolean? = #t

This moves or copies text and snips to another edit.

Moves or copies from the edit starting at start and ending at end. It puts the copied text and snips in dest-text starting at location dest-pos.

If try-to-move is #t, then the snips are removed; and if it is #f, then they are copied.

If a snip refused to be moved, it will be copied and deleted from the editor, otherwise it will be moved. A snip may refuse to be moved by returning #f from release-from-owner.

(send a-text:basic initial-autowrap-bitmap)

→ (or/c #f (is-a?/c bitmap%))

The result of this method is used as the initial autowrap bitmap. Override this method to change the initial bitmap%. See also set-autowrap-bitmap

Returns the result of icon:get-autowrap-bitmap by default.

(send a-text:basic get-port-name)

→ (or/c path-string? symbol? #f)

The result of this method is a symbol that identifies this editor and that is used as the port-name of a port that is read from this editor if this editor is used in DrRacket. See also port-name-matches?.

(send a-text:basic port-name-matches? id) → boolean?

id : any/c

Indicates if id matches the port name of this file. If the file is saved, the port name matches when the save file is the path as id. If the file has not been saved, the port name matches if the symbol is the same as the result of get-port-name.

This method calls normalize-path and thus can be very expensive on some filesystems. If it is called many times in a loop, cache the results to avoid calling it too often.

(send a-text:basic get-edition-number)

→ exact-nonnegative-integer?

Returns a number that increments every time something in the editor changes.

The number is updated in after-insert in text% and after-delete in text%.

(send a-text:basic get-start-of-line pos)

→ exact-nonnegative-integer?

pos : exact-nonnegative-integer?

This method is used by keymap:setup-global to implement a keybinding for the "home" key and for "c:a".

Its default implementation is (line-start-position (position-line pos)).

(send a-text:basic on-paint   before?             dc             left             top             right             bottom             dx             dy             draw-caret)   →   void?

before? : any/c

dc : (is-a?/c dc<%>)

left : real?

top : real?

right : real?

bottom : real?

dx : real?

dy : real?

draw-caret : (one-of/c 'no-caret  'show-inactive-caret  'show-caret)

Overrides on-paint in editor<%>.

Draws the rectangles installed by highlight-range.

(send a-text:basic on-insert start end) → void?

start : exact-nonnegative-integer?

end : exact-nonnegative-integer?

Augments on-insert in text%.

See set-styles-fixed.

(send a-text:basic after-insert start len) → void?

start : exact-nonnegative-integer?

len : exact-nonnegative-integer?

Augments after-insert in text%.

See set-styles-fixed.

(send a-text:basic put-file   directory             default-name)   →   (or/c path? #f)

directory : (or/c path? #f)

default-name : string?

Overrides put-file in editor<%>.

Like put-file but uses finder:put-file instead of put-file.

(send a-text:first-line highlight-first-line on?) → void?

on? : boolean?

Call this method to enable special treatment of the first line in the editor.

(send a-text:first-line first-line-currently-drawn-specially?)

→ boolean?

Returns #t if is-special-first-line? returned #t for the current first line and if the buffer is scrolled down so that the first line would not (ordinarily) be visible.

(send a-text:first-line get-first-line-height) → number?

Returns the height, in pixels, of the first line.

(send a-text:first-line is-special-first-line? line) → boolean?

line : string?

Override this method to control when the first line is always visible. The argument is the first line, as a string.

(send a-text:first-line on-paint   before?             dc             left             top             right             bottom             dx             dy             draw-caret)   →   void?

before? : any/c

dc : (is-a?/c dc<%>)

left : real?

top : real?

right : real?

bottom : real?

dx : real?

dy : real?

draw-caret : (one-of/c 'no-caret 'show-inactive-caret 'show-caret)

Overrides on-paint in editor<%>.

Based on the various return values of the methods in text:first-line, draws the first actual line of the editor over top of the first visible line in the editor.

(send a-text:first-line on-event event) → void?

event : (is-a?/c mouse-event%)

Overrides on-event in editor<%>.

Clicks in the first line cause the editor to scroll to the actual first line.

(send a-text:first-line scroll-editor-to   localx             localy             width             height             refresh?             bias)   →   void?

localx : real?

localy : real?

width : (and/c real? (not/c negative?))

height : (and/c real? (not/c negative?))

refresh? : any/c

bias : (one-of/c 'start 'end 'none)

Overrides scroll-editor-to in editor<%>.

Scrolls a little bit more, when a scroll would be requested that scrolls something so that it is line underneath the first line.

(send a-text:foreground-color default-style-name) → string?

Overrides default-style-name in editor<%>.

Returns the result of editor:get-default-color-style-name.

(send a-text:foreground-color get-fixed-style)

→ (is-a?/c style<%>)

Overrides get-fixed-style in text:basic<%>.

Returns the style named by editor:get-default-color-style-name.

(send a-text:hide-caret/selection after-set-position) → void?

Augments after-set-position in text%.

Calls hide-caret to hide the caret when there is only a caret and no selection.

(send a-text:nbsp->space on-insert   start             end)   →   void?

start : exact-nonnegative-integer?

end : exact-nonnegative-integer?

Augments on-insert in text%.

Starts an edit-sequence by calling begin-edit-sequence.

(send a-text:nbsp->space after-insert   start             len)   →   void?

start : exact-nonnegative-integer?

len : exact-nonnegative-integer?

Augments after-insert in text%.

Replaces all non-breaking space characters (integer->char 160) by #\space characters.

Ends the edit sequence (by calling end-edit-sequence) started in on-insert.

(send a-text:normalize-paste ask-normalize?) → boolean?

Prompts the user if the pasted text should be normalized (and updates various preferences based on the response).

Override this method in the mixin to avoid all GUI and preferences interactions.

(send a-text:normalize-paste string-normalize s) → string?

s : string?

Normalizes s. Defaults to string-normalize-nfkc.

(send a-text:normalize-paste do-paste   start             time)   →   void?

start : exact-nonnegative-integer?

time : exact-integer?

Overrides do-paste in text%.

Overridden to detect when insertions are due to pasting. Sets some internal state and calls the super.

(send a-text:normalize-paste on-insert   start             len)   →   void?

start : exact-nonnegative-integer?

len : exact-nonnegative-integer?

Augments on-insert in text%.

Calls begin-edit-sequence.

(send a-text:normalize-paste after-insert   start             len)   →   void?

start : exact-nonnegative-integer?

len : exact-nonnegative-integer?

Augments after-insert in text%.

Normalizes any next text and calls end-edit-sequence.

(send a-text:searching set-searching-state   str       cs?       replace-start)

→ void?

str : (or/c false/c string?)

cs? : boolean?

replace-start : (or/c false/c number?)

If str is not #f, then this method highlights every occurrence of str in the editor. If str is #f, then it clears all of the highlighting in the buffer.

If cs? is #f, the search is case-insensitive, and otherwise it is case-sensitive.

If the replace-start argument is #f, then the search is not in replacement mode. If it is a number, then the first search hit after that position in the editor is where the next replacement will take place.

(send a-text:searching set-search-anchor position) → void?

position : (or/c false/c number?)

Sets the anchor’s position in the editor. Only takes effect if the 'framework:anchored-search preference is on.

(send a-text:searching get-search-hit-count) → number?

Returns the number of hits for the search in the buffer, based on the count found last time that a search happened.

(send a-text:searching set-replace-start pos) → void?

pos : (or/c false/c number?)

Sets the position where replacement next occurs. This is equivalent to calling set-searching-state with a new replace-start argument, but the other arguments the same as the last call to set-searching-state, but is more efficient (since set-searching-state will search the entire buffer and re-build all of the bubbles).

(send a-text:searching get-search-bubbles)

→   (listof (list/c (cons/c number? number?)                 (list/c number? number? number?)))

Returns information about the search bubbles in the editor. Each item in the outermost list corresponds to a single bubble. The pair of numbers is the range of the bubble and the triple of numbers is the color of the bubble, in RGB coordinates.

If replace-start has been set (via set-replace-start) and the closest search hit following replace-start does not collapse with an adjacent bubble,the result will include that bubble. If the closest search hit after replace-start is collpased with another bubble, then the search hit is not reflected in the result.

This method is intended for use in test suites.

(send a-text:searching get-keymaps)

→ (listof (is-a?/c keymap%))

Overrides get-keymaps in editor:keymap<%>.

This returns a list containing the super-class’s keymaps, plus the result of keymap:get-search

(send a-text:searching after-insert   start             len)   →   void?

start : exact-nonnegative-integer?

len : exact-nonnegative-integer?

Augments after-insert in text%.

Re-does any search now that the contents of the window have changed.

(send a-text:searching after-delete   start             len)   →   void?

start : exact-nonnegative-integer?

len : exact-nonnegative-integer?

Augments after-delete in text%.

Re-does any search now that the contents of the window have changed.

(send a-text:searching on-focus on?) → void?

on? : boolean?

Overrides on-focus in editor<%>.

Tells the frame containing the editor to search based on this editor via the set-text-to-search method.

(new text:return-mixin [return return])

→ (is-a?/c text:return-mixin)

return : (-> boolean?)

(send a-text:return on-local-char event) → void?

event : (is-a?/c key-event%)

Overrides on-local-char in editor<%>.

If key is either return or newline, only invoke the return thunk (initialization argument) and do nothing else.

(send a-text:wide-snip add-wide-snip snip) → void?

snip : (is-a?/c snip%)

Registers a snip in this editor to be resized when its viewing area changes. Ensures the snip is as wide as the viewing area.

This method should only be called by add-wide-snip in canvas:wide-snip<%>.

(send a-text:wide-snip add-tall-snip snip) → void?

snip : (is-a?/c snip%)

Registers a snip in this editor. It is resized when the viewing area of the editor changes.

This method should only be called by add-tall-snip in canvas:wide-snip<%>.

(send a-text:delegate get-delegate)

→ (or/c #f (is-a?/c text%))

The result of this method is the text% object that the contents of this editor are being delegated to, or #f, if there is none.

(send a-text:delegate set-delegate delegate) → void?

delegate : (or/c #f (is-a?/c text%))

This method sets the current delegate.

When it is set, all of the snips are copied from this object to delegate. Additionally, if this object implements scheme:text<%> the tab settings of delegate are updated to match this objects.

(send a-text:1-pixel-string-snip split   position             first             second)   →   void?

position : exact

first : (box/c (is-a?/c snip%))

second : (box/c (is-a?/c snip%))

Overrides split in snip%.

Fills the boxes with instance of text:1-pixel-string-snip%s.

(send a-text:1-pixel-string-snip copy) → (is-a?/c snip%)

Overrides copy in snip%.

Creates and returns an instance of text:1-pixel-string-snip%.

(send a-text:1-pixel-string-snip get-extent   dc             x             y            [ w             h             descent             space             lspace             rspace])   →   void?

dc : (is-a?/c dc<%>)

x : real?

y : real?

w   :   (or/c (box/c (or/c (and/c real? (not/c negative?)))) #f)       =   #f

h   :   (or/c (box/c (or/c (and/c real? (not/c negative?)))) #f)       =   #f

descent   :   (or/c (box/c (or/c (and/c real? (not/c negative?)))) #f)       =   #f

space   :   (or/c (box/c (or/c (and/c real? (not/c negative?)))) #f)       =   #f

lspace   :   (or/c (box/c (or/c (and/c real? (not/c negative?)))) #f)       =   #f

rspace   :   (or/c (box/c (or/c (and/c real? (not/c negative?)))) #f)       =   #f

Overrides get-extent in snip%.

Sets the descent, space, lspace, and rspace to zero. Sets the height to 1. Sets the width to the number of characters in the string.

(send a-text:1-pixel-string-snip insert   s             len            [ pos])   →   void?

s : string?

len : exact-nonnegative-integer?

pos : exact-nonnegative-integer? = 0

Overrides insert in string-snip%.

(send a-text:1-pixel-string-snip draw   dc             x             y             left             top             right             bottom             dx             dy             draw-caret)   →   void?

dc : (is-a?/c dc<%>)

x : real?

y : real?

left : real?

top : real?

right : real?

bottom : real?

dx : real?

dy : real?

draw-caret : (or/c 'no-caret  'show-inactive-caret  'show-caret)

Overrides draw in snip%.

Draws black pixels for non-whitespace characters and draws nothing for whitespace characters.

(send a-text:1-pixel-tab-snip split   position             first             second)   →   void?

position : exact

first : (box/c (is-a?/c snip%))

second : (box/c (is-a?/c snip%))

Overrides split in snip%.

Fills the boxes with instance of text:1-pixel-tab-snip%s.

(send a-text:1-pixel-tab-snip copy) → (is-a?/c snip%)

Overrides copy in snip%.

Creates and returns an instance of text:1-pixel-tab-snip%.

(send a-text:1-pixel-tab-snip get-extent   dc             x             y            [ w             h             descent             space             lspace             rspace])   →   void?

dc : (is-a?/c dc<%>)

x : real?

y : real?

w : (or/c (box/c (and/c real? (not/c negative?)) #f)) = #f

h : (or/c (box/c (and/c real? (not/c negative?)) #f)) = #f

descent   :   (or/c (box/c (and/c real? (not/c negative?)) #f))       =   #f

space : (or/c (box/c (and/c real? (not/c negative?)) #f)) = #f

lspace   :   (or/c (box/c (and/c real? (not/c negative?)) #f))       =   #f

rspace   :   (or/c (box/c (and/c real? (not/c negative?)) #f))       =   #f

Overrides get-extent in snip%.

Sets the descent, space, lspace, and rspace to zero. Sets the height to 1. Sets the width to the width of tabs as returned in the tab-width parameter of the get-tabs method.

(send a-text:1-pixel-tab-snip draw   dc             x             y             left             top             right             bottom             dx             dy             draw-caret)   →   void?

dc : (is-a?/c dc<%>)

x : real?

y : real?

left : real?

top : real?

right : real?

bottom : real?

dx : real?

dy : real?

draw-caret : (or/c 'no-caret  'show-inactive-caret  'show-caret)

Overrides draw in snip%.

Draws nothing.

(send a-text:delegate highlight-range   start             end             color            [ caret-space             priority             style])   →   (-> void?)

start : exact-integer?

end : exact-nonnegative-integer?

color : (or/c string? (is-a?/c color%))

caret-space : boolean? = #f

priority : (symbols 'high 'low) = 'low

style   :   (symbols 'rectangle 'ellipse 'hollow-ellipse 'dot)       =   'rectangle

Overrides highlight-range in text:basic<%>.

In addition to calling the super method, highlight-range, this method forwards the highlighting to the delegatee.

(send a-text:delegate unhighlight-range   start             end             color            [ caret-space             style])   →   void?

start : exact-nonnegative-integer?

end : exact-nonnegative-integer?

color : (or/c string? (is-a?/c color%))

caret-space : boolean? = #f

style   :   (symbols 'rectangle 'ellipse 'hollow-ellipse)       =   'rectangle

Overrides unhighlight-range in text:basic<%>.

This method propagates the call to the delegate and calls the super method.

(send a-text:delegate on-paint   before?             dc             left             top             right             bottom             dx             dy             draw-caret)   →   void?

before? : any/c

dc : (is-a?/c dc<%>)

left : real?

top : real?

right : real?

bottom : real?

dx : real?

dy : real?

draw-caret : (one-of/c 'no-caret 'show-inactive-caret 'show-caret)

Overrides on-paint in editor<%>.

Draws a blue region in the delegatee editor that shows where the visible region of the delegate editor is.

(send a-text:delegate on-edit-sequence) → void?

Augments on-edit-sequence in editor<%>.

starts an edit sequence in the delegate.

(send a-text:delegate after-edit-sequence) → void?

Augments after-edit-sequence in editor<%>.

ends an edit sequence in the delegate.

(send a-text:delegate resized   snip             redraw-now?)   →   void?

snip : (is-a?/c snip%)

redraw-now? : boolean?

Overrides resized in editor<%>.

Sends a message to the delegate to update the size of the copied snip, if there is one.

(send a-text:delegate after-insert   start             len)   →   void?

start : exact-nonnegative-integer?

len : exact-nonnegative-integer?

Augments after-insert in text%.

forwards the change to the delegate

(send a-text:delegate after-delete   start             len)   →   void?

start : exact-nonnegative-integer?

len : exact-nonnegative-integer?

Augments after-delete in text%.

forwards the change to the delegate.

(send a-text:delegate after-change-style   start             len)   →   void?

start : exact-nonnegative-integer?

len : exact-nonnegative-integer?

Augments after-change-style in text%.

forwards the changed style to the delegate.

(send a-text:delegate on-load-file   filename             format)   →   void?

filename : string?

format : symbol?

Augments on-load-file in editor<%>.

remembers the filename, for use in after-load-file.

(send a-text:delegate after-load-file success?) → void?

success? : boolean?

Augments after-load-file in editor<%>.

updates the delegate with the new contents of the text.