diff options
author | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-02-21 19:42:04 +0100 |
---|---|---|
committer | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-02-23 02:53:54 +0100 |
commit | 05e8b129f84a45e7539fafa971d0662445ef3890 (patch) | |
tree | 3b9583c620118eb120d335e60992f5ca0843d84c /doc/ref/guile | |
parent | Change kvlist->assq to return pairs. (diff) | |
download | calp-05e8b129f84a45e7539fafa971d0662445ef3890.tar.gz calp-05e8b129f84a45e7539fafa971d0662445ef3890.tar.xz |
Add (vcomponent create).
Diffstat (limited to '')
-rw-r--r-- | doc/ref/guile/vcomponent.texi | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/ref/guile/vcomponent.texi b/doc/ref/guile/vcomponent.texi index 299ae1da..70af3ad3 100644 --- a/doc/ref/guile/vcomponent.texi +++ b/doc/ref/guile/vcomponent.texi @@ -115,3 +115,42 @@ Does symbol start with ``X-''? @defun internal-field? symb [prefix="-"] @end defun + +@node VComponent Create +@section (vcomponent create) + +Procedures for declarativly creating components (instead of the +primitive procedural API). + +@defun vcomponent type [key: prop] ... children +Creates a new vcomponent of @var{type}. Each kv-pair should contain a +keyword @var{key}, and a value which is either a direct value, or the +return value of @code{with-parameters} or +@code{as-list}. @var{children} should be a list of other vcomponent's. +@end defun + +@defun vcalendar +@defunx vevent +@defunx vtimezone +@defunx standard +@defunx daylight +Calls @code{vcomponent}, with type set to the procedure name (but +up-cased). +@end defun + +@defun with-parameters [key: param] ... value +Allows setting parameters for a property as created by @code{vcomponent}. + +@var{value} follows the same rules as in @code{vcomponent}. Multiple +@var{key}, @var{value} pairs can be given, where each key must be a keyword. +@end defun + +@defun as-list lst +Allows setting list values when using @code{vcomponent}. + +Without this a list value would be stored as a single value, while +with this a list of values is instead stored (as, for example, in EXDATE). + +A list of list types could be hard-coded, but even then this procedure +is needed since custom types might need it. +@end defun |