;;; help-at-pt.el --- local help through the keyboard
-;; Copyright (C) 2003 Free Software Foundation, Inc.
+;; Copyright (C) 2003, 2004, 2005 Free Software Foundation, Inc.
;; Author: Luc Teirlinck <teirllm@auburn.edu>
;; Keywords: help
;; 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.
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
;;; Commentary:
;; previous region with available local help and print the help found
;; there.
;;
+;; Suggested key bindings:
+;;
+;; (global-set-key [C-tab] 'scan-buf-next-region)
+;; (global-set-key [C-M-tab] 'scan-buf-previous-region)
+;;
;; You do not have to do anything special to use the functionality
;; provided by this file, because all important functions autoload.
(defgroup help-at-pt nil
"Features for displaying local help."
:group 'help
- :version "21.4")
+ :version "22.1")
;;;###autoload
(defun help-at-pt-string (&optional kbd)
(message "%s" help)
(if (not arg) (message "No local help at point")))))
+(defvar help-at-pt-timer nil
+ "Non-nil means that a timer is set that checks for local help.
+If non-nil, this is the value returned by the call of
+`run-with-idle-timer' that set that timer. This variable is used
+internally to enable `help-at-pt-display-when-idle'. Do not set it
+yourself.")
+
(defcustom help-at-pt-timer-delay 1
"*Delay before displaying local help.
This is used if `help-at-pt-display-when-idle' is enabled.
new value."
:group 'help-at-pt
:type 'number
+ :initialize 'custom-initialize-default
:set (lambda (variable value)
(set-default variable value)
- (when (and (boundp 'help-at-pt-timer) help-at-pt-timer)
- (timer-set-idle-time help-at-pt-timer value t))))
-
-(defvar help-at-pt-timer nil
- "Non-nil means that a timer is set that checks for local help.
-If non-nil, this is the value returned by the call of
-`run-with-idle-timer' that set that timer. This variable is used
-internally to enable `help-at-pt-display-when-idle'. Do not set it
-yourself.")
+ (and (boundp 'help-at-pt-timer)
+ help-at-pt-timer
+ (timer-set-idle-time help-at-pt-timer value t))))
;;;###autoload
(defun help-at-pt-cancel-timer ()
(interactive "p")
(scan-buf-move-to-region 'help-echo (- arg) 'scan-buf-move-hook))
-(defvar help-at-pt-unload-hook '(help-at-pt-cancel-timer)
- "Normal hook run when `help-at-pt' is unloaded.")
-
-;; Suggested key bindings:
-;;
-;; (global-set-key [C-tab] 'scan-buf-next-region)
-;; (global-set-key [C-M-tab] 'scan-buf-previous-region)
+(add-hook 'help-at-pt-unload-hook 'help-at-pt-cancel-timer)
(provide 'help-at-pt)