/ 
LaTeX-TikZ-0.03
River stage one • 1 direct dependent • 1 total dependent
/ LaTeX::TikZ::Mod

NAME

LaTeX::TikZ::Mod - Base role for LaTeX::TikZ modifiers.

VERSION

Version 0.03

DESCRIPTION

This role should be consumed by all the modifier classes.

METHODS

These methods are required by the interface :

  • tag

    Returns an identifier for the mod object. It is used to gather mods together when calling covers on them.

  • covers $mod

    Returns true if and only if the effects of the mod $mod are already ensured by the current mod object, in which case no actual TikZ code will be emitted for $mod. Both mod objects are guaranteed to have the same tag.

  • declare $formatter

    Returns an array reference of TikZ code lines required to declare this mod before using it, formatted by the LaTeX::TikZ::Formatter object $formatter ; or undef if no declarations are needed for this mod.

  • apply $formatter

    Returns the TikZ code that activates the current mod as a string formatted by the LaTeX::TikZ::Formatter object $formatter.

SEE ALSO

LaTeX::TikZ.

AUTHOR

Vincent Pit, <perl at profvince.com>, http://www.profvince.com.

You can contact me by mail or on irc.perl.org (vincent).

BUGS

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

COPYRIGHT & LICENSE

Copyright 2010,2011,2012,2013,2014,2015 Vincent Pit, all rights reserved.

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