• Publicity: Public Only All

ical-procs.tcl

Utility functions for ical data

This file defines the following Objects and Classes: ::xo::ical::VEVENT[i], ::xo::ical::VCALITEM[i], ::xo::ical::VEVENT[i], ::xo::ical::VCALITEM[i], ::xo::ical::VCALITEM[i], ::xo::ical::VCALITEM[i], ::xo::ical::VCALITEM[i], ::xo::ical::VCALITEM[i], ::xo::ical::VCALITEM[i], ::xo::ical::VCALITEM[i], ::xo::ical::VCALITEM[i], ::xo::ical::VCALITEM[i], ::xo::ical::VCALITEM[i], ::xo::ical::VCALITEM[i], ::xo::ical::VCALITEM[i], ::xo::ical::VCALITEM[i], ::xo::ical::VCALITEM[i], ::xo::ical::VCALITEM[i], ::xo::ical::VCALITEM[i], ::xo::ical::VCALITEM[i], ::xo::ical::VCALITEM[i], ::xo::ical::VEVENT[i], ::xo::ical::VEVENT[i]

Location:
packages/xotcl-core/tcl/ical-procs.tcl
Created:
July 20, 2005, modernized in 2019
Author:
neumann@wu-wien.ac.at

Procedures in this file

Detailed information

Class ::xo::ical::VCALITEM (public)

 ::nx::Class ::xo::ical::VCALITEM[i]

VCALITEM is the superclass of a VTODO and a VEVENT, intended as an abstract class.

Testcases:
No testcase defined.

Class ::xo::ical::VEVENT (public)

 ::nx::Class ::xo::ical::VEVENT[i]

VEVENT optional fields, must not occur more than once class / *created / *description / *dtstart / *geo / *last-mod / *location / organizer / *priority / *dtstamp / seq / *status / *summary / transp / *uid / *url / recurid / dtend or duration may appear, but dtend and duration are mutual exclusive *dtend / duration / optional fields, may occur more than once attach / attendee / categories / comment / contact / exdate / exrule / rstatus / related / resources / rdate / rrule / x-prop

Testcases:
No testcase defined.

xo::ical::VCALITEM method as_ical (public)

 <instance of xo::ical::VCALITEM[i]> as_ical

Output a VCALITEM (VTODO or VEVENT) "object" in ical notation.

Testcases:
No testcase defined.

xo::ical::VCALITEM method edit_recurrence (public)

 <instance of xo::ical::VCALITEM[i]> edit_recurrence \
    [ -cal_item_id cal_item_id ] [ -recurrence_id recurrence_id ]

We might or might not have a recurrence on the old entry. In case we have one, the old one might have started earlier, so we try to terminate it.

Switches:
-cal_item_id (optional, integer)
-recurrence_id (optional, integer, accept empty)

Testcases:
No testcase defined.

xo::ical::VCALITEM method start_end (protected)

 <instance of xo::ical::VCALITEM[i]> start_end

Output either a DAY-EVENT (denoted by a single DTSTART with appropriate VALUE format) or a state and end timestamps.

Testcases:
No testcase defined.

xo::ical::VCALITEM method tag (protected)

 <instance of xo::ical::VCALITEM[i]> tag [ -tag tag ] \
    [ -param param ] [ -conv conv ] [ -value value ] slot

Generate a single (line) entry in ical format starting with the specified tag. If no "tag" is specified, the tag name is uppercase of the slot. The value might be specified literally or it can be the name of an instance variable (named by the "slot" attribute". The functions returns empty (produces no output) when either the value is empty or no instance variable exists. Optionally, the value can be converted.

Switches:
-tag (optional)
-param (optional)
-conv (optional)
-value (optional)
Parameters:
slot (required)

Testcases:
No testcase defined.

xo::ical::VCALITEM method parse RRULE (public)

 <instance of xo::ical::VCALITEM[i]> parse RRULE recurrule

parse recurrence rule provided in cal syntax. This method assumes that the instance variable dtstart is already set, before this method is called.

Parameters:
recurrule (required)

Testcases:
No testcase defined.
[ show source ]