Dave Rolsky > Text-TOC-0.10 > Text::TOC::Role::Filter

Download:
Text-TOC-0.10.tar.gz

Dependencies

Annotate this POD

CPAN RT

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

NAME ^

Text::TOC::Role::Filter - A role for node filters

VERSION ^

version 0.10

DESCRIPTION ^

This role defines the API for node filters.

REQUIRED METHODS ^

This role requires one method:

$filter->node_is_interesting($node)

This method should take an object which does the Text::TOC::Role::Node role and return true or false. If it returns true, the node will be included in the table of contents.

AUTHOR ^

Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2012 by Dave Rolsky.

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

syntax highlighting: