Document `org-property-allowed-value-functions'

This commit is contained in:
Carsten Dominik 2010-01-10 10:48:38 +01:00
parent bb488fa3b1
commit c886640728
2 changed files with 11 additions and 2 deletions

View File

@ -12054,6 +12054,15 @@ Treat the value of the property PROPERTY as a whitespace-separated list of
values and check if VALUE is in this list. values and check if VALUE is in this list.
@end defun @end defun
@defopt org-property-allowed-value-functions
Hook for functions supplying allowed values for specific.
The functions must take a single argument, the name of the property, and
return a flat list of allowed values. If @samp{:ETC} is one of
the values, use the values as completion help, but allow also other values
to be entered. The functions must return @code{nil} if they are not
responsible for this property.
@end defopt
@node Using the mapping API, , Using the property API, Hacking @node Using the mapping API, , Using the property API, Hacking
@section Using the mapping API @section Using the mapping API
@cindex API, for mapping @cindex API, for mapping

View File

@ -12976,8 +12976,8 @@ The functions must take a single argument, the name of the property, and
return a flat list of allowed values. If \":ETC\" is one of return a flat list of allowed values. If \":ETC\" is one of
the values, this means that these values are intended as defaults for the values, this means that these values are intended as defaults for
completion, but that other values should be allowed too. completion, but that other values should be allowed too.
The functions must return nil if they are now responsible for this The functions must return nil if they are not responsible for this
prioerty.") property.")
(defun org-property-get-allowed-values (pom property &optional table) (defun org-property-get-allowed-values (pom property &optional table)
"Get allowed values for the property PROPERTY. "Get allowed values for the property PROPERTY.