Function: org-agenda-maybe-loop

org-agenda-maybe-loop is a macro defined in org-agenda.el.gz.

Signature

(org-agenda-maybe-loop CMD ARG FORCE-ARG DELETE &rest BODY)

Documentation

Maybe loop over agenda entries and perform CMD.

Pass ARG, FORCE-ARG, DELETE and BODY to org-agenda-do-in-region.

Source Code

;; Defined in /usr/src/emacs/lisp/org/org-agenda.el.gz
;; org-agenda-[schedule,deadline,date-prompt,todo,[toggle]archive*,
;; kill,set-property,set-effort] commands may loop over agenda
;; entries.  Commands `org-agenda-set-tags' and `org-agenda-bulk-mark'
;; use their own mechanisms on active regions.
(defmacro org-agenda-maybe-loop (cmd arg force-arg delete &rest body)
  "Maybe loop over agenda entries and perform CMD.
Pass ARG, FORCE-ARG, DELETE and BODY to `org-agenda-do-in-region'."
  (declare (debug t))
  `(if (and (called-interactively-p 'any)
	    org-agenda-loop-over-headlines-in-active-region
	    (org-region-active-p))
       (org-agenda-do-in-region
	(region-beginning) (region-end) ,cmd ,arg ,force-arg ,delete)
     ,@body))