NAME

Data::Grid::Container - Generic superclass for Data::Grid containers

VERSION

Version 0.01_01

SYNOPSIS

package Data::Grid::Foo;

use base 'Data::Grid::Container';

# Now code some specific stuff...

DESCRIPTION

The data grid in Data::Grid is modeled as an ordered tree of tables, rows and cells, all contained inside a bundle. This module encapsulates the common behaviour of these components.

METHODS

new $parent, $position [, $proxy ]

This basic constructor takes three arguments: the parent object, a numeric position amongst its siblings, beginning with 0, and an optional proxy object to manipulate directly, if it is necessary or advantageous to do so.

parent

Retrieve the parent object.

position

Retrieve the absolute position of the object, as it was passed in from the constructor.

proxy

Retrieve the proxy object (for internal manipulation).

as_string

This is a stub to hook up a serialization method to the string overload. Fill it in at your leisure, otherwise it is a no-op.

AUTHOR

Dorian Taylor, <dorian at cpan.org>

BUGS

Please report any bugs or feature requests to bug-data-grid at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Data-Grid. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Data::Grid::Container

You can also look for information at:

SEE ALSO

Data::Grid, Data::Grid::Table, Data::Grid::Row, Data::Grid::Cell

LICENSE AND COPYRIGHT

Copyright 2010 Dorian Taylor.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.