%3 ::nx::Object ::nx::Object __default_accessor __default_method_call_protection __object_configureparameter __resolve_method_path contains copy delete object method delete object property delete object variable destroy_on_cleanup info info info lookup parameters info lookup slots info lookup syntax info lookup variables info object method args info object method body info object method callprotection info object method debug info object method definition info object method definitionhandle info object method deprecated info object method exists info object method handle info object method origin info object method parameters info object method registrationhandle info object method returns info object method submethods info object method syntax info object method type info object slots info object variables info variable definition info variable name info variable parameter move object alias object forward object method object property object variable private protected public qn require namespace require object method require private object method require protected object method require public object method serialize ::xo::ical::VCALITEM ::xo::ical::VCALITEM add_recurrence as_ical creation_date description dtstamp dtstart edit_recurrence geo get ical_body is_day_item last-modified last_modified location parse RRULE priority start_end status summary tag uid url ::xo::ical::VCALITEM->::nx::Object ::xo::ical::VEVENT ::xo::ical::VEVENT dtend finish formatted_recurrences sequence transp ::xo::ical::VEVENT->::xo::ical::VCALITEM ::xo::ical::VTODO ::xo::ical::VTODO completed due percent-complete ::xo::ical::VTODO->::xo::ical::VCALITEM

Class ::xo::ical::VCALITEM

::xo::ical::VCALITEM[i] create ... \
           [ -creation_date creation_date ] \
           [ -description description ] \
           [ -dtstamp dtstamp ] \
           [ -dtstart dtstart ] \
           [ -geo geo ] \
           [ -is_day_item (default "false") ] \
           [ -last-modified last-modified ] \
           [ -last_modified last_modified ] \
           [ -location location ] \
           [ -priority priority ] \
           [ -status status ] \
           [ -summary summary ] \
           [ -uid uid ] \
           [ -url url ]

VCALITEM is the superclass of a VTODO and a VEVENT, intended as an abstract class.
Defined in packages/xotcl-core/tcl/ical-procs.tcl

Class Relations

  • class: ::nx::Class[i]
  • superclass: ::nx::Object[i]
  • subclass: ::xo::ical::VEVENT[i], ::xo::ical::VTODO[i]

Methods (to be applied on instances)

  • add_recurrence (scripted, public)

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

    Call calendar::item::add_recurrence with the options calculated by "parse RRULE"

    Switches:
    -cal_item_id
    (optional)

    Partial Call Graph (max 5 caller/called nodes):
    %3 calendar::item::add_recurrence calendar::item::add_recurrence (public) xo::ical::VCALITEM instproc add_recurrence xo::ical::VCALITEM instproc add_recurrence xo::ical::VCALITEM instproc add_recurrence->calendar::item::add_recurrence

    Testcases:
    No testcase defined.
  • as_ical (scripted, public)

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

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

    Partial Call Graph (max 5 caller/called nodes):
    %3

    Testcases:
    No testcase defined.
  • creation_date (forward)

  • description (forward)

  • dtstamp (forward)

  • dtstart (forward)

  • edit_recurrence (scripted, 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)
    -recurrence_id
    (optional)

    Partial Call Graph (max 5 caller/called nodes):
    %3 calendar::item::add_recurrence calendar::item::add_recurrence (public) xo::ical::VCALITEM instproc edit_recurrence xo::ical::VCALITEM instproc edit_recurrence xo::ical::VCALITEM instproc edit_recurrence->calendar::item::add_recurrence

    Testcases:
    No testcase defined.
  • geo (forward)

  • get (scripted, public)

     <instance of xo::ical::VCALITEM[i]> get property [ default ]

    Return a certain property of an ical items. In case, the item has no such property, return the default value.

    Parameters:
    property
    default (optional)

    Partial Call Graph (max 5 caller/called nodes):
    %3

    Testcases:
    No testcase defined.
  • ical_body (scripted, public)

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

    The method ical_body returns the ical-formatted content of the variables. All variables of VEVENTs and VTODOs are listed below, since the names are distinct, and no methods are used. So far there is no handling for the repetition fields (which might occur more than once). An option would be to handle these as lists. All date/time stamps are provided either by the ANSI date (from postgres) or by a date which can be processed via clock scan

    Partial Call Graph (max 5 caller/called nodes):
    %3 xo::db::tcl_date xo::db::tcl_date (public) xo::ical::VCALITEM instproc ical_body xo::ical::VCALITEM instproc ical_body xo::ical::VCALITEM instproc ical_body->xo::db::tcl_date

    Testcases:
    No testcase defined.
  • is_day_item (forward)

  • last-modified (forward)

  • last_modified (forward)

  • location (forward)

  • parse RRULE (scripted, 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

    Partial Call Graph (max 5 caller/called nodes):
    %3

    Testcases:
    No testcase defined.
  • priority (forward)

  • status (forward)

  • summary (forward)

  • uid (forward)

  • url (forward)