spinner-autoloads.el (2777B)
1 ;;; spinner-autoloads.el --- automatically extracted autoloads (do not edit) -*- lexical-binding: t -*- 2 ;; Generated by the `loaddefs-generate' function. 3 4 ;; This file is part of GNU Emacs. 5 6 ;;; Code: 7 8 (add-to-list 'load-path (or (and load-file-name (file-name-directory load-file-name)) (car load-path))) 9 10 11 12 ;;; Generated autoloads from spinner.el 13 14 (autoload 'spinner-create "spinner" "\ 15 Create a spinner of the given TYPE. 16 The possible TYPEs are described in `spinner--type-to-frames'. 17 18 FPS, if given, is the number of desired frames per second. 19 Default is `spinner-frames-per-second'. 20 21 If BUFFER-LOCAL is non-nil, the spinner will be automatically 22 deactivated if the buffer is killed. If BUFFER-LOCAL is a 23 buffer, use that instead of current buffer. 24 25 When started, in order to function properly, the spinner runs a 26 timer which periodically calls `force-mode-line-update' in the 27 current buffer. If BUFFER-LOCAL was set at creation time, then 28 `force-mode-line-update' is called in that buffer instead. When 29 the spinner is stopped, the timer is deactivated. 30 31 DELAY, if given, is the number of seconds to wait after starting 32 the spinner before actually displaying it. It is safe to cancel 33 the spinner before this time, in which case it won't display at 34 all. 35 36 (fn &optional TYPE BUFFER-LOCAL FPS DELAY)") 37 (autoload 'spinner-start "spinner" "\ 38 Start a mode-line spinner of given TYPE-OR-OBJECT. 39 If TYPE-OR-OBJECT is an object created with `make-spinner', 40 simply activate it. This method is designed for minor modes, so 41 they can use the spinner as part of their lighter by doing: 42 '(:eval (spinner-print THE-SPINNER)) 43 To stop this spinner, call `spinner-stop' on it. 44 45 If TYPE-OR-OBJECT is anything else, a buffer-local spinner is 46 created with this type, and it is displayed in the 47 `mode-line-process' of the buffer it was created it. Both 48 TYPE-OR-OBJECT and FPS are passed to `make-spinner' (which see). 49 To stop this spinner, call `spinner-stop' in the same buffer. 50 51 Either way, the return value is a function which can be called 52 anywhere to stop this spinner. You can also call `spinner-stop' 53 in the same buffer where the spinner was created. 54 55 FPS, if given, is the number of desired frames per second. 56 Default is `spinner-frames-per-second'. 57 58 DELAY, if given, is the number of seconds to wait until actually 59 displaying the spinner. It is safe to cancel the spinner before 60 this time, in which case it won't display at all. 61 62 (fn &optional TYPE-OR-OBJECT FPS DELAY)") 63 (register-definition-prefixes "spinner" '("spinner-")) 64 65 ;;; End of scraped data 66 67 (provide 'spinner-autoloads) 68 69 ;; Local Variables: 70 ;; version-control: never 71 ;; no-byte-compile: t 72 ;; no-update-autoloads: t 73 ;; no-native-compile: t 74 ;; coding: utf-8-emacs-unix 75 ;; End: 76 77 ;;; spinner-autoloads.el ends here