Variable: completion-extra-properties

completion-extra-properties is a variable defined in minibuffer.el.gz.

Value

nil

Documentation

Property list of extra properties of the current completion job.

These include:

:category: the kind of objects returned by all-completions.
   Used by completion-category-overrides.

:annotation-function: Function to annotate the completions buffer.
   The function must accept one argument, a completion string,
   and return either nil or a string which is to be displayed
   next to the completion (but which is not part of the
   completion). The function can access the completion data via
   minibuffer-completion-table and related variables.

:affixation-function: Function to prepend/append a prefix/suffix to
   completions. The function must accept one argument, a list of
   completions, and return a list of annotated completions. The
   elements of the list must be three-element lists: completion, its
   prefix and suffix. This function takes priority over
   :annotation-function when both are provided, so only this
   function is used.

:group-function: Function for grouping the completion candidates.

:display-sort-function: Function to sort entries in *Completions*.

:cycle-sort-function: Function to sort entries when cycling.

See more information about these functions above in completion-metadata.

:exit-function: Function to run after completion is performed.

   The function must accept two arguments, STRING and STATUS.
   STRING is the text to which the field was completed, and
   STATUS indicates what kind of operation happened:
     finished - text is now complete
     sole - text cannot be further completed but
                  completion is not finished
     exact - text is a valid completion but may be further
                  completed.

View in manual

Probably introduced at or before Emacs version 24.1.

Source Code

;; Defined in /usr/src/emacs/lisp/minibuffer.el.gz
(defvar completion-extra-properties nil
  "Property list of extra properties of the current completion job.
These include:

`:category': the kind of objects returned by `all-completions'.
   Used by `completion-category-overrides'.

`:annotation-function': Function to annotate the completions buffer.
   The function must accept one argument, a completion string,
   and return either nil or a string which is to be displayed
   next to the completion (but which is not part of the
   completion).  The function can access the completion data via
   `minibuffer-completion-table' and related variables.

`:affixation-function': Function to prepend/append a prefix/suffix to
   completions.  The function must accept one argument, a list of
   completions, and return a list of annotated completions.  The
   elements of the list must be three-element lists: completion, its
   prefix and suffix.  This function takes priority over
   `:annotation-function' when both are provided, so only this
   function is used.

`:group-function': Function for grouping the completion candidates.

`:display-sort-function': Function to sort entries in *Completions*.

`:cycle-sort-function': Function to sort entries when cycling.

See more information about these functions above
in `completion-metadata'.

`:exit-function': Function to run after completion is performed.

   The function must accept two arguments, STRING and STATUS.
   STRING is the text to which the field was completed, and
   STATUS indicates what kind of operation happened:
     `finished' - text is now complete
     `sole'     - text cannot be further completed but
                  completion is not finished
     `exact'    - text is a valid completion but may be further
                  completed.")