lib/LaTeX/TikZ/Set/Container.pm

   1 package LaTeX::TikZ::Set::Container;
   2
   3 use strict;
   4 use warnings;
   5
   6 =head1 NAME
   7
   8 LaTeX::TikZ::Set::Container - A role for set objects that are made of subobjects.
   9
  10 =head1 VERSION
  11
  12 Version 0.02
  13
  14 =head1 DESCRIPTION
  15
  16 L<LaTeX::TikZ::Set> objects that group other objects together consume this role.
  17 This forces them to implement :
  18
  19 =over 4
  20
  21 =item *
  22
  23 a C<kids> method that returns the list of subobjects ;
  24
  25 =item *
  26
  27 an C<add> method describing how more elements can be added to the set.
  28
  29 =back
  30
  31 =cut
  32
  33 our $VERSION = '0.02';
  34
  35 use Mouse::Role;
  36
  37 =head1 METHODS
  38
  39 This method is required by the interface :
  40
  41 =over 4
  42
  43 =item *
  44
  45 C<add>
  46
  47 =back
  48
  49 =cut
  50
  51 requires qw<
  52  add
  53  kids
  54 >;
  55
  56 =head1 SEE ALSO
  57
  58 L<LaTeX::TikZ>, L<LaTeX::TikZ::Set>.
  59
  60 =head1 AUTHOR
  61
  62 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
  63
  64 You can contact me by mail or on C<irc.perl.org> (vincent).
  65
  66 =head1 BUGS
  67
  68 Please report any bugs or feature requests to C<bug-latex-tikz at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=LaTeX-TikZ>.
  69 I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
  70
  71 =head1 SUPPORT
  72
  73 You can find documentation for this module with the perldoc command.
  74
  75     perldoc LaTeX::TikZ
  76
  77 =head1 COPYRIGHT & LICENSE
  78
  79 Copyright 2010,2011,2012,2013,2014,2015 Vincent Pit, all rights reserved.
  80
  81 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
  82
  83 =cut
  84
  85 1; # End of LaTeX::TikZ::Set::Container