Function: org-agenda-skip

org-agenda-skip is a byte-compiled function defined in org-agenda.el.gz.

Signature

(org-agenda-skip &optional ELEMENT)

Documentation

Throw to :skip in places that should be skipped.

Also moves point to the end of the skipped region, so that search can continue from there.

Optional argument ELEMENT contains element at point.

Source Code

;; Defined in /usr/src/emacs/lisp/org/org-agenda.el.gz
(defun org-agenda-skip (&optional element)
  "Throw to `:skip' in places that should be skipped.
Also moves point to the end of the skipped region, so that search can
continue from there.

Optional argument ELEMENT contains element at point."
  (save-match-data
    (when (or
           (if element
               (org-element-type-p element 'comment)
	     (save-excursion
               (goto-char (line-beginning-position))
               (looking-at comment-start-skip)))
	   (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
                (or (and (save-match-data (org-in-archived-heading-p nil element))
                         (org-end-of-subtree t element))
		    (and (member org-archive-tag org-file-tags)
                         (goto-char (point-max)))))
	   (and org-agenda-skip-comment-trees
                (org-in-commented-heading-p nil element)
                (org-end-of-subtree t element))
           (let ((to (or (org-agenda-skip-eval org-agenda-skip-function-global)
                         (org-agenda-skip-eval org-agenda-skip-function))))
             (and to (goto-char to)))
	   (org-in-src-block-p t element))
      (throw :skip t))))