{"size": 31908, "ext": "scrbl", "max_stars_repo_path": "gui-doc/scribblings/gui/pasteboard-class.scrbl", "max_stars_repo_name": "alex-hhh/gui", "max_stars_repo_stars_event_min_datetime": null, "max_stars_repo_stars_event_max_datetime": null, "max_issues_repo_path": "gui-doc/scribblings/gui/pasteboard-class.scrbl", "max_issues_repo_name": "alex-hhh/gui", "max_issues_repo_issues_event_min_datetime": null, "max_issues_repo_issues_event_max_datetime": null, "max_forks_repo_path": "gui-doc/scribblings/gui/pasteboard-class.scrbl", "max_forks_repo_name": "alex-hhh/gui", "max_forks_repo_forks_event_min_datetime": null, "max_forks_repo_forks_event_max_datetime": null}
{"max_stars_count": null, "max_issues_count": null, "max_forks_count": null, "avg_line_length": 26.7236180905, "max_line_length": 91, "alphanum_fraction": 0.662498433}
#lang scribble/doc
@(require "common.rkt")

@defclass/title[pasteboard% object% (editor<%>)]{

A @racket[pasteboard%] object is an editor for displaying snips with
 arbitrary @techlink{location}s.

@defconstructor[()]{

The editor will not be displayed until it is attached to an
 @racket[editor-canvas%] object or some other @techlink{display}.

A new @racket[keymap%] object is created for the new editor.  See also
 @method[editor<%> get-keymap] and @method[editor<%> set-keymap].

A new @racket[style-list%] object is created for the new editor.  See
 also @method[editor<%> get-style-list] and @method[editor<%>
 set-style-list].

}


@defmethod*[([(add-selected [snip (is-a?/c snip%)])
              void?]
             [(add-selected [x real?]
                            [y real?]
                            [w (and/c real? (not/c negative?))]
                            [h (and/c real? (not/c negative?))])
              void?])]{

Selects snips without deselecting other snips. When coordinates are
 given, this method selects all snips that intersect with the given
 rectangle (in editor coordinates).

@|OnSelectNote|

}


@defmethod[#:mode pubment 
           (after-delete [snip (is-a?/c snip%)])
           void?]{
@methspec{

Called after a snip is deleted from the editor (and after the
 @techlink{display} is refreshed; use @method[pasteboard% on-delete]
 and @method[editor<%> begin-edit-sequence] to avoid extra refreshes
 when @method[pasteboard% after-delete] modifies the editor).

See also @method[pasteboard% can-delete?] and @method[editor<%>
 on-edit-sequence].

No internals locks are set when this method is called.

}
@methimpl{
Does nothing.
}
}


@defmethod[#:mode pubment 
           (after-insert [snip (is-a?/c snip%)]
                         [before (or/c (is-a?/c snip%) #f)]
                         [x real?]
                         [y real?])
           void?]{

@methspec{

Called after a snip is inserted into the editor (and after the
 @techlink{display} is refreshed; use @method[pasteboard% on-insert]
 and @method[editor<%> begin-edit-sequence] to avoid extra refreshes
 when @method[pasteboard% after-insert] modifies the editor).

See also @method[pasteboard% can-insert?] and @method[editor<%>
 on-edit-sequence].

No internals locks are set when this method is called.

}
@methimpl{
Does nothing.
}
}


@defmethod[#:mode pubment 
           (after-interactive-move [event (is-a?/c mouse-event%)])
           void?]{
@methspec{

Called after the user stops interactively dragging snips (the ones
 that are selected; see @method[pasteboard%
 find-next-selected-snip]). The mouse event that terminated the move
 (usually a button-up event) is provided.

See also @method[pasteboard% can-interactive-move?] and
 @method[pasteboard% on-interactive-move].

}
@methimpl{

Does nothing.

}
}


@defmethod[#:mode pubment 
           (after-interactive-resize [snip (is-a?/c snip%)])
           void?]{
@methspec{

Called after the user stops interactively resizing a snip (the one
 that is currently selected; see @method[pasteboard%
 find-next-selected-snip]). The @racket[snip] argument is the snip
 that was resized.

See also @method[pasteboard% can-interactive-resize?] and
 @method[pasteboard% on-interactive-resize].

}
@methimpl{

Does nothing.

}}


@defmethod[#:mode pubment 
           (after-move-to [snip (is-a?/c snip%)]
                          [x real?]
                          [y real?]
                          [dragging? any/c])
           void?]{
@methspec{

Called after a given snip is moved within the editor (and after the
 @techlink{display} is refreshed; use @method[pasteboard% on-move-to]
 and @method[editor<%> begin-edit-sequence] to avoid extra refreshes
 when @method[pasteboard% after-move-to] modifies the editor).

If @racket[dragging?] is not @racket[#f], then this move was a temporary
 move for dragging.

See also
 @method[pasteboard% can-move-to?] and
 @method[editor<%> on-edit-sequence].

No internals locks are set when this method is called.

}
@methimpl{

Does nothing.

}}


@defmethod[#:mode pubment 
           (after-reorder [snip (is-a?/c snip%)]
                          [to-snip (is-a?/c snip%)]
                          [before? any/c])
           boolean?]{
@methspec{

Called before a snip is moved in the pasteboard's front-to-back snip
 order (and after the @techlink{display} is refreshed; use
 @method[pasteboard% on-reorder] and @method[editor<%>
 begin-edit-sequence] to avoid extra refreshes when
 @method[pasteboard% after-reorder] modifies the editor).

If @racket[before?] is @racket[#t], then @racket[snip] was moved before
 @racket[to-snip], otherwise @racket[snip] was moved after @racket[to-snip].

See also @method[pasteboard% can-reorder?] and @method[editor<%>
 on-edit-sequence].

No internals locks are set when this method is called.

}
@methimpl{

Does nothing.

}}


@defmethod[#:mode pubment 
           (after-resize [snip (is-a?/c snip%)]
                         [w (and/c real? (not/c negative?))]
                         [h (and/c real? (not/c negative?))]
                         [resized? any/c])
           void?]{
@methspec{

Called after a given snip is resized (and after the @techlink{display}
 is refreshed; use @method[pasteboard% on-resize] and
 @method[editor<%> begin-edit-sequence] to avoid extra refreshes when
 @method[pasteboard% after-resize] modifies the editor), or after an
 unsuccessful resize attempt was made.

If @racket[resized?] is not @racket[#f], the snip was successfully
 resized.

See also @method[pasteboard% can-resize?] and @method[editor<%>
 on-edit-sequence].

No internals locks are set when this method is called.

}
@methimpl{

Does nothing.

}}


@defmethod[#:mode pubment 
           (after-select [snip (is-a?/c snip%)]
                         [on? any/c])
           void?]{

@methspec{

Called after a snip in the pasteboard is selected or deselected. See
 also @method[pasteboard% on-select].  This method is not called after
 selected snip is deleted (and thus de-selected indirectly); see also
 @method[pasteboard% after-delete].

If @racket[on?] is @racket[#t], then @racket[snip] was just selected,
 otherwise @racket[snip] was just deselected.

See also @method[pasteboard% can-select?] and @method[editor<%>
 on-edit-sequence].

No internals locks are set when this method is called.

}
@methimpl{

Does nothing.

}}


@defmethod[#:mode pubment 
           (can-delete? [snip (is-a?/c snip%)])
           boolean?]{

@methspec{

Called before a snip is deleted from the editor.
 If the return value is @racket[#f], then the
 delete will be aborted.

See also @method[pasteboard% on-delete] and @method[pasteboard%
 after-delete].

The editor is internally locked for writing when this method is called (see
 also @|lockdiscuss|).

}
@methimpl{

Returns @racket[#t].

}
}

@defmethod[#:mode pubment 
           (can-insert? [snip (is-a?/c snip%)]
                        [before (or/c (is-a?/c snip%) #f)]
                        [x real?]
                        [y real?])
           boolean?]{

@methspec{

Called before a snip is inserted from the editor.  If the return value
 is @racket[#f], then the insert will be aborted.

See also @method[pasteboard% on-insert] and @method[pasteboard%
 after-insert].

The editor is internally locked for writing when this method is called (see
 also @|lockdiscuss|).

}
@methimpl{

Returns @racket[#t].

}
}


@defmethod[#:mode pubment 
           (can-interactive-move? [event (is-a?/c mouse-event%)])
           boolean?]{

@methspec{

Called when the user starts interactively dragging snips (the ones
 that are selected; see @method[pasteboard%
 find-next-selected-snip]). All of the selected snips will be
 moved. If @racket[#f] is returned, the interactive move is
 disallowed. The mouse event that started the move (usually a
 button-down event) is provided.

See also @method[pasteboard% on-interactive-move], @method[pasteboard%
 after-interactive-move], and @method[pasteboard%
 interactive-adjust-move].

}
@methimpl{

Returns @racket[#t].

}}


@defmethod[#:mode pubment 
           (can-interactive-resize? [snip (is-a?/c snip%)])
           boolean?]{
@methspec{

Called when the user starts interactively resizing a snip (the one
 that is selected; see @method[pasteboard%
 find-next-selected-snip]). If @racket[#f] is returned, the
 interactive resize is disallowed.

The @racket[snip] argument is the snip that will be resized.

See also @method[pasteboard% after-interactive-resize],
 @method[pasteboard% after-interactive-resize], and
 @method[pasteboard% interactive-adjust-resize].

}
@methimpl{

Returns @racket[#t].

}}


@defmethod[#:mode pubment 
           (can-move-to? [snip (is-a?/c snip%)]
                         [x real?]
                         [y real?]
                         [dragging? any/c])
           boolean?]{
@methspec{

Called before a snip is moved in the editor.  If the return value is
 @racket[#f], then the move will be aborted.

If @racket[dragging?] is not @racket[#f], then this move is a
 temporary move for dragging.

See also @method[pasteboard% on-move-to] and @method[pasteboard%
 after-move-to].

The editor is internally locked for writing when this method is called
 (see also @|lockdiscuss|).

}
@methimpl{

Returns @racket[#t].

}}


@defmethod[#:mode pubment 
           (can-reorder? [snip (is-a?/c snip%)]
                         [to-snip (is-a?/c snip%)]
                         [before? any/c])
           boolean?]{
@methspec{

Called before a snip is moved in the pasteboard's front-to-back snip
 order.  If the return value is @racket[#f], then the reordering will
 be aborted.

If @racket[before?] is @racket[#t], then @racket[snip] is to be moved before
 @racket[to-snip], otherwise @racket[snip] is to be moved after
 @racket[to-snip].

See also @method[pasteboard% on-reorder] and @method[pasteboard%
 after-reorder].

The editor is internally locked for writing when this method is called (see
 also @|lockdiscuss|).

}
@methimpl{

Returns @racket[#t].

}}


@defmethod[#:mode pubment 
           (can-resize? [snip (is-a?/c snip%)]
                        [w (and/c real? (not/c negative?))]
                        [h (and/c real? (not/c negative?))])
           boolean?]{

@methspec{

Called before a snip is resized in the editor.  If the return value is
 @racket[#f], then the resize will be aborted.

See also @method[pasteboard% on-resize] and @method[pasteboard%
 after-resize].

The editor is internally locked for writing when this method is called (see
 also @|lockdiscuss|).

}
@methimpl{

Returns @racket[#t].

}}

@defmethod[#:mode pubment 
           (can-select? [snip (is-a?/c snip%)]
                        [on? any/c])
           boolean?]{
@methspec{

This method is called before a snip in the pasteboard is selected or
 deselected. If @racket[#f] is returned, the selection change is
 disallowed. This method is not called when a selected snip is to be
 deleted (and thus de-selected indirectly); see also
 @method[pasteboard% can-delete?].

If @racket[on?] is @racket[#t], then @racket[snip] will be selected,
otherwise @racket[snip] will be deselected.

See also @method[pasteboard% on-select] and @method[pasteboard%
 after-select].

The editor is internally locked for writing when this method is called (see
 also @|lockdiscuss|). 

}
@methimpl{

Returns @racket[#t].

}}


@defmethod*[([(change-style [style (or/c (is-a?/c style-delta%) (is-a?/c style<%>) #f) #f]
                            [snip (or/c (is-a?/c snip%) #f) #f])
              void?])]{

Changes the style of @racket[snip] to a specific style or by applying
 a style delta.  If @racket[snip] is @racket[#f], then all currently
 selected snips are changed. If @racket[style] is @racket[#f], then 
 the default style is used, according to @method[editor<%> default-style-name].
 
To change a large collection of snips from one style to another style,
 consider providing a @racket[style<%>] instance rather than a
 @racket[style-delta%] instance. Otherwise, @method[pasteboard%
 change-style] must convert the @racket[style-delta%] instance to the
 @racket[style<%>] instance for every snip; this conversion consumes
 both time and (temporary) memory.

When a @racket[style] is provided: @InStyleListNote[@racket[style]]

}


@defmethod[#:mode override
           (copy-self-to [dest (or/c (is-a?/c text%) (is-a?/c pasteboard%))])
           void?]{

In addition to the default @xmethod[editor<%> copy-self-to] work, the
 dragability, selection visibility state, and scroll step of
 @this-obj[] are installed into @racket[dest].

}


@defmethod*[([(delete)
              void?]
             [(delete [snip (is-a?/c snip%)])
              void?])]{

Deletes @racket[snip] when provided, or deletes the currently selected
 snips from the editor when @racket[snip] is not provided.

@MonitorMethod[@elem{The content of an editor} @elem{the
 system in response to other method
 calls} @elem{@method[pasteboard% on-delete]} @elem{content deletion}]

}


@defmethod[(do-copy [time exact-integer?]
                    [extend? any/c])
           void?]{

@methspec{

Called to copy the editor's current selection into the clipboard.
 This method is provided so that it can be overridden by subclasses.
 Do not call this method directly; instead, call @method[editor<%>
 copy].

See @|timediscuss| for a discussion of the @racket[time] argument. If
 @racket[time] is outside the platform-specific range of times,
 @|MismatchExn|.

}
@methimpl{

Copies the current selection, extending the current clipboard contexts
 if @racket[extend?] is true.

}}


@defmethod[(do-paste [time exact-integer?])
           void?]{
@methspec{

Called to paste the current contents of the clipboard into the editor.
 This method is provided so that it can be overridden by subclasses.
 Do not call this method directly; instead, call @method[editor<%>
 paste].

See @|timediscuss| for a discussion of the @racket[time] argument. If
 @racket[time] is outside the platform-specific range of times,
 @|MismatchExn|.

}
@methimpl{

Pastes.

}}


@defmethod[(do-paste-x-selection [time exact-integer?])
           void?]{
@methspec{

Called to paste the current contents of the X11 selection on Unix (or
 the clipboard on Windows and Mac OS) into the editor.  This
 method is provided so that it can be overridden by subclasses.  Do
 not call this method directly; instead, call @method[editor<%>
 paste-x-selection].

See @|timediscuss| for a discussion of the @racket[time] argument. If
 @racket[time] is outside the platform-specific range of times,
 @|MismatchExn|.

}
@methimpl{

Pastes.

}}


@defmethod[(erase)
           void?]{

Deletes all snips from the editor.

See also @method[pasteboard% delete].

}


@defmethod[(find-next-selected-snip [start (or/c (is-a?/c snip%) #f)])
           (or/c (is-a?/c snip%) #f)]{

Returns the next selected snip in the editor, starting the search
 after @racket[start]. (@|seesniporderdiscuss|) If @racket[start] is @racket[#f],
 then the search starts with the first snip in the editor (and thus
 returns the first selected snip, if any are selected). If no more
 selected snips are available, or if @racket[start] is not in the
 pasteboard, @racket[#f] is returned.

}


@defmethod[(find-snip [x real?]
                      [y real?]
                      [after (or/c (is-a?/c snip%) #f) #f])
           (or/c (is-a?/c snip%) #f)]{

Finds the frontmost snip (after a given snip) that intersects a given
 @techlink{location}.  @|seesniporderdiscuss|

The @racket[x] and @racket[y] arguments are in editor coordinates. If
 @racket[after] is not supplied, the frontmost snip at @racket[x] and
 @racket[y] is returned, otherwise the frontmost snip behind @racket[after]
 is returned. If @racket[after] is a snip that is not in the pasteboard,
 @racket[#f] is returned.

@|OVD|

}


@defmethod[(get-area-selectable)
           boolean?]{

Returns whether snips can be selected by dragging a selection box in the
 pasteboard's background. By default, area selection
 is allowed. See also @method[pasteboard% set-area-selectable].

@history[#:added "1.12"]}


@defmethod[(get-center) (values real? real?)]{

Returns the center of the pasteboard in pasteboard coordinates.

The first result is the x-coordinate of the center and
the second result is the y-coordinate of the center.

}


@defmethod[(get-dragable)
           boolean?]{

Returns whether snips in the editor can be interactively dragged by
 event handling in @method[pasteboard% on-default-event]: @racket[#t]
 if dragging is allowed, @racket[#f] otherwise.  By default, dragging
 is allowed. See also @method[pasteboard% set-dragable].

}

@defmethod[(get-scroll-step)
           (and/c real? (not/c negative?))]{

Gets the editor @techlink{location} offset for each vertical scroll
 position.  See also @method[pasteboard% set-scroll-step].

}


@defmethod[(get-selection-visible)
           boolean?]{

Returns whether selection dots are drawn around the edge of selected
 snips in the pasteboard. By default, selection dots are on. See also
 @method[pasteboard% set-selection-visible].

}


@defmethod*[#:mode extend
            ([(insert [snip (is-a?/c snip%)])
              void?]
             [(insert [snip (is-a?/c snip%)]
                      [before (or/c (is-a?/c snip%) #f)]
                      [x real?]
                      [y real?])
              void?]
             [(insert [snip (is-a?/c snip%)]
                      [x real?]
                      [y real?])
              void?]
             [(insert [snip (is-a?/c snip%)]
                      [before (or/c (is-a?/c snip%) #f)])
              void?])]{

Inserts @racket[snip] at @techlink{location} @math{(@racket[x],
 @racket[y])} just in front of
 @racket[before]. (@|seesniporderdiscuss|) If @racket[before] is not
 provided or is @racket[#f], then @racket[snip] is inserted behind all
 other snips. If @racket[x] and @racket[y] are not provided, the snip
 is added at @math{(0, 0)}.

}


@defmethod[(interactive-adjust-mouse [x (box/c real?)]
                                     [y (box/c real?)])
           void?]{

@methspec{

This method is called during interactive dragging and resizing (of the
 currently selected snips; see @method[pasteboard%
 find-next-selected-snip]) to preprocess the current mouse
 @techlink{location} (in editor coordinates).  The snip and actual x
 and y coordinates are passed into the method (boxed); the resulting
 coordinates are used instead of the actual mouse @techlink{location}.

See also 
 @method[pasteboard% interactive-adjust-resize].

}
@methimpl{

A negative value for either @racket[x] or @racket[y] is replaced with
 @racket[0].

}}


@defmethod[(interactive-adjust-move [snip (is-a?/c snip%)]
                                    [x (box/c real?)]
                                    [y (box/c real?)])
           void?]{
@methspec{

This method is called during an interactive move (for each selected
 snip) to preprocess the user-determined snip @techlink{location} for each
 selected snip. The snip and mouse-determined @techlink{location}s (in editor
 coordinates) are passed into the method (boxed); the resulting
 @techlink{location}s are used for graphical feedback to the user during moving.

The actual mouse coordinates are first sent through
 @method[pasteboard% interactive-adjust-mouse] before determining the
 @techlink{location}s passed into this method.

}
@methimpl{

Does nothing.

}}


@defmethod[(interactive-adjust-resize [snip (is-a?/c snip%)]
                                      [width (box/c (and/c real? (not/c negative?)))]
                                      [height (box/c (and/c real? (not/c negative?)))])
           void?]{
@methspec{

This method is called during interactive resizing of a snip to
 preprocess the user-determined snip size. The snip and
 mouse-determined height and width are passed into the method (boxed);
 the resulting height and width are used for graphical feedback to the
 user during resizing.

The actual mouse coordinates are first sent through
 @method[pasteboard% interactive-adjust-mouse] before determining the
 sizes passed into this method.

}
@methimpl{

Does nothing.

}}

@defmethod[(is-selected? [snip (is-a?/c snip%)])
           boolean?]{

Returns @racket[#t] if a specified snip is currently selected or
 @racket[#f] otherwise.

}

@defmethod[(lower [snip (is-a?/c snip%)])
           void?]{

Moves the snip one level deeper (i.e., behind one more other snip) in
 the pasteboard's snip order. @|seesniporderdiscuss|

See also @method[pasteboard% raise], @method[pasteboard% set-before],
 and @method[pasteboard% set-after].

}


@defmethod*[([(move [snip (is-a?/c snip%)]
                    [x real?]
                    [y real?])
              void?]
             [(move [x real?]
                    [y real?])
              void?])]{

Moves @racket[snip] right @racket[x] pixels and down @racket[y]
 pixels.  If @racket[snip] is not provided, then all selected snips
 are moved.

@|OnMoveNote|

}


@defmethod[(move-to [snip (is-a?/c snip%)]
                    [x real?]
                    [y real?])
           void?]{

Moves @racket[snip] to a given @techlink{location} in the editor.

@|OnMoveNote|

}


@defmethod[(no-selected)
           void?]{

Deselects all selected snips in the editor.

@|OnSelectNote|

}

@defmethod[#:mode override
           (on-default-char [event (is-a?/c key-event%)])
           void?]{

Calls @method[pasteboard% delete] with no arguments in response to the
Delete or Backspace key, and calls @method[pasteboard% move] with
suitable @racket[0]/@racket[1]/@racket[-1] arguments in response to an
arrow key.

}

@defmethod[#:mode override
           (on-default-event [event (is-a?/c mouse-event%)])
           void?]{

Selects, drags, and resizes snips:

@itemize[

@item{Clicking on a snip selects the snip. Shift-clicking extends
the current selection with the snip.}

@item{Clicking in the space between snips drags a selection
box; once the mouse button is released, all snips touching the
box are selected. Shift-clicking extends the current selection
with the new snips.}

@item{Double-clicking on a snip calls
@method[pasteboard% on-double-click].}

@item{Clicking on a selected snip drags the selected snip(s) to a new
@techlink{location}.}

@item{Clicking on a hiliting tab for a selected object resizes the
object.}

]
}


@defmethod[#:mode pubment 
           (on-delete [snip (is-a?/c snip%)])
           void?]{

Called before a snip is deleted from the editor, after
 @method[pasteboard% can-delete?] is called to verify that the
 deletion is allowed. The @method[pasteboard% after-delete] method is
 guaranteed to be called after the delete has completed.

The editor is internally locked for writing when this method is called
 (see also @|lockdiscuss|). Use @method[pasteboard% after-delete] to
 modify the editor, if necessary.

}


@defmethod[(on-double-click [snip (is-a?/c snip%)]
                            [event (is-a?/c mouse-event%)])
           void?]{
@methspec{

This method is called when the user double-clicks on a snip in the
 editor. The clicked-on snip and event records are passed to the
 method.

}
@methimpl{

If @racket[snip] accepts events, it is designated as the caret owner
 and all snips in the editor are unselected.

}}


@defmethod[#:mode pubment 
           (on-insert [snip (is-a?/c snip%)]
                      [before (or/c (is-a?/c snip%) #f)]
                      [x real?]
                      [y real?])
           void?]{


Called before a snip is inserted from the editor, after
 @method[pasteboard% can-insert?] is called to verify that the
 insertion is allowed. The @method[pasteboard% after-insert] method is
 guaranteed to be called after the insert has completed.

The editor is internally locked for writing when this method is called
 (see also @|lockdiscuss|). Use @method[pasteboard% after-insert] to
 modify the editor, if necessary.

}


@defmethod[#:mode pubment 
           (on-interactive-move [event (is-a?/c mouse-event%)])
           void?]{
@methspec{

Called when the user starts interactively dragging snips (the ones
 that are selected; see @method[pasteboard% find-next-selected-snip]),
 after @method[pasteboard% can-interactive-move?] is called to verify
 that the move is allowed. The @method[pasteboard%
 after-interactive-move] method is guaranteed to be called after the
 move has completed. All of the selected snips will be moved. The
 mouse event that started the move (usually a button-down event) is
 provided.

See also @method[pasteboard% interactive-adjust-move].

}
@methimpl{

Does nothing.

}}

@defmethod[#:mode pubment 
           (on-interactive-resize [snip (is-a?/c snip%)])
           void?]{
@methspec{

Called when the user starts interactively resizing a snip (the one
 that is selected; see @method[pasteboard% find-next-selected-snip]),
 after @method[pasteboard% can-interactive-resize?] is called to
 verify that the resize is allowed. The @method[pasteboard%
 after-interactive-resize] method is guaranteed to be called after the
 resize has completed.

The @racket[snip] argument is the snip that will be resized. 

}
@methimpl{

Does nothing.

}}


@defmethod[#:mode pubment 
           (on-move-to [snip (is-a?/c snip%)]
                       [x real?]
                       [y real?]
                       [dragging? any/c])
           void?]{
@methspec{

Called before a snip is moved in the editor, after @method[pasteboard%
 can-move-to?] is called to verify that the move is allowed. The
 @method[pasteboard% after-move-to] method is guaranteed to be called
 after the move has completed.

If @racket[dragging?] is not @racket[#f], then this move is a
 temporary move for dragging.

The editor is internally locked for writing when this method is called
 (see also @|lockdiscuss|). Use @method[pasteboard% after-move-to] to
 modify the editor, if necessary. See also @method[pasteboard%
 on-interactive-move] and @method[pasteboard%
 interactive-adjust-move].

}
@methimpl{

Does nothing.

}}


@defmethod[#:mode pubment 
           (on-reorder [snip (is-a?/c snip%)]
                       [to-snip (is-a?/c snip%)]
                       [before? any/c])
           void?]{
@methspec{

Called before a snip is moved in the pasteboard's front-to-back snip
 order, after @method[pasteboard% can-reorder?] is called to verify
 that the reorder is allowed. The @method[pasteboard% after-reorder]
 method is guaranteed to be called after the reorder has completed.

If @racket[before?] is @racket[#t], then @racket[snip] is to be moved
 before @racket[to-snip], otherwise @racket[snip] is to be moved after
 @racket[to-snip].

The editor is internally locked for writing when this method is called
 (see also @|lockdiscuss|). Use @method[pasteboard% after-reorder] to
 modify the editor, if necessary.

}
@methimpl{

Does nothing.

}}

@defmethod[#:mode pubment 
           (on-resize [snip (is-a?/c snip%)]
                      [w (and/c real? (not/c negative?))]
                      [h (and/c real? (not/c negative?))])
           void?]{

@methspec{

Called before a snip is resized by the editor, after
 @method[pasteboard% can-resize?] is called to verify that the resize
 is allowed. The @method[pasteboard% after-resize] method is
 guaranteed to be called after the resize has completed.

The editor is internally locked for writing when this method is called (see
 also @|lockdiscuss|). Use
@method[pasteboard% after-resize] to modify the editor, if necessary. 

Note that a snip calls
@method[editor<%> resized], not this method, to notify the pasteboard that the snip resized
 itself.

}
@methimpl{

Does nothing.

}}


@defmethod[#:mode pubment 
           (on-select [snip (is-a?/c snip%)]
                      [on? any/c])
           void?]{
@methspec{

Called before a snip in the pasteboard is selected or deselected,
 after @method[pasteboard% can-select?] is called to verify that the
 selection is allowed. The @method[pasteboard% after-select] method is
 guaranteed to be called after the selection has completed.  This
 method is not called when a selected snip is to be deleted (and thus
 de-selected indirectly); see also @method[pasteboard% on-delete] .

If @racket[on?] is @racket[#t], then @racket[snip] will be selected,
 otherwise @racket[snip] will be deselected.

The editor is internally locked for writing when this method is called
 (see also @|lockdiscuss|). Use @method[pasteboard% after-select] to
 modify the editor, if necessary.

}
@methimpl{

Does nothing.

}}


@defmethod[(raise [snip (is-a?/c snip%)])
           void?]{

Moves a snip one level shallower (i.e., in front of one more other
 snip) in the pasteboard's snip order. @|seesniporderdiscuss|

See also @method[pasteboard% lower], @method[pasteboard% set-before],
 and @method[pasteboard% set-after].

}


@defmethod[(remove [snip (is-a?/c snip%)])
           void?]{

Removes the specified snip from the editor in a non-undoable manner
 (so the snip is completely free of the pasteboard can be used in
 other editors).

See also @method[pasteboard% delete].

}


@defmethod[(remove-selected [snip (is-a?/c snip%)])
           void?]{

Deselects @racket[snip] (if it is currently selected) without
 deselecting any other snips.

@|OnSelectNote|

}


@defmethod[(resize [snip (is-a?/c snip%)]
                   [w (and/c real? (not/c negative?))]
                   [h (and/c real? (not/c negative?))])
           boolean?]{

Attempts to resize a given snip. If the snip allows resizing,
 @racket[#t] is returned, otherwise @racket[#f] is returned. Using
 this method instead of calling the snip's @method[snip% resize]
 method directly will make the resize undo-able.

}


@defmethod[(set-after [snip (is-a?/c snip%)]
                      [after (or/c (is-a?/c snip%) #f)])
           void?]{

Changes the depth of @racket[snip] moving it just behind
 @racket[after].  If @racket[after] is @racket[#f], @racket[snip] is
 moved to the back. @|seesniporderdiscuss|

See also @method[pasteboard% raise], @method[pasteboard% lower], and
 @method[pasteboard% set-before].

}

@defmethod[(set-area-selectable [allow-drag? any/c])
           void?]{

Set whether snips can be selected by dragging a selection box in the
 pasteboard's background by event handling in @method[pasteboard%
 on-default-event]: a true value allows selection, @racket[#f]
 disallows selection. See also @method[pasteboard% get-area-selectable].

@history[#:added "1.12"]}


@defmethod[(set-before [snip (is-a?/c snip%)]
                       [before (or/c (is-a?/c snip%) #f)])
           void?]{

Changes the depth of @racket[snip] moving it just in front of
 @racket[before].  If @racket[before] is @racket[#f], @racket[snip] is
 moved to the front. @|seesniporderdiscuss|

See also @method[pasteboard% raise], @method[pasteboard% lower], and
 @method[pasteboard% set-after].

}


@defmethod[(set-dragable [allow-drag? any/c])
           void?]{

Sets whether snips in the editor can be interactively dragged by event
 handling in @method[pasteboard% on-default-event]: a true value
 allows dragging, @racket[#f] disallows dragging.  See also
 @method[pasteboard% get-dragable].

}

@defmethod[(set-scroll-step [stepsize (and/c real? (not/c negative?))])
           void?]{

Sets the editor @techlink{location} offset for each vertical scroll
 position.  See also @method[pasteboard% get-scroll-step].

}

@defmethod[(set-selected [snip (is-a?/c snip%)])
           void?]{

Selects a specified snip (deselecting all others).

@|OnSelectNote|

}

@defmethod[(set-selection-visible [visible? any/c])
           void?]{

Sets whether selection dots are drawn around the edge of selected
 snips in the pasteboard. See also @method[pasteboard%
 get-selection-visible].

}}
