Function: allout-widgets-tally-string

allout-widgets-tally-string is a byte-compiled function defined in allout-widgets.el.gz.

Signature

(allout-widgets-tally-string)

Documentation

Return a string with number of tracked widgets, or empty string if not tracking.

The string is formed for appending to the allout-mode(var)/allout-mode(fun) mode-line lighter.

An empty string is also returned if tracking is inhibited or widgets are locally inhibited.

The number varies according to the evanescence of objects on a
 hash table with weak keys, so tracking of widget erasures is often delayed.

Source Code

;; Defined in /usr/src/emacs/lisp/allout-widgets.el.gz
(defvar allout-widgets-mode-inhibit)    ; defined below
;;;_   > allout-widgets-tally-string
(defun allout-widgets-tally-string ()
  "Return a string with number of tracked widgets, or empty string if not tracking.

The string is formed for appending to the `allout-mode' mode-line
lighter.

An empty string is also returned if tracking is inhibited or
widgets are locally inhibited.

The number varies according to the evanescence of objects on a
 hash table with weak keys, so tracking of widget erasures is often delayed."
  (when (and allout-widgets-maintain-tally
             (not allout-widgets-mode-inhibit)
             allout-widgets-tally)
    (format ":%s" (hash-table-count allout-widgets-tally))))