suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added a pointer to the serialization functions from the preferences marshalling and unmarshalling

Browse Source
This commit is contained in:
Robby Findler 2010-12-10 20:55:40 -06:00
parent 7512986086
commit 4391de9ba6
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
collects/framework/preferences.rkt
View File

@ -29,7 +29,7 @@ the state transitions / contracts are:
(require scribble/srcdoc scheme/class scheme/gui/base (require scribble/srcdoc scheme/class scheme/gui/base
scheme/contract scheme/file) scheme/contract scheme/file)
(require/doc scheme/base scribble/manual) (require/doc scheme/base scribble/manual (for-label racket/serialize))
(provide exn:struct:unknown-preference) (provide exn:struct:unknown-preference)
@ -434,13 +434,13 @@ the state transitions / contracts are:
preferences:set-un/marshall preferences:set-un/marshall
(symbol? (any/c . -> . printable/c) (printable/c . -> . any/c) . -> . void?) (symbol? (any/c . -> . printable/c) (printable/c . -> . any/c) . -> . void?)
(symbol marshall unmarshall) (symbol marshall unmarshall)
@{@scheme[preference:set-un/marshall] is used to specify marshalling and @{@scheme[preferences:set-un/marshall] is used to specify marshalling and
unmarshalling functions for the preference unmarshalling functions for the preference
@scheme[symbol]. @scheme[marshall] will be called when the users saves their @scheme[symbol]. @scheme[marshall] will be called when the users saves their
preferences to turn the preference value for @scheme[symbol] into a preferences to turn the preference value for @scheme[symbol] into a
printable value. @scheme[unmarshall] will be called when the user's printable value. @scheme[unmarshall] will be called when the user's
preferences are read from the file to transform the printable value preferences are read from the file to transform the printable value
into its internal representation. If @scheme[preference:set-un/marshall] into its internal representation. If @scheme[preferences:set-un/marshall]
is never called for a particular preference, the values of that is never called for a particular preference, the values of that
preference are assumed to be printable. preference are assumed to be printable.
@ -454,8 +454,11 @@ the state transitions / contracts are:
happen when the preferences file becomes corrupted, or is edited happen when the preferences file becomes corrupted, or is edited
by hand. by hand.
@scheme[preference:set-un/marshall] must be called before calling @scheme[preferences:set-un/marshall] must be called before calling
@scheme[preferences:get],@scheme[preferences:set].}) @scheme[preferences:get],@scheme[preferences:set].
See also @racket[serialize] and @racket[deserialize].
})
(proc-doc/names (proc-doc/names
preferences:restore-defaults preferences:restore-defaults