27 Text

text:basic<%> : interface?

implements:  editor:basic<%>   text%

Classes matching this interface are expected to implement the basic functionality needed by the framework.

(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 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)   →   void

dest-text : (instance text%)

start : exact-integer

end : exact-integer

dest-pos : exact-integer

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 a snip refused to be moved, it will be copied, 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)

→ (union |#f| (instance 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

Defaultly returns the result of icon:get-autowrap-bitmap

(send a-text:basic get-port-name) → symbol?

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 DrScheme. See also port-name-matches?.

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

id : (or/c path? symbol?)

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 port-name-matches?.

text:basic-mixin : (class? . -> . class?)

argument extends/implements:  editor:basic<%>   text%

result implements:  text:basic<%>

This mixin implements the basic functionality needed for text% objects in the framework.

The class that this mixin produces uses the same initialization arguments as it’s input.

(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-int

end : exact-int

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)   →   void

directory : path

default-name : path

Overrides put-file in editor<%>.

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

text:foreground-color<%> : interface?

implements:  text:basic<%>   editor:standard-style-list<%>

text:foreground-color-mixin : (class? . -> . class?)

argument extends/implements:  text:basic<%>   editor:standard-style-list<%>

result implements:  text:foreground-color<%>

This mixin changes the default text style to have the foreground color controlled by editor:set-default-font-color.

(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.

text:hide-caret/selection<%> : interface?

implements:  text:basic<%>

This class hides the caret, except when the selection is active.

Instances of this class are useful for editors that used for displaying purposes, but still allow users to copy their text.

text:hide-caret/selection-mixin : (class? . -> . class?)

argument extends/implements:  text:basic<%>

result implements:  text:hide-caret/selection<%>

(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.

text:nbsp->space<%> : interface?

implements:  text%

Classes that implement this interface silently change non-breaking spaces, ie the character (integer->char 160), to regular spaces when inserted into the editor.

text:nbsp->space-mixin : (class? . -> . class?)

argument extends/implements:  text%

result implements:  text:nbsp->space<%>

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

start : exact-int

end : exact-int

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.

text:searching<%> : interface?

implements:  editor:keymap<%>   text:basic<%>

Any object matching this interface can be searched.

(send a-text:searching set-searching-str   str            [ cs?])   →   void?

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

cs? : boolean? = #t

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.

(send a-text:searching get-search-hits) → 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-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.

text:searching-mixin : (class? . -> . class?)

argument extends/implements:  editor:keymap<%>   text:basic<%>

result implements:  text:searching<%>

This text% can be searched.

The result of this mixin uses the same initialization arguments as the mixin’s argument.

(send a-text:searching get-keymaps)

→ (list-of (instance 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.

text:return<%> : interface?

implements:  text%

Objects supporting this interface were created by text:return-mixin.

text:return-mixin : (class? . -> . class?)

argument extends/implements:  text%

result implements:  text:return<%>

Use this buffer to perform some special action when return is typed.

(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.

text:wide-snip<%> : interface?

implements:  text:basic<%>

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

snip : (instance 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-tall-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.

text:wide-snip-mixin : (class? . -> . class?)

argument extends/implements:  text:basic<%>

result implements:  text:wide-snip<%>

text:delegate<%> : interface?

implements:  text:basic<%>

Implementations of this interface copy all of the changes to this editor to the result of get-delegate except instead of regular string and tab snips, instead instances of text:1-pixel-string-snip% and text:1-pixel-tab-snip% are created.

The contents of the two editor are kept in sync, as modifications to this object happen.

(send a-text:delegate get-delegate)

→ (union |#f| (instanceof 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 : (union |#f| (instanceof 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.

text:1-pixel-string-snip% : class?

superclass: string-snip%

This class re-uses the implementation of string-snip% to implement a string snip that just draws a single pixel for each character in the string.

See also text:1-pixel-tab-snip% for a similar extension to the tab-snip%class.

This snip is used in conjunction with the frame:delegate<%> and text:delegate<%> interfaces.

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

position : exact

first : (box (instanceof snip%))

second : (box (instanceof 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) → (instanceof 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 : (instanceof dc<%>)

x : real

y : real

w : (box (union non-negative-real-number |#f|)) = |#f|

h : (box (union non-negative-real-number |#f|)) = |#f|

descent : (box (union non-negative-real-number |#f|)) = |#f|

space : (box (union non-negative-real-number |#f|)) = |#f|

lspace : (box (union non-negative-real-number |#f|)) = |#f|

rspace : (box (union non-negative-real-number |#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

pos : exact = 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 : (instanceof dc<%>)

x : real

y : real

left : real

top : real

right : real

bottom : real

dx : real

dy : real

draw-caret : (union 'no-caret  'show-inactive-caret  'show-caret)

Overrides draw in snip%.

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

text:1-pixel-tab-snip% : class?

superclass: tab-snip%

This class re-uses the implementation of tab-snip% to implement a string snip that is always one pixel high.

See also text:1-pixel-string-snip% for a similar extension to the string-snip%class.

This snip is used in conjunction with the frame:delegate<%> and text:delegate<%> interfaces.

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

position : exact

first : (box (instanceof snip%))

second : (box (instanceof 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) → (instanceof 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 : (instanceof dc<%>)

x : real

y : real

w : (box (union non-negative-real-number |#f|)) = |#f|

h : (box (union non-negative-real-number |#f|)) = |#f|

descent : (box (union non-negative-real-number |#f|)) = |#f|

space : (box (union non-negative-real-number |#f|)) = |#f|

lspace : (box (union non-negative-real-number |#f|)) = |#f|

rspace : (box (union non-negative-real-number |#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 : (instanceof dc<%>)

x : real

y : real

left : real

top : real

right : real

bottom : real

dx : real

dy : real

draw-caret : (union 'no-caret  'show-inactive-caret  'show-caret)

Overrides draw in snip%.

Draws nothing.

text:delegate-mixin : (class? . -> . class?)

argument extends/implements:  text:basic<%>

result implements:  text:delegate<%>

This mixin provides an implementation of the text:delegate<%> interface.

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

start : exact-integer

end : exact-integer

color : (instance color%)

bitmap : (union |#f| (instance bitmap%))

caret-space : boolean = |#f|

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

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            [ bitmap             caret-space])   →   void

start : exact-integer

end : exact-integer

color : (instance color%)

bitmap : (union |#f| (instance bitmap%)) = |#f|

caret-space : boolean = |#f|

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

This method propagates the call to the delegate.

(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 : number

len : number

Augments after-insert in text%.

forwards the change to the delegate

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

start : number

len : number

Augments after-delete in text%.

forwards the change to the delegate.

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

start : number

len : number

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.

text:info<%> : interface?

implements:  text:basic<%>

Objects supporting this interface are expected to send information about themselves to the frame that is displaying them.

text:info-mixin : (class? . -> . class?)

argument extends/implements:  editor:keymap<%>   text:basic<%>

result implements:  text:info<%>

This mixin adds support for supplying information to objects created with frame:info-mixin. When this editor:basic<%> is displayed in a frame, that frame must have been created with frame:info-mixin.

(send a-text:info set-anchor on?) → void

on? : any/c

Overrides set-anchor in text%.

Calls the anchor-status-changed method of the frame that is viewing this object. It uses get-canvas to get the canvas for this frame, and uses that canvas’s top-level-window<%> as the frame.

(send a-text:info set-overwrite-mode on?) → void

on? : any/c

Overrides set-overwrite-mode in text%.

Calls the overwrite-status-changedmethod of the frame that is viewing this object. It uses get-canvas to get the canvas for this frame, and uses that canvas’s top-level-window<%> as the frame.

(send a-text:info after-set-position) → void

Augments after-set-position in text%.

Calls the editor-position-changed method of the frame that is viewing this object. It uses get-canvas to get the canvas for this frame, and uses that canvas’s top-level-window<%> as the frame.

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

start : exact-nonnegative-integer?

len : exact-nonnegative-integer?

Augments after-insert in text%.

Calls the editor-position-changed method of the frame that is viewing this object. It uses get-canvas to get the canvas for this frame, and uses that canvas’s top-level-window<%> as the frame.

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

start : exact-nonnegative-integer?

len : exact-nonnegative-integer?

Augments after-delete in text%.

Calls the editor-position-changed method of the frame that is viewing this object. It uses get-canvas to get the canvas for this frame, and uses that canvas’s top-level-window<%> as the frame.

text:clever-file-format<%> : interface?

implements:  text%

Objects supporting this interface are expected to support a clever file format when saving.

text:clever-file-format-mixin : (class? . -> . class?)

argument extends/implements:  text%

result implements:  text:clever-file-format<%>

The result of this mixin uses the same initialization arguments as the mixin’s argument.

When files are saved from this text%, a check is made to see if there are any non-string-snip% objects in the text%. If so, it is saved using the file format 'std. (see set-file-format for more information. If not, the file format passed to save-file is used.

(send a-text:clever-file-format on-save-file   filename             format)   →   void

filename : path?

format : (one-of/c 'guess  'standard  'text  'text-force-cr  'same  'copy)

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

If the method get-file-format returns 'standard and the text has only string-snip%s, the file format is set to 'text.

If the method get-file-format returns 'text and the text has some non string-snip%s, the file format is set to 'standard.

Depending on the user’s preferences, the user may also be queried.

Also, the changes to the file format only happen if the argument file-format is 'copy or 'same.