mirror of
https://git.savannah.gnu.org/git/emacs.git
synced 2024-11-27 07:37:33 +00:00
c3c6c23cc6
(left-truncation-fringe-bitmap, right-truncation-fringe-bitmap) (up-arrow-fringe-bitmap, down-arrow-fringe-bitmap) (continued-line-fringe-bitmap, continuation-line-fringe-bitmap) (overlay-arrow-fringe-bitmap, top-left-angle-fringe-bitmap) (top-right-angle-fringe-bitmap, bottom-left-angle-fringe-bitmap) (bottom-right-angle-fringe-bitmap, left-bracket-fringe-bitmap) (right-bracket-fringe-bitmap, filled-box-cursor-fringe-bitmap) (hollow-box-cursor-fringe-bitmap, hollow-square-fringe-bitmap) (bar-cursor-fringe-bitmap, hbar-cursor-fringe-bitmap) (empty-line-fringe-bitmap): Define standard fringe bitmaps id's.
225 lines
8.2 KiB
EmacsLisp
225 lines
8.2 KiB
EmacsLisp
;;; fringe.el --- change fringes appearance in various ways
|
|
|
|
;; Copyright (C) 2002, 2003 Free Software Foundation, Inc.
|
|
|
|
;; Author: Simon Josefsson <simon@josefsson.org>
|
|
;; Maintainer: FSF
|
|
;; Keywords: frames
|
|
|
|
;; This file is part of GNU Emacs.
|
|
|
|
;; GNU Emacs is free software; you can redistribute it and/or modify
|
|
;; it under the terms of the GNU General Public License as published by
|
|
;; the Free Software Foundation; either version 2, or (at your option)
|
|
;; any later version.
|
|
|
|
;; GNU Emacs is distributed in the hope that it will be useful,
|
|
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
;; GNU General Public License for more details.
|
|
|
|
;; You should have received a copy of the GNU General Public License
|
|
;; along with GNU Emacs; see the file COPYING. If not, write to the
|
|
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
;; Boston, MA 02111-1307, USA.
|
|
|
|
;;; Commentary:
|
|
|
|
;; This file contains helpful functions for customizing the appearance
|
|
;; of the fringe.
|
|
|
|
;; The code is influenced by scroll-bar.el and avoid.el. The author
|
|
;; gratefully acknowledge comments and suggestions made by Miles
|
|
;; Bader, Eli Zaretski, Richard Stallman, Pavel Janík and others which
|
|
;; improved this package.
|
|
|
|
;;; Code:
|
|
|
|
;; Standard fringe bitmaps
|
|
|
|
(defconst no-fringe-bitmap 0)
|
|
(defconst undef-fringe-bitmap 1)
|
|
(defconst left-truncation-fringe-bitmap 2)
|
|
(defconst right-truncation-fringe-bitmap 3)
|
|
(defconst up-arrow-fringe-bitmap 4)
|
|
(defconst down-arrow-fringe-bitmap 5)
|
|
(defconst continued-line-fringe-bitmap 6)
|
|
(defconst continuation-line-fringe-bitmap 7)
|
|
(defconst overlay-arrow-fringe-bitmap 8)
|
|
(defconst top-left-angle-fringe-bitmap 9)
|
|
(defconst top-right-angle-fringe-bitmap 10)
|
|
(defconst bottom-left-angle-fringe-bitmap 11)
|
|
(defconst bottom-right-angle-fringe-bitmap 12)
|
|
(defconst left-bracket-fringe-bitmap 13)
|
|
(defconst right-bracket-fringe-bitmap 14)
|
|
(defconst filled-box-cursor-fringe-bitmap 15)
|
|
(defconst hollow-box-cursor-fringe-bitmap 16)
|
|
(defconst hollow-square-fringe-bitmap 17)
|
|
(defconst bar-cursor-fringe-bitmap 18)
|
|
(defconst hbar-cursor-fringe-bitmap 19)
|
|
(defconst empty-line-fringe-bitmap 20)
|
|
|
|
|
|
;; Control presence of fringes
|
|
|
|
(defvar fringe-mode)
|
|
|
|
(defun set-fringe-mode-1 (ignore value)
|
|
"Call `set-fringe-mode' with VALUE.
|
|
See `fringe-mode' for valid values and their effect.
|
|
This is usually invoked when setting `fringe-mode' via customize."
|
|
(set-fringe-mode value))
|
|
|
|
(defun set-fringe-mode (value)
|
|
"Set `fringe-mode' to VALUE and put the new value into effect.
|
|
See `fringe-mode' for possible values and their effect."
|
|
(setq fringe-mode value)
|
|
|
|
;; Apply it to default-frame-alist.
|
|
(let ((parameter (assq 'left-fringe default-frame-alist)))
|
|
(if (consp parameter)
|
|
(setcdr parameter (if (consp fringe-mode)
|
|
(car fringe-mode)
|
|
fringe-mode))
|
|
(setq default-frame-alist
|
|
(cons (cons 'left-fringe (if (consp fringe-mode)
|
|
(car fringe-mode)
|
|
fringe-mode))
|
|
default-frame-alist))))
|
|
(let ((parameter (assq 'right-fringe default-frame-alist)))
|
|
(if (consp parameter)
|
|
(setcdr parameter (if (consp fringe-mode)
|
|
(cdr fringe-mode)
|
|
fringe-mode))
|
|
(setq default-frame-alist
|
|
(cons (cons 'right-fringe (if (consp fringe-mode)
|
|
(cdr fringe-mode)
|
|
fringe-mode))
|
|
default-frame-alist))))
|
|
|
|
;; Apply it to existing frames.
|
|
(let ((frames (frame-list)))
|
|
(while frames
|
|
(modify-frame-parameters
|
|
(car frames)
|
|
(list (cons 'left-fringe (if (consp fringe-mode)
|
|
(car fringe-mode)
|
|
fringe-mode))
|
|
(cons 'right-fringe (if (consp fringe-mode)
|
|
(cdr fringe-mode)
|
|
fringe-mode))))
|
|
(setq frames (cdr frames)))))
|
|
|
|
;;;###autoload
|
|
(defcustom fringe-mode nil
|
|
"*Specify appearance of fringes on all frames.
|
|
This variable can be nil (the default) meaning the fringes should have
|
|
the default width (8 pixels), it can be an integer value specifying
|
|
the width of both left and right fringe (where 0 means no fringe), or
|
|
a cons cell where car indicates width of left fringe and cdr indicates
|
|
width of right fringe (where again 0 can be used to indicate no
|
|
fringe).
|
|
To set this variable in a Lisp program, use `set-fringe-mode' to make
|
|
it take real effect.
|
|
Setting the variable with a customization buffer also takes effect.
|
|
If you only want to modify the appearance of the fringe in one frame,
|
|
you can use the interactive function `toggle-fringe'"
|
|
:type '(choice (const :tag "Default width" nil)
|
|
(const :tag "No fringes" 0)
|
|
(const :tag "Only right" (0 . nil))
|
|
(const :tag "Only left" (nil . 0))
|
|
(const :tag "Half width" (5 . 5))
|
|
(const :tag "Minimal" (1 . 1))
|
|
(integer :tag "Specific width")
|
|
(cons :tag "Different left/right sizes"
|
|
(integer :tag "Left width")
|
|
(integer :tag "Right width")))
|
|
:group 'frames
|
|
:require 'fringe
|
|
:set 'set-fringe-mode-1)
|
|
|
|
(defun fringe-query-style (&optional all-frames)
|
|
"Query user for fringe style.
|
|
Returns values suitable for left-fringe and right-fringe frame parameters.
|
|
If ALL-FRAMES, the negation of the fringe values in
|
|
`default-frame-alist' is used when user enters the empty string.
|
|
Otherwise the negation of the fringe value in the currently selected
|
|
frame parameter is used."
|
|
(let ((mode (intern (completing-read
|
|
"Select fringe mode for all frames (type ? for list): "
|
|
'(("none") ("default") ("left-only")
|
|
("right-only") ("half") ("minimal"))
|
|
nil t))))
|
|
(cond ((eq mode 'none) 0)
|
|
((eq mode 'default) nil)
|
|
((eq mode 'left-only) '(nil . 0))
|
|
((eq mode 'right-only) '(0 . nil))
|
|
((eq mode 'half) '(5 . 5))
|
|
((eq mode 'minimal) '(1 . 1))
|
|
((eq mode (intern ""))
|
|
(if (eq 0 (cdr (assq 'left-fringe
|
|
(if all-frames
|
|
default-frame-alist
|
|
(frame-parameters (selected-frame))))))
|
|
nil
|
|
0)))))
|
|
|
|
;;;###autoload
|
|
(defun fringe-mode (&optional mode)
|
|
"Set the default appearance of fringes on all frames.
|
|
|
|
When called interactively, query the user for MODE. Valid values
|
|
for MODE include `none', `default', `left-only', `right-only',
|
|
`minimal' and `half'.
|
|
|
|
When used in a Lisp program, MODE can be a cons cell where the
|
|
integer in car specifies the left fringe width and the integer in
|
|
cdr specifies the right fringe width. MODE can also be a single
|
|
integer that specifies both the left and the right fringe width.
|
|
If a fringe width specification is nil, that means to use the
|
|
default width (8 pixels). This command may round up the left and
|
|
right width specifications to ensure that their sum is a multiple
|
|
of the character width of a frame. It never rounds up a fringe
|
|
width of 0.
|
|
|
|
Fringe widths set by `set-window-fringes' override the default
|
|
fringe widths set by this command. This command applies to all
|
|
frames that exist and frames to be created in the future. If you
|
|
want to set the default appearance of fringes on the selected
|
|
frame only, see the command `set-fringe-style'."
|
|
(interactive (list (fringe-query-style 'all-frames)))
|
|
(set-fringe-mode mode))
|
|
|
|
;;;###autoload
|
|
(defun set-fringe-style (&optional mode)
|
|
"Set the default appearance of fringes on the selected frame.
|
|
|
|
When called interactively, query the user for MODE. Valid values
|
|
for MODE include `none', `default', `left-only', `right-only',
|
|
`minimal' and `half'.
|
|
|
|
When used in a Lisp program, MODE can be a cons cell where the
|
|
integer in car specifies the left fringe width and the integer in
|
|
cdr specifies the right fringe width. MODE can also be a single
|
|
integer that specifies both the left and the right fringe width.
|
|
If a fringe width specification is nil, that means to use the
|
|
default width (8 pixels). This command may round up the left and
|
|
right width specifications to ensure that their sum is a multiple
|
|
of the character width of a frame. It never rounds up a fringe
|
|
width of 0.
|
|
|
|
Fringe widths set by `set-window-fringes' override the default
|
|
fringe widths set by this command. If you want to set the
|
|
default appearance of fringes on all frames, see the command
|
|
`fringe-mode'."
|
|
(interactive (list (fringe-query-style)))
|
|
(modify-frame-parameters
|
|
(selected-frame)
|
|
(list (cons 'left-fringe (if (consp mode) (car mode) mode))
|
|
(cons 'right-fringe (if (consp mode) (cdr mode) mode)))))
|
|
|
|
(provide 'fringe)
|
|
|
|
;;; arch-tag: 6611ef60-0869-47ed-8b93-587ee7d3ff5d
|
|
;;; fringe.el ends here
|