This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
spacemacs/layers/+readers/pdf/funcs.el
madand 278db6a11f [pdf] ~?~ toggles transient sate documentation hint (shown by default)
Backwards compatible by showing the docs by default. Allows to reclaim the
precious display space for viewing the actual PDF.
2020-11-12 22:37:36 +01:00

98 lines
4 KiB
EmacsLisp

;;; funcs.el --- PDF Layer functions File for Spacemacs
;;
;; Copyright (c) 2012-2020 Sylvain Benner & Contributors
;;
;; Author: André Peric Tavares <andre.peric.tavares@gmail.com>
;; URL: https://github.com/syl20bnr/spacemacs
;;
;; This file is not part of GNU Emacs.
;;
;;; License: GPLv3
(defun spacemacs//pdf-tools-setup-transient-state ()
"Setup pdf-tools transient state with toggleable help hint.
Beware: due to transient state's implementation details this
function must be called in the :init section of `use-package' or
full hint text will not show up!"
(defvar spacemacs--pdf-tools-ts-full-hint-toggle t
"Toggle the state of the pdf-tools transient state documentation.")
(defvar spacemacs--pdf-tools-ts-full-hint nil
"Display full pdf transient state documentation.")
(defvar spacemacs--pdf-tools-ts-minified-hint nil
"Display minified pdf transient state documentation.")
(defun spacemacs//pdf-tools-ts-toggle-hint ()
"Toggle the full hint docstring for the pdf-tools transient state."
(interactive)
(setq spacemacs--pdf-tools-ts-full-hint-toggle
(not spacemacs--pdf-tools-ts-full-hint-toggle)))
(defun spacemacs//pdf-tools-ts-hint ()
"Return a condensed/full hint for the pdf-tools transient state"
(concat
" "
(if spacemacs--pdf-tools-ts-full-hint-toggle
spacemacs--pdf-tools-ts-full-hint
(concat "[" (propertize "?" 'face 'hydra-face-red) "] help"))))
(spacemacs|transient-state-format-hint pdf-tools
spacemacs--pdf-tools-ts-full-hint
(format "\n[_?_] toggle help
Navigation^^^^ Scale/Fit^^ Annotations^^ Actions^^ Other^^
----------^^^^--------------- ---------^^------------------ -----------^^------ -------^^---------- -----^^---
[_j_/_k_] scroll down/up [_W_] fit to width [_al_] list [_s_] search [_q_] quit
[_h_/_l_] scroll left/right [_H_] fit to height [_at_] text [_O_] outline
[_d_/_u_] pg down/up [_P_] fit to page [_aD_] delete [_p_] print
[_J_/_K_] next/prev pg [_m_] slice using mouse [_am_] markup [_o_] open link
[_0_/_$_] full scroll l/r [_b_] slice from bounding box ^^ [_r_] revert
[_[_/_]_] history back/for [_R_] reset slice ^^ [_t_] attachments
^^^^ [_zr_] reset zoom ^^ [_n_] night mode"))
(spacemacs|define-transient-state pdf-tools
:title "PDF-tools Transient State"
:hint-is-doc t
:dynamic-hint (spacemacs//pdf-tools-ts-hint)
:on-enter (setq which-key-inhibit t)
:on-exit (setq which-key-inhibit nil)
:evil-leader-for-mode (pdf-view-mode . ".")
:bindings
("?" spacemacs//pdf-tools-ts-toggle-hint)
;; Navigation
("j" pdf-view-next-line-or-next-page)
("k" pdf-view-previous-line-or-previous-page)
("l" image-forward-hscroll)
("h" image-backward-hscroll)
("J" pdf-view-next-page)
("K" pdf-view-previous-page)
("u" pdf-view-scroll-down-or-previous-page)
("d" pdf-view-scroll-up-or-next-page)
("0" image-bol)
("$" image-eol)
("[" pdf-history-backward)
("]" pdf-history-forward)
;; Scale/Fit
("W" pdf-view-fit-width-to-window)
("H" pdf-view-fit-height-to-window)
("P" pdf-view-fit-page-to-window)
("m" pdf-view-set-slice-using-mouse)
("b" pdf-view-set-slice-from-bounding-box)
("R" pdf-view-reset-slice)
("zr" pdf-view-scale-reset)
;; Annotations
("aD" pdf-annot-delete)
("at" pdf-annot-attachment-dired :exit t)
("al" pdf-annot-list-annotations :exit t)
("am" pdf-annot-add-markup-annotation)
;; Actions
("s" pdf-occur :exit t)
("O" pdf-outline :exit t)
("p" pdf-misc-print-document :exit t)
("o" pdf-links-action-perform :exit t)
("r" pdf-view-revert-buffer)
("t" pdf-annot-attachment-dired :exit t)
("n" pdf-view-midnight-minor-mode)
;; Other
("q" nil :exit t)))