.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Data::ICal 3pm"
.TH Data::ICal 3pm "2013-07-03" "perl v5.18.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Data::ICal \- Generates iCalendar (RFC 2445) calendar files
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Data::ICal;
\&
\&    my $calendar = Data::ICal\->new();
\&
\&    my $vtodo = Data::ICal::Entry::Todo\->new();
\&    $vtodo\->add_properties(
\&        # ... see Data::ICal::Entry::Todo documentation
\&    );
\&
\&    # ... or
\&    $calendar = Data::ICal\->new(filename => \*(Aqfoo.ics\*(Aq); # parse existing file
\&    $calendar = Data::ICal\->new(data => \*(AqBEGIN:VCALENDAR...\*(Aq); # parse from scalar
\&    $calendar\->add_entry($vtodo);
\&    print $calendar\->as_string;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A Data::ICal object represents a \f(CW\*(C`VCALENDAR\*(C'\fR object as defined in the
iCalendar protocol (\s-1RFC 2445, MIME\s0 type \*(L"text/calendar\*(R"), as implemented in many
popular calendaring programs such as Apple's iCal.
.PP
Each Data::ICal object is a collection of \*(L"entries\*(R", which are objects of a
subclass of Data::ICal::Entry.  The types of entries defined by iCalendar
(which refers to them as \*(L"components\*(R") include events, to-do items, journal
entries, free/busy time indicators, and time zone descriptors; in addition,
events and to-do items can contain alarm entries.  (Currently, Data::ICal
only implements to-do items and events.)
.PP
Data::ICal is a subclass of Data::ICal::Entry; see its manpage for more
methods applicable to Data::ICal.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "new [ data => $data, ] [ filename => $file ], [ vcal10 => $bool ]"
.el .SS "new [ data => \f(CW$data\fP, ] [ filename => \f(CW$file\fP ], [ vcal10 => \f(CW$bool\fP ]"
.IX Subsection "new [ data => $data, ] [ filename => $file ], [ vcal10 => $bool ]"
Creates a new Data::ICal object.
.PP
If it is given a filename or data argument is passed, then this parses the
content of the file or string into the object.  If the \f(CW\*(C`vcal10\*(C'\fR flag is passed,
parses it according to vCalendar 1.0, not iCalendar 2.0; this in particular impacts
the parsing of continuation lines in quoted-printable sections.
.PP
If a filename or data argument is not passed, this just sets its \f(CW\*(C`VERSION\*(C'\fR and
\&\f(CW\*(C`PRODID\*(C'\fR properties to \*(L"2.0\*(R" (or \*(L"1.0\*(R" if the \f(CW\*(C`vcal10\*(C'\fR flag is passed) and
the value of the \f(CW\*(C`product_id\*(C'\fR method respectively.
.PP
Returns a false value upon failure to open or parse the file or data; this false
value is a Class::ReturnValue object and can be queried as to its 
\&\f(CW\*(C`error_message\*(C'\fR.
.ie n .SS "parse [ data => $data, ] [ filename => $file, ]"
.el .SS "parse [ data => \f(CW$data\fP, ] [ filename => \f(CW$file\fP, ]"
.IX Subsection "parse [ data => $data, ] [ filename => $file, ]"
Parse a \f(CW\*(C`.ics\*(C'\fR file or string containing one, and populate \f(CW$self\fR
with its contents.
.PP
Should only be called once on a given object, and will be automatically
called by \f(CW\*(C`new\*(C'\fR if you provide arguments to \f(CW\*(C`new\*(C'\fR.
.PP
Returns \f(CW$self\fR on success.  Returns a false value upon failure to
open or parse the file or data; this false value is a
Class::ReturnValue object and can be queried as to its
\&\f(CW\*(C`error_message\*(C'\fR.
.SS "ical_entry_type"
.IX Subsection "ical_entry_type"
Returns \f(CW\*(C`VCALENDAR\*(C'\fR, its iCalendar entry name.
.SS "product_id"
.IX Subsection "product_id"
Returns the product \s-1ID\s0 used in the calendar's \f(CW\*(C`PRODID\*(C'\fR property; you may
wish to override this in a subclass for your own application.
.SS "mandatory_unique_properties"
.IX Subsection "mandatory_unique_properties"
According to the iCalendar standard, the following properties must be specified
exactly one time for a calendar:
.PP
.Vb 1
\&      prodid version
.Ve
.SS "optional_unique_properties"
.IX Subsection "optional_unique_properties"
According to the iCalendar standard, the following properties may be specified
at most one time for a calendar:
.PP
.Vb 1
\&      calscale method
.Ve
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
Data::ICal requires Class::Accessor, Text::vFile::asData,
MIME::QuotedPrint, and Class::ReturnValue.
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
Data::ICal does not support time zone daylight or standard entries,
so time zone components are basically useless.
.PP
While Data::ICal tries to check which properties are required and
repeatable, this only works in simple cases; it does not check for
properties that must either both exist or both not exist, or for
mutually exclusive properties.
.PP
Data::ICal does not check to see if property parameter names are
known in general or allowed on the particular property.
.PP
Data::ICal does not check to see if nested entries are nested
properly (alarms in todos and events only, everything else in
calendars only).
.PP
The only property encoding supported by Data::ICal is quoted
printable.
.PP
There is no Data::ICal::Entry::Alarm base class.
.PP
Please report any bugs or feature requests to
\&\f(CW\*(C`bug\-data\-ical@rt.cpan.org\*(C'\fR, or through the web interface at
<http://rt.cpan.org>.
.SH "AUTHOR"
.IX Header "AUTHOR"
Jesse Vincent \f(CW\*(C`<jesse@bestpractical.com>\*(C'\fR with David Glasser,
Simon Wistow, and Alex Vandiver
.SH "LICENCE AND COPYRIGHT"
.IX Header "LICENCE AND COPYRIGHT"
Copyright (c) 2005 \- 2009, Best Practical Solutions, \s-1LLC. \s0 All rights reserved.
.PP
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See perlartistic.
.SH "DISCLAIMER OF WARRANTY"
.IX Header "DISCLAIMER OF WARRANTY"
\&\s-1BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE SOFTWARE \*(L"AS IS\*(R" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR, OR CORRECTION.\s0
.PP
\&\s-1IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
THE SOFTWARE \s0(\s-1INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE\s0), \s-1EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.\s0