File: image-mode.el.html

Defines image-mode, a major mode for visiting image files. Displaying images only works if Emacs was built with support for displaying such images. See Info node (emacs) Image Mode for more information.

There is support for switching between viewing the text of the file, the hex of the file and viewing the file as an image. Viewing the image works by putting a display text-property on the image data, with the image-data still present underneath; if the resulting buffer file is saved to another name it will correctly save the image data to the new file.

Todo:

Consolidate with doc-view to make them work on directories of images or on image files containing various "pages".

Defined variables (21)

image--transform-smoothingWhether to use transform smoothing.
image-animate-loopNon-nil means animated images loop forever, rather than playing once.
image-auto-resizeNon-nil to resize the image upon first display.
image-auto-resize-max-scale-percentMax size (in percent) to scale up to when ‘image-auto-resize’ is ‘fit-window’.
image-auto-resize-on-window-resizeNon-nil to resize the image whenever the window’s dimensions change.
image-auto-resize-timerTimer for ‘image-auto-resize-on-window-resize’ option.
image-fit-to-window-lockLock for ‘image-fit-to-window’ timer function.
image-minor-modeNon-nil if Image minor mode is enabled.
image-minor-mode-hookHook run after entering or leaving ‘image-minor-mode’.
image-minor-mode-mapMode keymap for ‘image-minor-mode’.
image-mode-mapMode keymap for ‘image-mode’.
image-mode-menuMenu for Image mode.
image-mode-new-window-functionsSpecial hook run when image data is requested in a new window.
image-mode-winprops-alistAlist of windows to window properties.
image-multi-frameNon-nil if image for the current Image mode buffer has multiple frames.
image-text-based-formatsList of image formats that use a plain text format.
image-transform-resizeThe image resize operation.
image-transform-right-angle-fudgeSnap distance to a multiple of a right angle.
image-transform-rotationRotation angle for the image in the current Image mode buffer.
image-transform-scaleThe scale factor of the image being displayed.
image-typeThe image type for the current Image mode buffer.

Defined functions (71)

image--imagemagick-wanted-p(FILENAME)
image--scale-within-limits-p(IMAGE)
image--set-speed(SPEED &optional MULTIPLY)
image--window-state-change(WINDOW)
image-backward-hscroll(&optional N)
image-bob()
image-bol(ARG)
image-bookmark-jump(BMK)
image-decrease-speed()
image-display-size(SPEC &optional PIXELS FRAME)
image-eob()
image-eol(ARG)
image-fit-to-window(WINDOW)
image-forward-hscroll(&optional N)
image-goto-frame(N &optional RELATIVE)
image-increase-speed()
image-kill-buffer()
image-minor-mode(&optional ARG)
image-mode()
image-mode--directory-buffers(FILE)
image-mode--images-in-directory(FILE)
image-mode--mark-file(FILE FUNCTION MESSAGE)
image-mode--next-file(FILE N)
image-mode-as-hex()
image-mode-as-text()
image-mode-copy-file-name-as-kill()
image-mode-fit-frame(&optional FRAME TOGGLE)
image-mode-isearch-filter(BEG END)
image-mode-mark-file()
image-mode-menu(ARG1)
image-mode-to-text()
image-mode-unmark-file()
image-mode-wallpaper-set()
image-mode-window-get(PROP &optional WINPROPS)
image-mode-window-put(PROP VAL &optional WINPROPS)
image-mode-winprops(&optional WINDOW CLEANUP)
image-next-file(&optional N)
image-next-frame(&optional N)
image-next-line(N)
image-previous-file(&optional N)
image-previous-frame(&optional N)
image-previous-line(&optional N)
image-reset-speed()
image-reverse-speed()
image-scroll-down(&optional N)
image-scroll-left(&optional N)
image-scroll-right(&optional N)
image-scroll-up(&optional N)
image-set-window-hscroll(NCOL)
image-set-window-vscroll(VSCROLL)
image-toggle-animation()
image-toggle-display()
image-toggle-display-image()
image-toggle-display-text()
image-toggle-hex-display()
image-transform-check-size()
image-transform-fit-both()
image-transform-fit-to-height()
image-transform-fit-to-width()
image-transform-fit-to-window()
image-transform-fit-width(WIDTH HEIGHT LENGTH)
image-transform-original()
image-transform-properties(SPEC)
image-transform-reset()
image-transform-reset-to-initial()
image-transform-reset-to-original()
image-transform-set-percent(SCALE)
image-transform-set-rotation(ROTATION)
image-transform-set-scale(SCALE)
image-transform-set-smoothing(SMOOTHING)
image-transform-width(WIDTH HEIGHT)

Defined faces (0)