method (send an-editor:basic has-focus?) → boolean?

This function returns #t when the editor has the keyboard focus. It is implemented using: on-focus

method (send an-editor:basic local-edit-sequence?) → boolean?

Indicates if this editor is in an edit sequence. Enclosing buffer’s edit-sequence status is not considered by this method.

See begin-edit-sequence and end-edit-sequence for more info about edit sequences.

method (send an-editor:basic run-after-edit-sequence   thunk            [ tag])   →   void?

thunk : (-> void?)

tag : (or/c symbol? #f) = #f

This method is used to install callbacks that will be run after any edit-sequence completes.

The procedure thunk will be called immediately if the edit is not in an edit-sequence. If the edit is in an edit-sequence, it will be called when the edit-sequence completes.

If tag is a symbol, the thunk is keyed on that symbol, and only one thunk per symbol will be called after the edit-sequence. Specifically, the last call to run-after-edit-sequence’s argument will be called.

method (send an-editor:basic get-top-level-window)

→ (or/c #f (is-a?/c top-level-window<%>))

Returns the top-level-window<%> currently associated with this buffer.

This does not work for embedded editors.

method (send an-editor:basic save-file-out-of-date?) → boolean?

Returns #t if the file on disk has been modified, by some other program.

method (send an-editor:basic save-file/gui-error  [ filename       format       show-errors?])

→ boolean?

filename : (or/c path? #f) = #f

format   :   (or/c 'guess  'standard  'text  'text-force-cr  'same  'copy)       =   'same

show-errors? : boolean? = #t

This method is an alternative to save-file. Rather than showing errors via the original stdout, it opens a dialog with an error message showing the error.

The result indicates if an error happened (the error has already been shown to the user). It returns #t if no error occurred and #f if an error occurred.

method (send an-editor:basic load-file/gui-error  [ filename       format       show-errors?])

→ boolean?

filename : (or/c string? #f) = #f

format   :   (or/c 'guess  'standard  'text  'text-force-cr  'same  'copy)       =   'guess

show-errors? : boolean? = #t

This method is an alternative to load-file. Rather than showing errors via the original stdout, it opens a dialog with an error message showing the error.

The result indicates if an error happened (the error has already been shown to the user). It returns #t if no error occurred and #f if an error occurred.

method (send an-editor:basic on-close) → void?

This method is called when an editor is closed. Typically, this method is called when the frame containing the editor is closed, but in some cases an editor is considered “closed” before the frame it is in is closed (e.g., when a tab in DrRacket is closed), and thus on-close will be called at that point.

See also can-close? and close.

Does nothing.

method (send an-editor:basic can-close?) → boolean?

This method is called to query the editor if is okay to close the editor. Although there is no visible effect associated with closing an editor, there may be some cleanup actions that need to be run when the user is finished with the editor (asking if it should be saved, for example).

See also on-close and close.

Returns #t.

method (send an-editor:basic close) → boolean?

This method is merely

(if (can-close?)

(begin (on-close) #t)

#f)

It is intended as a shorthand, helper method for closing an editor. See also can-close? and on-close.

method (send an-editor:basic get-filename/untitled-name) → string?

Returns the printed version of the filename for this editor. If the editor doesn’t yet have a filename, it returns a symbolic name (something like "Untitled").

method (send an-editor:basic get-pos/text event)

→   (or/c false/c number?) (or/c false/c (is-a?/c editor<%>))

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

Calls get-pos/text-dc-location with the x and y coordinates of event.

method (send an-editor:basic get-pos/text-dc-location   x       y)

→   (or/c false/c number?) (or/c false/c (is-a?/c editor<%>))

x : exact-integer?

y : exact-integer?

This method’s first result is #f when the mouse event does not correspond to a location in the editor.

If the second result is a text% object, then the first result will be a position in the editor and otherwise the first result will be #f.

The editor<%> object will always be the nearest enclosing editor containing the point (x, y).

method (send an-editor:basic can-save-file?   filename             format)   →   boolean?

filename : string?

format : symbol?

Augments can-save-file? in editor<%>.

Checks to see if the file on the disk has been modified out side of this editor, using save-file-out-of-date?. If it has, this method prompts the user to be sure they want to save.

method (send an-editor:basic after-save-file success?) → void?

success? : boolean?

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

If the current filename is not a temporary filename, this method calls handler:add-to-recentwith the current filename.

to add the new filename to the list of recently opened files.

Additionally, updates a private instance variable with the modification time of the file, for using in implementing save-file-out-of-date?.

method (send an-editor:basic after-load-file success?) → void?

success? : boolean?

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

Updates a private instance variable with the modification time of the file, for using in implementing save-file-out-of-date?

method (send an-editor:basic on-focus on?) → void?

on? : boolean?

Overrides on-focus in editor<%>.

Manages the state to implement has-focus?

method (send an-editor:basic on-edit-sequence) → boolean?

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

Always returns #t. Updates a flag for local-edit-sequence?

method (send an-editor:basic after-edit-sequence) → void?

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

Helps to implement run-after-edit-sequence.

method (send an-editor:basic on-new-box type) → (is-a?/c editor-snip%)

type : (or/c 'pasteboard  'text)

Overrides on-new-box in editor<%>.

Creates instances of pasteboard:basic% or text:basic% instead of the built in pasteboard% and text% classes.

method (send an-editor:basic on-new-image-snip   filename       kind       relative-path?       inline?)

→ (is-a?/c image-snip%)

filename : (or/c path? false/c)

kind : (one-of/c 'unknown 'gif 'jpeg 'xbm 'xpm 'bmp 'pict)

relative-path? : any/c

inline? : any/c

Overrides on-new-image-snip in editor<%>.

(super on-new-image-snip

(if (eq? kind 'unknown) 'unknown/mask kind)

relative-path?

inline?)

method (send an-editor:basic get-file directory) → string

directory : (or/c path-string? false/c)

Overrides get-file in editor<%>.

Uses finder:get-file to find a filename. Also, sets the parameter finder:dialog-parent-parameter to the result of get-top-level-window.

method (send an-editor:basic put-file   directory             default-name)   →   string

directory : (or/c path? false/c)

default-name : (or/c path? false/c)

Overrides put-file in editor<%>.

Uses finder:put-file to find a filename. Also, sets the parameter finder:dialog-parent-parameter to the result of get-top-level-window.

method (send an-editor:keymap get-keymaps)

→ (list-of (is-a?/c keymap%))

The keymaps returned from this method are chained to this editor<%>’s keymap.

The result of this method should not change – that is, it should return the same list of keymaps each time it is called.

See also editor:add-after-user-keymap.

Returns (list (keymap:get-user) (keymap:get-global)) by default.

method (send an-editor:file get-can-close-parent)

→ (or/c false (is-a?/c frame%) (is-a?/c dialog%))

The result of this method is used as the parent for the dialog that asks about closing.

Returns #f by default.

method (send an-editor:file update-frame-filename) → void?

Attempts to find a frame that displays this editor. If it does, it updates the frame’s title based on a new filename in the editor.

method (send an-editor:file allow-close-with-no-filename?) → boolean?

This method indicates if closing the file when it hasn’t been saved is a reason to alert the user. See also can-close?.

Returns #f by default.

method (send an-editor:file user-saves-or-not-modified? allow-cancel?)

→ boolean?

allow-cancel? : #t

If the file has not been saved, this prompts the user about saving and, if the user says to save, then it saves the file.

The result is #t if the save file is up to date, or if the user says it is okay to continue without saving. Generally used when closing the file or quiting the app.

method (send an-editor:file set-filename   name            [ temp?])   →   void?

name : string?

temp? : boolean? = #f

Overrides set-filename in editor<%>.

Updates the filename on each frame displaying this editor, for each frame that matches frame:editor<%>.

method (send an-editor:file can-close?) → boolean?

Augments can-close? in editor:basic<%>.

If the allow-close-with-no-filename? method returns #f, this method checks to see if the file has been saved at all yet. If not, it asks the user about saving (and saves if they ask).

If the allow-close-with-no-filename? method returns #t, this method does as before, except only asks if the editor’s get-filenamemethod returns a path.

Also calls inner.

method (send an-editor:file get-keymaps)

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

method (send an-editor:backup-autosave backup?) → boolean?

Indicates whether this editor<%> should be backed up.

Returns the value of the preferences:get applied to 'framework:backup-files?.

method (send an-editor:backup-autosave autosave?) → boolean?

Indicates whether this editor<%> should be autosaved.

Returns #t.

method (send an-editor:backup-autosave do-autosave) → (or/c #f path?)

This method is called to perform the autosaving. See also autosave:register

When the file has been modified since it was last saved and autosaving it turned on (via the autosave? method) an autosave file is created for this editor<%>.

Returns the filename where the autosave took place, or #f if none did.

method (send an-editor:backup-autosave remove-autosave) → void?

This method removes the autosave file associated with this editor<%>.

method (send an-editor:backup-autosave on-save-file   filename             format)   →   bool

filename : path?

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

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

If a backup file has not been created this session for this file, deletes any existing backup file and copies the old save file into the backup file. For the backup file’s name, see path-utils:generate-backup-name

method (send an-editor:backup-autosave on-close) → void?

Augments on-close in editor:basic<%>.

Deletes the autosave file and turns off autosaving.

method (send an-editor:backup-autosave on-change) → void?

Augments on-change in editor<%>.

Sets a flag indicating that this editor<%> needs to be autosaved.

method (send an-editor:backup-autosave set-modified modified?) → void?

modified? : any/c

Overrides set-modified in editor<%>.

If the file is no longer modified, this method deletes the autosave file. If it is, it updates a flag to indicate that the autosave file is out of date.

method (send an-editor:info lock lock?) → void?

lock? : boolean?

Overrides lock in editor<%>.

Uses run-after-edit-sequence to call lock-status-changed.

procedure (editor:set-default-font-color color) → void?

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

procedure (editor:get-default-color-style-name) → string?

procedure (editor:set-standard-style-list-delta   name             delta)   →   void?

name : string?

delta : (is-a?/c style-delta%)

procedure (editor:set-standard-style-list-pref-callbacks) → any

procedure (editor:get-standard-style-list) → (is-a?/c style-list%)

procedure (editor:add-after-user-keymap   keymap       keymaps)

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

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

keymaps : (listof (is-a?/c keymap%))