NAME

Toader::Render - This renders supported Toader objects.

VERSION

Version 0.1.0

SYNOPSIS

    use Toader::Render;

    my $foo = Toader::Render->new(\%args);

METHODS

new

This initiates the object.

On argument is required and it is a Toader object.

    my $foo->new($toader);
    if($foo->error){
        warn('error: '.$foo->error.":".$foo->errorString);
    }

isAsupportedObj

This checks if a object is supported.

A return of true means it is supported, otherwise it is false.

This does not mean that the object is usable. For that use the method isAusableObj.

    my $supported=$self->isAsupportedObj($someObject);
    if(!$supported){
        warn('The object is not supported.')
    }

isAusableObj

This checks if a object is supported and usable.

A return of true means it is supported, otherwise it is false.

    my $supported=$self->isAsupportedObj($someObject);
    if(!$supported){
        warn('The object is not supported.')
    }

renderObj

This renders a object.

        $foo->renderObj($obj);

ERROR CODES

2, noDirSet

The object does not have a directory associated with it.

4, notAtoaderObj

The object passed as a Toader object is not a Toader object.

6, outputDirDoesNotExist

The specified outputdir does not exist or is not a directory.

8, rendererInitErrored

Unable to initialize the render for the object.

9, renderErrored

Rendering failed at rendering the object.

11, rendererInitReturnedUndef

Attempting to initialize the renderer returned undefined.

AUTHOR

Zane C. Bowers-Hadley, "<vvelox at vvelox.net>"

BUGS

Please report any bugs or feature requests to "bug-toader at rt.cpan.org", or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Toader>. 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 Toader::Render

You can also look for information at:

RT: CPAN's request tracker
<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Toader>
AnnoCPAN: Annotated CPAN documentation
<http://annocpan.org/dist/Toader>
CPAN Ratings
<http://cpanratings.perl.org/d/Toader>
Search CPAN
<http://search.cpan.org/dist/Toader/>

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

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.