mirror of
https://github.com/Gnucash/gnucash.git
synced 2025-02-25 18:55:30 -06:00
Fix indentation; clarify comment/description of vector of functions.
git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@15876 57a11ea4-9604-0410-9ed3-97b8803252fd
This commit is contained in:
parent
d208d7f5d8
commit
92f3dc0bad
@ -35,33 +35,35 @@
|
|||||||
;; option. The function should restore the option to the original
|
;; option. The function should restore the option to the original
|
||||||
;; value.
|
;; value.
|
||||||
generate-restore-form
|
generate-restore-form
|
||||||
;; the scm->kvp and kvp->scm functions should save and load
|
;; the scm->kvp and kvp->scm functions should save and load
|
||||||
;; the option to a kvp. The arguments to these function will be
|
;; the option to a kvp. The arguments to these function will be
|
||||||
;; a kvp-frame and a base key-path list for this option.
|
;; a kvp-frame and a base key-path list for this option.
|
||||||
scm->kvp
|
scm->kvp
|
||||||
kvp->scm
|
kvp->scm
|
||||||
;; Validation func should accept a value and return (#t value)
|
;; Validation func should accept a value and return (#t value)
|
||||||
;; on success, and (#f "failure-message") on failure. If #t,
|
;; on success, and (#f "failure-message") on failure. If #t,
|
||||||
;; the supplied value will be used by the gui to set the option.
|
;; the supplied value will be used by the gui to set the option.
|
||||||
value-validator
|
value-validator
|
||||||
;;; free-form storage depending on type.
|
;;; free-form storage depending on type.
|
||||||
option-data
|
option-data
|
||||||
;; If this is a "multiple choice" type of option,
|
;; If this is a "multiple choice" type of option,
|
||||||
;; this should be a vector of the following five functions
|
;; this should be a vector of the following five functions:
|
||||||
;; one taking no arguments giving the number of choices
|
;;
|
||||||
;; one taking one argument, a non-negative integer, that
|
;; Function 1: taking no arguments, giving the number of choices
|
||||||
|
;;
|
||||||
|
;; Function 2: taking one argument, a non-negative integer, that
|
||||||
;; returns the scheme value (usually a symbol) matching the
|
;; returns the scheme value (usually a symbol) matching the
|
||||||
;; nth choice
|
;; nth choice
|
||||||
;;
|
;;
|
||||||
;; one taking one argument, a non-negative integer,
|
;; Function 3: taking one argument, a non-negative integer,
|
||||||
;; that returns the string matching the nth choice
|
;; that returns the string matching the nth choice
|
||||||
;;
|
;;
|
||||||
;; the third takes one argument and returns the description
|
;; Function 4: takes one argument and returns the description
|
||||||
;; containing the nth choice
|
;; containing the nth choice
|
||||||
;;
|
;;
|
||||||
;; the fourth giving a possible value and returning the index
|
;; Function 5: giving a possible value and returning the index
|
||||||
;; if an option doesn't use these, this should just be a #f
|
;; if an option doesn't use these, this should just be a #f
|
||||||
option-data-fns
|
option-data-fns
|
||||||
;; This function should return a list of all the strings
|
;; This function should return a list of all the strings
|
||||||
;; in the option other than the section, name, (define
|
;; in the option other than the section, name, (define
|
||||||
;; (list-lookup list item) and documentation-string that
|
;; (list-lookup list item) and documentation-string that
|
||||||
|
Loading…
Reference in New Issue
Block a user