Andrew Arensburger > p5-Palm-1.3.0 > Palm::ToDo

Download:
p5-Palm-1.3.0.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 1.12   Source  

NAME ^

Palm::ToDo - Handler for Palm ToDo databases.

SYNOPSIS ^

    use Palm::ToDo;

DESCRIPTION ^

The ToDo PDB 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 PDB, initialized with the various Palm::ToDo fields and an empty record list.

Use this method if you're creating a ToDo PDB 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.

AUTHOR ^

Andrew Arensburger <arensb@ooblick.com>

SEE ALSO ^

Palm::PDB(3)

Palm::StdAppInfo(3)

syntax highlighting: