.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 >0, 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
.\" ========================================================================
.\"
.IX Title "Palm::Address 3pm"
.TH Palm::Address 3pm "2022-06-16" "perl v5.34.0" "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"
Palm::Address \- Handler for Palm OS AddressBook databases
.SH "VERSION"
.IX Header "VERSION"
This document describes version 1.400 of
Palm::Address, released March 14, 2015
as part of Palm version 1.400.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Palm::Address;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The Address \s-1PDB\s0 handler is a helper class for the Palm::PDB package.
It parses AddressBook databases.
.SS "AppInfo block"
.IX Subsection "AppInfo block"
The AppInfo block begins with standard category support. See
Palm::StdAppInfo for details.
.PP
Other fields include:
.PP
.Vb 2
\&    $pdb\->{appinfo}{lastUniqueID}
\&    $pdb\->{appinfo}{dirtyFields}
.Ve
.PP
I don't know what these are.
.PP
.Vb 10
\&    $pdb\->{appinfo}{fieldLabels}{name}
\&    $pdb\->{appinfo}{fieldLabels}{firstName}
\&    $pdb\->{appinfo}{fieldLabels}{company}
\&    $pdb\->{appinfo}{fieldLabels}{phone1}
\&    $pdb\->{appinfo}{fieldLabels}{phone2}
\&    $pdb\->{appinfo}{fieldLabels}{phone3}
\&    $pdb\->{appinfo}{fieldLabels}{phone4}
\&    $pdb\->{appinfo}{fieldLabels}{phone5}
\&    $pdb\->{appinfo}{fieldLabels}{phone6}
\&    $pdb\->{appinfo}{fieldLabels}{phone7}
\&    $pdb\->{appinfo}{fieldLabels}{phone8}
\&    $pdb\->{appinfo}{fieldLabels}{address}
\&    $pdb\->{appinfo}{fieldLabels}{city}
\&    $pdb\->{appinfo}{fieldLabels}{state}
\&    $pdb\->{appinfo}{fieldLabels}{zipCode}
\&    $pdb\->{appinfo}{fieldLabels}{country}
\&    $pdb\->{appinfo}{fieldLabels}{title}
\&    $pdb\->{appinfo}{fieldLabels}{custom1}
\&    $pdb\->{appinfo}{fieldLabels}{custom2}
\&    $pdb\->{appinfo}{fieldLabels}{custom3}
\&    $pdb\->{appinfo}{fieldLabels}{custom4}
\&    $pdb\->{appinfo}{fieldLabels}{note}
.Ve
.PP
These are the names of the various fields in the address record.
.PP
.Vb 1
\&    $pdb\->{appinfo}{country}
.Ve
.PP
An integer: the code for the country for which these labels were
designed. The country name is available as
.PP
.Vb 1
\&        $Palm::Address::countries[$pdb\->{appinfo}{country}];
\&
\&    $pdb\->{appinfo}{misc}
.Ve
.PP
An integer. The least-significant bit is a flag that indicates whether
the database should be sorted by company. The other bits are reserved.
.SS "Sort block"
.IX Subsection "Sort block"
.Vb 1
\&    $pdb\->{sort}
.Ve
.PP
This is a scalar, the raw data of the sort block.
.SS "Records"
.IX Subsection "Records"
.Vb 1
\&    $record = $pdb\->{records}[N];
\&
\&    $record\->{fields}{name}
\&    $record\->{fields}{firstName}
\&    $record\->{fields}{company}
\&    $record\->{fields}{phone1}
\&    $record\->{fields}{phone2}
\&    $record\->{fields}{phone3}
\&    $record\->{fields}{phone4}
\&    $record\->{fields}{phone5}
\&    $record\->{fields}{address}
\&    $record\->{fields}{city}
\&    $record\->{fields}{state}
\&    $record\->{fields}{zipCode}
\&    $record\->{fields}{country}
\&    $record\->{fields}{title}
\&    $record\->{fields}{custom1}
\&    $record\->{fields}{custom2}
\&    $record\->{fields}{custom3}
\&    $record\->{fields}{custom4}
\&    $record\->{fields}{note}
.Ve
.PP
These are scalars, the values of the various address book fields.
.PP
.Vb 5
\&    $record\->{phoneLabel}{phone1}
\&    $record\->{phoneLabel}{phone2}
\&    $record\->{phoneLabel}{phone3}
\&    $record\->{phoneLabel}{phone4}
\&    $record\->{phoneLabel}{phone5}
.Ve
.PP
Most fields in an AddressBook record are straightforward: the \*(L"name\*(R"
field always gives the person's last name.
.PP
The "phone\fIN\fR\*(L" fields, on the other hand, can mean different things
in different records. There are five such fields in each record, each
of which can take on one of eight different values: \*(R"Work\*(L", \*(R"Home\*(L",
\&\*(R"Fax\*(L", \*(R"Other\*(L", \*(R"E\-mail\*(L", \*(R"Main\*(L", \*(R"Pager\*(L" and \*(R"Mobile".
.PP
The \f(CW$record\fR\->{phoneLabel}{phone*} fields are integers. Each one is
an index into \f(CW@Palm::Address::phoneLabels\fR, and indicates which
particular type of phone number each of the \f(CW$record\fR\->{phone*} fields
represents.
.PP
.Vb 1
\&    $record\->{phoneLabel}{display}
.Ve
.PP
Like the phone* fields above, this is an index into
\&\f(CW@Palm::Address::phoneLabels\fR. It indicates which of the phone*
fields to display in the list view.
.PP
.Vb 1
\&    $record\->{phoneLabel}{reserved}
.Ve
.PP
I don't know what this is.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
.Vb 1
\&  $pdb = new Palm::Address;
.Ve
.PP
Create a new \s-1PDB,\s0 initialized with the various Palm::Address fields
and an empty record list.
.PP
Use this method if you're creating an Address \s-1PDB\s0 from scratch.
.SS "new_Record"
.IX Subsection "new_Record"
.Vb 1
\&  $record = $pdb\->new_Record;
.Ve
.PP
Creates a new Address record, with blank values for all of the fields.
The AppInfo block will contain only an \*(L"Unfiled\*(R" category, with \s-1ID 0.\s0
.PP
\&\f(CW\*(C`new_Record\*(C'\fR does \fBnot\fR add the new record to \f(CW$pdb\fR. For that,
you want \f(CW\*(C`$pdb\->append_Record\*(C'\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Palm::PDB
.PP
Palm::StdAppInfo
.SH "CONFIGURATION AND ENVIRONMENT"
.IX Header "CONFIGURATION AND ENVIRONMENT"
Palm::Address requires no configuration files or environment variables.
.SH "INCOMPATIBILITIES"
.IX Header "INCOMPATIBILITIES"
None reported.
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
The \f(CW\*(C`new()\*(C'\fR method initializes the AppInfo block with English labels and
\&\*(L"United States\*(R" as the country.
.SH "AUTHORS"
.IX Header "AUTHORS"
Andrew Arensburger \f(CW\*(C`<arensb AT ooblick.com>\*(C'\fR
.PP
Currently maintained by Christopher J. Madsen \f(CW\*(C`<perl AT cjmweb.net>\*(C'\fR
.PP
Please report any bugs or feature requests
to \f(CW\*(C`<bug\-Palm AT rt.cpan.org>\*(C'\fR
or through the web interface at
<http://rt.cpan.org/Public/Bug/Report.html?Queue=Palm>.
.PP
You can follow or contribute to p5\-Palm's development at
<https://github.com/madsen/p5\-Palm>.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2003 by Andrew Arensburger & Alessandro Zummo.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
.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 LICENSE, 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