Variable: org-agenda-cmp-user-defined

org-agenda-cmp-user-defined is a customizable variable defined in org-agenda.el.gz.

Value

nil

Documentation

A function to define the comparison user-defined.

This function must receive two arguments, agenda entry a and b. If a>b, return +1. If a<b, return -1. If they are equal as seen by the user comparison, return nil. When this is defined, you can make user-defined-up and user-defined-down part of an agenda sorting strategy.

Source Code

;; Defined in /usr/src/emacs/lisp/org/org-agenda.el.gz
(defcustom org-agenda-cmp-user-defined nil
  "A function to define the comparison `user-defined'.
This function must receive two arguments, agenda entry a and b.
If a>b, return +1.  If a<b, return -1.  If they are equal as seen by
the user comparison, return nil.
When this is defined, you can make `user-defined-up' and `user-defined-down'
part of an agenda sorting strategy."
  :group 'org-agenda-sorting
  :type 'symbol)