Zane C. Bowers-Hadley > Toader-0.4.0 > Toader::Render

Download:
Toader-0.4.0.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  3
Open  1
View/Report Bugs
Module Version: 0.0.1   Source   Latest Release: Toader-1.1.2

NAME ^

Toader::Render - This renders supported Toader objects.

VERSION ^

Version 0.0.1

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 ^

1

No object specified.

2

The object does not have a directory associated with it.

3

No Toader object specified.

4

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

5

No outputdir specified.

6

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

7

The specified object is not usable.

8

Unable to initialize the render for the object.

9

Rendering failed at rendering the object.

10

Renderer returned undef.

11

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:

ACKNOWLEDGEMENTS ^

LICENSE AND COPYRIGHT ^

Copyright 2011. Zane C. Bowers-Hadley.

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.

syntax highlighting: