.\" Automatically generated by Pod::Man 2.28 (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::Property 3pm"
.TH Data::ICal::Property 3pm "2015-02-17" "perl v5.20.2" "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::Property \- Represents a property on an entry in an iCalendar file
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A Data::ICal::Property object represents a single property on an
entry in an iCalendar file.  Properties have parameters in addition to
their value.
.PP
You shouldn't need to create Data::ICal::Property values directly
\&\*(-- just use \f(CW\*(C`add_property\*(C'\fR in Data::ICal::Entry.
.PP
The \f(CW\*(C`encoding\*(C'\fR parameter value is only interpreted by Data::ICal
in the \f(CW\*(C`decoded_value\*(C'\fR and \f(CW\*(C`encode\*(C'\fR methods: all other methods
access the encoded version directly (if there is an encoding).
.PP
Currently, the only supported encoding is \f(CW\*(C`QUOTED\-PRINTABLE\*(C'\fR.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "new $key, $value, [$parameter_hash]"
.el .SS "new \f(CW$key\fP, \f(CW$value\fP, [$parameter_hash]"
.IX Subsection "new $key, $value, [$parameter_hash]"
Creates a new Data::ICal::Property with key \f(CW$key\fR and value \f(CW$value\fR.
.PP
If \f(CW$parameter_hash\fR is provided, sets the property's parameters to
it.  The parameter hash should have keys equal to the names of the
parameters (case insensitive; parameter hashes should not contain two
different keys which are the same when converted to upper case); the
values should either be a string if the parameter has a single value
or an array reference of strings if the parameter has multiple values.
.SS "key [$key]"
.IX Subsection "key [$key]"
Gets or sets the key name of this property.
.SS "value [$value]"
.IX Subsection "value [$value]"
Gets or sets the value of this property.
.SS "parameters [$param_hash]"
.IX Subsection "parameters [$param_hash]"
Gets or sets the parameter hash reference of this property.  Parameter
keys are converted to upper case.
.SS "vcal10 [$bool]"
.IX Subsection "vcal10 [$bool]"
Gets or sets a boolean saying whether this should be interpreted as
vCalendar 1.0 (as opposed to iCalendar 2.0).  Generally, you can just
set this on your main Data::ICal object when you construct it;
\&\f(CW\*(C`add_entry\*(C'\fR automatically makes sure that sub-entries end up with the
same value as their parents, and \f(CW\*(C`add_property\*(C'\fR makes sure that
properties end up with the same value as their entry.
.SS "decoded_value"
.IX Subsection "decoded_value"
Gets the value of this property, converted from the encoding specified
in its encoding parameter.  (That is, \f(CW\*(C`value\*(C'\fR will return the encoded
version; this will apply the encoding.)  If the encoding is not
specified or recognized, just returns the raw value.
.ie n .SS "encode $encoding"
.el .SS "encode \f(CW$encoding\fP"
.IX Subsection "encode $encoding"
Calls \f(CW\*(C`decoded_value\*(C'\fR to get the current decoded value, then encodes
it in \f(CW$encoding\fR, sets the value to that, and sets the encoding
parameter to \f(CW$encoding\fR. (\f(CW$encoding\fR is first converted to upper
case.)
.PP
If \f(CW$encoding\fR is undef, deletes the encoding parameter and sets the
value to the decoded value.  Does nothing if the encoding is not
recognized.
.SS "as_string \s-1ARGS\s0"
.IX Subsection "as_string ARGS"
Returns the property formatted as a string (including trailing
newline).
.PP
Takes named arguments:
.IP "fold" 4
.IX Item "fold"
Defaults to true. pass in a false value if you need to generate
non-rfc-compliant calendars.
.IP "crlf" 4
.IX Item "crlf"
Defaults to \f(CW\*(C`\ex0d\ex0a\*(C'\fR, per \s-1RFC 2445\s0 spec.  This option is primarily
for backwards compatibility with version of this module prior to 0.16,
which used \f(CW\*(C`\ex0a\*(C'\fR.
.SH "AUTHOR"
.IX Header "AUTHOR"
Best Practical Solutions, \s-1LLC\s0 <modules@bestpractical.com>
.SH "LICENCE AND COPYRIGHT"
.IX Header "LICENCE AND COPYRIGHT"
Copyright (c) 2005 \- 2015, 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.