Skip to content

Commit

Permalink
Merge: Image scaling improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
@alphapapa
alphapapa committed Mar 4, 2024
2 parents e25cab9 + f37423f commit 325be47
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 19 deletions.
8 changes: 8 additions & 0 deletions README.org
View file
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,11 @@ Ement.el doesn't support encrypted rooms natively, but it can be used transparen
- Option ~ement-room-self-insert-chars~ determines which typed characters will start a new message when ~ement-room-self-insert-mode~ is enabled (regardless of whether they are bound to ~self-insert-command~).
- Option ~ement-room-mode-map-prefix-key~ defines a prefix key for accessing the full ~ement-room-mode-map~ when ~ement-room-self-insert-mode~ is enabled. (By default this key is ~DEL~.)

+ Option ~ement-room-image-margin~ is the number of pixels of margin around image thumbnails.
+ Option ~ement-room-image-relief~ is the number of pixels of shadow rectangle around image thumbnails.
+ Option ~ement-room-image-thumbnail-height~ is the window body height multiple to use when toggling full-sized images to thumbnails (by default, 0.2).
+ Option ~ement-room-image-thumbnail-height-min~ is the minimum pixel height for thumbnail images (by default, 30 pixels).

*Changes*
+ Improve prompt used when viewing a room that is not joined. ([[https://github.com/alphapapa/ement.el/issues/241][#241]]. Thanks to [[https://github.com/phil-s][Phil Sainty]].)
+ Format "was kicked and rejoined" membership event pairs.
Expand All @@ -339,6 +344,9 @@ Ement.el doesn't support encrypted rooms natively, but it can be used transparen
+ Edits to previous edit events are correctly sent to the server as edits to the original message event. ([[https://github.com/alphapapa/ement.el/issues/230][#230]]. Thanks to [[https://github.com/phil-s][Phil Sainty]].)
+ Completion at point works more reliably in compose buffers. (Thanks to [[https://github.com/phil-s][Phil Sainty]].)

*Fixes*
+ Toggling images to fill the window body no longer triggers unintended scrolling. (Thanks to [[https://github.com/phil-s][Phil Sainty].)

** 0.14

*Additions*
Expand Down
78 changes: 59 additions & 19 deletions ement-room.el
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4907,12 +4907,33 @@ STRUCT should be an `ement-room-membership-events' struct."
(when (and value (display-images-p))
(display-warning 'ement "This Emacs was not built with ImageMagick support, nor does it support Cairo/XRender scaling, so images can't be displayed in Ement")))))

(defcustom ement-room-image-initial-height 0.2
(defcustom ement-room-image-thumbnail-height 0.2
"Scale thumbnail images to this multiple of the window body height.
Should be a number between 0 and 1.
See also `ement-room-image-thumbnail-height-min'."
:type '(number :tag "Multiple of the window body height"))

(defcustom ement-room-image-thumbnail-height-min 30
"Minimum height in pixels when scaling thumbnail images.
See also `ement-room-image-thumbnail-height'."
:type 'natnum)

(defcustom ement-room-image-initial-height ement-room-image-thumbnail-height
"Limit images' initial display height.
If a number, it should be no larger than 1 (because Emacs can't
display images larger than the window body height)."
:type '(choice (const :tag "Use full window width" nil)
(number :tag "Limit to this multiple of the window body height")))
:type '(choice (const :tag "Use full window height (or width)" nil)
(number :tag "Multiple of the window body height")))

(defcustom ement-room-image-margin 5
"How many pixels to add as an extra margin around the image."
:type 'natnum)

(defcustom ement-room-image-relief 2
"Width in pixels of shadow rectangle around the image.
If negative, shadows are drawn so that the image appears as a
pressed button; otherwise, it appears as an unpressed button."
:type 'integer)

(defun ement-room-image-scale-mouse (event)
"Toggle scale of image at mouse EVENT.
Expand All @@ -4927,26 +4948,44 @@ height."

(defun ement-room-image-scale (pos)
"Toggle scale of image at POS.
Scale image to fit within the window's body. If image is already
fit to the window, reduce its max-height to 10% of the window's
height."
Scale image to fit the window body. If the image already fits
the window body, reduce its max-height in accordance with user
options `ement-room-image-thumbnail-height' and
`ement-room-image-thumbnail-height-min'."
(interactive "d")
(pcase-let* ((image (get-text-property pos 'display))
(max-height (image-property image :max-height))
(xy (posn-x-y (posn-at-point pos)))
(window-width (window-body-width nil t))
(max-width (- window-width (car xy)))
(window-height (window-body-height nil t))
;; Image scaling commands set :max-height and friends to nil so use the
;; impossible dummy value -1. See <https://github.com/alphapapa/ement.el/issues/39>.
(new-height (if (= window-height (or (image-property image :max-height) -1))
(/ window-height 10)
window-height)))
(use-window-body-size (not (and (numberp max-height)
(= window-height max-height))))
;; Image scaling commands set :max-height and friends to nil.
;; See <https://github.com/alphapapa/ement.el/issues/39>.
(new-height (if use-window-body-size
window-height
(max ement-room-image-thumbnail-height-min
;; Emacs doesn't like floats as the max-height.
(truncate (* window-height
ement-room-image-thumbnail-height))))))
(when (fboundp 'imagemagick-types)
;; Only do this when ImageMagick is supported.
;; FIXME: When requiring Emacs 27+, remove this (I guess?).
(setf (image-property image :type) 'imagemagick))
;; Set :scale to nil since image scaling commands might have changed it.
(setf (image-property image :scale) nil
(image-property image :max-width) window-width
(image-property image :max-height) new-height)))
(image-property image :max-width) max-width
(image-property image :max-height) new-height)
;; When maximising, eliminate all padding around the image, so that the line
;; height will not exceed the window height. This prevents window scrolling
;; issues. Set the window start to ensure the image is displayed in full.
(if use-window-body-size
(setf (image-property image :relief) nil
(image-property image :margin) nil
(window-start) pos)
(setf (image-property image :relief) ement-room-image-relief
(image-property image :margin) ement-room-image-margin))))

(defun ement-room-image-show-mouse (event)
"Show image at mouse EVENT in a new buffer."
Expand Down Expand Up @@ -5010,10 +5049,11 @@ show it in the buffer."
;; Calculate max image display size.
(cond (ement-room-image-initial-height
;; Use configured value.
(setf max-height (truncate
;; Emacs doesn't like floats as the max-height.
(* (window-body-height buffer-window t)
ement-room-image-initial-height))
(setf max-height (max ement-room-image-thumbnail-height-min
;; Emacs doesn't like floats as the max-height.
(truncate
(* (window-body-height buffer-window t)
ement-room-image-initial-height)))
max-width (window-body-width buffer-window t)))
(buffer-window
;; Buffer displayed: use window size.
Expand All @@ -5029,8 +5069,8 @@ show it in the buffer."
(setf (image-property image :type) 'imagemagick))
(setf (image-property image :max-width) max-width
(image-property image :max-height) max-height
(image-property image :relief) 2
(image-property image :margin) 5
(image-property image :relief) ement-room-image-relief
(image-property image :margin) ement-room-image-margin
(image-property image :pointer) 'hand)
(concat "\n"
(ement-room-wrap-prefix " "
Expand Down

0 comments on commit 325be47

Please sign in to comment.