Palm::ToDo (3)

Leading comments

Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/Palm::ToDo.3pm".)

NAME

Palm::ToDo - Handler for Palm ToDo databases

VERSION

This document describes version 1.400 of Palm::ToDo, released March 14, 2015 as part of Palm version 1.400.

SYNOPSIS

    use Palm::ToDo;

DESCRIPTION

The ToDo handler is a helper class for the Palm::PDB package. It parses ToDo databases.

AppInfo block

The AppInfo block begins with standard category support. See Palm::StdAppInfo for details.

Other fields include:

    $pdb->{appinfo}{dirty_appinfo}
    $pdb->{appinfo}{sortOrder}

I don't know what these are.

Sort block

    $pdb->{sort}

This is a scalar, the raw data of the sort block.

Records

    $record = $pdb->{records}[N]

    $record->{due_day}
    $record->{due_month}
    $record->{due_year}

The due date of the ToDo item. If the item has no due date, these are undefined.

    $record->{completed}

This is defined and true iff the item has been completed.

    $record->{priority}

An integer. The priority of the item.

    $record->{description}

A text string. The description of the item.

    $record->{note}

A text string. The note attached to the item. Undefined if the item has no note.

new

  $pdb = new Palm::ToDo;

Create a new

initialized with the various Palm::ToDo fields and an empty record list.

Use this method if you're creating a ToDo

from scratch.

new_Record

  $record = $pdb->new_Record;

Creates a new ToDo record, with blank values for all of the fields.

"new_Record" does not add the new record to $pdb. For that, you want "$pdb->append_Record".

SEE ALSO

Palm::PDB

Palm::StdAppInfo

CONFIGURATION AND ENVIRONMENT

Palm::ToDo requires no configuration files or environment variables.

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

AUTHORS

Andrew Arensburger "<arensb AT ooblick.com>"

Currently maintained by Christopher J. Madsen "<perl AT cjmweb.net>"

Please report any bugs or feature requests to "<bug-Palm AT rt.cpan.org>" or through the web interface at <rt.cpan.org/Public/Bug/Report.html?Queue=Palm>.

You can follow or contribute to p5-Palm's development at <github.com/madsen/p5-Palm>.

COPYRIGHT AND LICENSE

This software is copyright (c) 2003 by Andrew Arensburger & Alessandro Zummo.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

DISCLAIMER OF WARRANTY

(),