Function: spinner-create

spinner-create is an autoloaded and byte-compiled function defined in spinner.el.

Signature

(spinner-create &optional TYPE BUFFER-LOCAL FPS DELAY)

Documentation

Create a spinner of the given TYPE.

The possible TYPEs are described in spinner--type-to-frames.

FPS, if given, is the number of desired frames per second. Default is spinner-frames-per-second.

If BUFFER-LOCAL is non-nil, the spinner will be automatically deactivated if the buffer is killed. If BUFFER-LOCAL is a buffer, use that instead of current buffer.

When started, in order to function properly, the spinner runs a timer which periodically calls force-mode-line-update in the current buffer. If BUFFER-LOCAL was set at creation time, then force-mode-line-update is called in that buffer instead. When the spinner is stopped, the timer is deactivated.

DELAY, if given, is the number of seconds to wait after starting the spinner before actually displaying it. It is safe to cancel the spinner before this time, in which case it won't display at all.

Source Code

;; Defined in ~/.emacs.d/elpa/spinner-1.7.4/spinner.el
;;;###autoload
(defun spinner-create (&optional type buffer-local fps delay)
  "Create a spinner of the given TYPE.
The possible TYPEs are described in `spinner--type-to-frames'.

FPS, if given, is the number of desired frames per second.
Default is `spinner-frames-per-second'.

If BUFFER-LOCAL is non-nil, the spinner will be automatically
deactivated if the buffer is killed.  If BUFFER-LOCAL is a
buffer, use that instead of current buffer.

When started, in order to function properly, the spinner runs a
timer which periodically calls `force-mode-line-update' in the
current buffer.  If BUFFER-LOCAL was set at creation time, then
`force-mode-line-update' is called in that buffer instead.  When
the spinner is stopped, the timer is deactivated.

DELAY, if given, is the number of seconds to wait after starting
the spinner before actually displaying it. It is safe to cancel
the spinner before this time, in which case it won't display at
all."
  (make-spinner type buffer-local fps delay))