annotate lisp/scrollbar.el @ 396:6719134a07c2 r21-2-13

Import from CVS: tag r21-2-13
author cvs
date Mon, 13 Aug 2007 11:12:05 +0200
parents 70ad99077275
children 74fd4e045ea6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
209
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
1 ;;; scrollbar.el --- Scrollbar support for XEmacs
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
2
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
3 ;; Copyright (C) 1995, 1997 Free Software Foundation, Inc.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
4
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
5 ;; Maintainer: XEmacs Development Team
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
6 ;; Keywords: internal, extensions, dumped
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
7
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
8 ;; This file is part of XEmacs.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
9
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
10 ;; XEmacs is free software; you can redistribute it and/or modify it
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
11 ;; under the terms of the GNU General Public License as published by
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
12 ;; the Free Software Foundation; either version 2, or (at your option)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
13 ;; any later version.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
14
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
15 ;; XEmacs is distributed in the hope that it will be useful, but
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
16 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
18 ;; General Public License for more details.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
19
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
20 ;; You should have received a copy of the GNU General Public License
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
21 ;; along with XEmacs; see the file COPYING. If not, write to the
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
22 ;; Free Software Foundation, 59 Temple Place - Suite 330,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
23 ;; Boston, MA 02111-1307, USA.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
24
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
25 ;;; Synched up with: Not in FSF. (Completely divergent from FSF scroll-bar.el)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
26
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
27 ;;; Commentary:
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
28
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
29 ;; This file is dumped with XEmacs (when scrollbar support is compiled in).
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
30
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
31 ;;; Code:
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
32
298
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 282
diff changeset
33 ;; added for the options menu - dverna
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 282
diff changeset
34 (defcustom scrollbars-visible-p t
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 282
diff changeset
35 "Whether the scrollbars are globally visible.
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 282
diff changeset
36 This variable can be customized through the options menu."
278
90d73dddcdc4 Import from CVS: tag r21-0b37
cvs
parents: 276
diff changeset
37 :type 'boolean
298
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 282
diff changeset
38 :set (lambda (var val)
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 282
diff changeset
39 (set-specifier vertical-scrollbar-visible-p val)
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 282
diff changeset
40 (set-specifier horizontal-scrollbar-visible-p val)
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 282
diff changeset
41 (setq-default scrollbars-visible-p val))
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 282
diff changeset
42 :group 'display)
278
90d73dddcdc4 Import from CVS: tag r21-0b37
cvs
parents: 276
diff changeset
43
209
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
44 (defun init-scrollbar-from-resources (locale)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
45 (when (and (featurep 'x)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
46 (or (eq locale 'global)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
47 (eq 'x (device-or-frame-type locale))))
276
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 209
diff changeset
48 (x-init-scrollbar-from-resources locale))
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 209
diff changeset
49 (when (and (featurep 'mswindows)
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 209
diff changeset
50 (or (eq locale 'global)
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 209
diff changeset
51 (eq 'mswindows (device-or-frame-type locale))))
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 209
diff changeset
52 (mswindows-init-scrollbar-metrics locale)))
209
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
53
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
54 ;;
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
55 ;; vertical scrollbar functions
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
56 ;;
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
57
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
58 ;;; ### Move functions from C into Lisp here!
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
59
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
60 ;;
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
61 ;; horizontal scrollbar functions
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
62 ;;
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
63
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
64 (defun scrollbar-char-left (window)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
65 "Function called when the char-left arrow on the scrollbar is clicked.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
66 This is the little arrow to the left of the scrollbar. One argument is
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
67 passed, the scrollbar's window. You can advise this function to
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
68 change the scrollbar behavior."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
69 (when (window-live-p window)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
70 (scrollbar-set-hscroll window (- (window-hscroll window) 1))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
71 (setq zmacs-region-stays t)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
72 nil))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
73
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
74 (defun scrollbar-char-right (window)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
75 "Function called when the char-right arrow on the scrollbar is clicked.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
76 This is the little arrow to the right of the scrollbar. One argument is
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
77 passed, the scrollbar's window. You can advise this function to
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
78 change the scrollbar behavior."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
79 (when (window-live-p window)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
80 (scrollbar-set-hscroll window (+ (window-hscroll window) 1))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
81 (setq zmacs-region-stays t)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
82 nil))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
83
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
84 (defun scrollbar-page-left (window)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
85 "Function called when the user gives the \"page-left\" scrollbar action.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
86 \(The way this is done can vary from scrollbar to scrollbar.\) One argument is
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
87 passed, the scrollbar's window. You can advise this function to
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
88 change the scrollbar behavior."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
89 (when (window-live-p window)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
90 (scrollbar-set-hscroll window (- (window-hscroll window)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
91 (- (window-width window) 2)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
92 (setq zmacs-region-stays t)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
93 nil))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
94
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
95 (defun scrollbar-page-right (window)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
96 "Function called when the user gives the \"page-right\" scrollbar action.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
97 \(The way this is done can vary from scrollbar to scrollbar.\) One argument is
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
98 passed, the scrollbar's window. You can advise this function to
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
99 change the scrollbar behavior."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
100 (when (window-live-p window)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
101 (scrollbar-set-hscroll window (+ (window-hscroll window)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
102 (- (window-width window) 2)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
103 (setq zmacs-region-stays t)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
104 nil))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
105
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
106 (defun scrollbar-to-left (window)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
107 "Function called when the user gives the \"to-left\" scrollbar action.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
108 \(The way this is done can vary from scrollbar to scrollbar.\). One argument is
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
109 passed, the scrollbar's window. You can advise this function to
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
110 change the scrollbar behavior."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
111 (when (window-live-p window)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
112 (scrollbar-set-hscroll window 0)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
113 (setq zmacs-region-stays t)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
114 nil))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
115
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
116 (defun scrollbar-to-right (window)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
117 "Function called when the user gives the \"to-right\" scrollbar action.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
118 \(The way this is done can vary from scrollbar to scrollbar.\). One argument is
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
119 passed, the scrollbar's window. You can advise this function to
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
120 change the scrollbar behavior."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
121 (when (window-live-p window)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
122 (scrollbar-set-hscroll window 'max)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
123 (setq zmacs-region-stays t)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
124 nil))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
125
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
126 (defun scrollbar-horizontal-drag (data)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
127 "Function called when the user drags the horizontal scrollbar thumb.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
128 One argument is passed, a cons containing the scrollbar's window and a value
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
129 representing how many columns the thumb is slid over. You can advise
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
130 this function to change the scrollbar behavior."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
131 (let ((window (car data))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
132 (value (cdr data)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
133 (when (and (window-live-p window) (integerp value))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
134 (scrollbar-set-hscroll window value)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
135 (setq zmacs-region-stays t)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
136 nil)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
137
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
138 ;;; scrollbar.el ends here