image-snip% : class?

superclass: snip%

An image-snip% is a snip that can display bitmap images (usually loaded from a file). When the image file cannot be found, a box containing an “X” is drawn.

(make-object image-snip%  [ filename       kind       relative-path?       inline?])

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

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

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

relative-path? : any/c = #f

inline? : any/c = #t

(make-object image-snip% bitmap [mask]) → (is-a?/c image-snip%)

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

mask : (or/c (is-a?/c bitmap%) false/c) = #f

Creates an image snip, loading the image filename if specified (see also load-file), or using the given bitmap.

(send an-image-snip get-bitmap)

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

Returns the bitmap that is displayed by the snip, whether set through set-bitmap or load-file. If no bitmap is displayed, the result is #f.

The returned bitmap cannot be selected into a bitmap-dc% as long as it belongs to the snip, but it can be used as a pen or brush stipple.

(send an-image-snip get-bitmap-mask)

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

Returns the mask bitmap that is used for displaying by the snip, if one was installed with set-bitmap. If no mask is used, the result is #f.

The returned bitmap cannot be selected into a bitmap-dc% as long as it belongs to the snip, but it can be used as a pen or brush stipple.

(send an-image-snip get-filename [relative-path])

→ (or/c path-string? false/c)

relative-path : (or/c (box/c any/c) false/c) = #f

Returns the name of the currently loaded, non-inlined file, or #f if a file is not loaded or if a file was loaded with inlining (the default).

The relative-path box is filled with #t if the loaded file’s path is relative to the owning editor’s path, unless relative-path is #f.

(send an-image-snip get-filetype)

→   (one-of/c 'unknown 'unknwon/mask           'gif 'gif/mask           'jpeg 'png 'png/mask 'xbm 'xpm 'bmp 'pict)

Returns the kind used to load the currently loaded, non-inlined file, or 'unknown if a file is not loaded or if a file was loaded with inlining (the default).

(send an-image-snip load-file   filename            [ kind             relative-path?             inline?])   →   void?

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

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

relative-path? : any/c = #f

inline? : any/c = #t

Loads the file by passing filename and kind to load-file If a bitmap had previously been specified with set-bitmap, that bitmap (and mask) will no longer be used. If filename is #f, then the current image is cleared.

When 'unknown/mask, 'gif/mask, or 'png/mask is specified and the loaded bitmap object includes a mask (see get-loaded-mask), the mask is used for drawing the bitmap (see draw-bitmap).

If relative-path? is not #f and filename is a relative path, then the file will be read using the path of the owning editor’s filename. If the image is not inlined, it will be saved as a relative pathname.

If inline? is not #f, the image data will be saved directly to the file or clipboard when the image is saved or copied (preserving the bitmap’s mask, if any). The source filename and kind is no longer relevant.

(send an-image-snip resize w h) → void?

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

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

Overrides resize in snip%.

The bitmap will be cropped to fit in the given dimensions.

(send an-image-snip set-bitmap bm [mask]) → void?

bm : (is-a?/c bitmap%)

mask : (or/c (is-a?/c bitmap%) false/c) = #f

Sets the bitmap that is displayed by the snip. This method also accepts an optional mask to be used when drawing the bitmap (see draw-bitmap), but supplying the mask directly is now deprecated. Instead, if no mask is supplied but the bitmap’s get-loaded-mask method produces a bitmap of the same dimensions, it is used as the mask. Furthermore, such a mask is saved with the snip when it is saved to a file or copied (whereas a directly supplied mask is not saved).

The supplied bitmap must not be selected into a bitmap-dc% object, otherwise an exn:fail:contract exception is raised, and it cannot be selected into a bitmap-dc% as long as it belongs to the snip, but it can be used as a pen or brush stipple.

(send an-image-snip set-offset dx dy) → void?

dx : real?

dy : real?

Sets a graphical offset for the bitmap within the image snip.