Function: org-agenda--insert-overriding-header

org-agenda--insert-overriding-header is a macro defined in org-agenda.el.gz.

Signature

(org-agenda--insert-overriding-header DEFAULT)

Documentation

Insert header into agenda view.

The inserted header depends on org-agenda-overriding-header. If the empty string, don't insert a header. If any other string, insert it as a header. If nil, insert DEFAULT, which should evaluate to a string. If a function, call it and insert the string that it returns.

Source Code

;; Defined in /usr/src/emacs/lisp/org/org-agenda.el.gz
(defmacro org-agenda--insert-overriding-header (default)
  "Insert header into agenda view.
The inserted header depends on `org-agenda-overriding-header'.
If the empty string, don't insert a header.  If any other string,
insert it as a header.  If nil, insert DEFAULT, which should
evaluate to a string.  If a function, call it and insert the
string that it returns."
  (declare (debug (form)) (indent defun))
  `(cond
    ((not org-agenda-overriding-header) (insert ,default))
    ((equal org-agenda-overriding-header "") nil)
    ((stringp org-agenda-overriding-header)
     (insert (propertize org-agenda-overriding-header
			 'face 'org-agenda-structure)
	     "\n"))
    ((functionp org-agenda-overriding-header)
     (insert (funcall org-agenda-overriding-header)))
    (t (user-error "Invalid value for `org-agenda-overriding-header': %S"
		   org-agenda-overriding-header))))