lib/LaTeX/TikZ/Mod/Raw.pm

   1 package LaTeX::TikZ::Mod::Raw;
   2
   3 use strict;
   4 use warnings;
   5
   6 =head1 NAME
   7
   8 LaTeX::TikZ::Mod::Raw - A literal TikZ modifier.
   9
  10 =head1 VERSION
  11
  12 Version 0.03
  13
  14 =cut
  15
  16 our $VERSION = '0.03';
  17
  18 use LaTeX::TikZ::Interface;
  19
  20 use Mouse;
  21
  22 =head1 RELATIONSHIPS
  23
  24 This class consumes the L<LaTeX::TikZ::Mod> role, and as such implements the L</tag>, L</covers>, L</declare> and L</apply> methods.
  25
  26 =cut
  27
  28 with 'LaTeX::TikZ::Mod';
  29
  30 =head1 ATTRIBUTES
  31
  32 =head2 C<content>
  33
  34 The bare string the raw mod is made of.
  35
  36 =cut
  37
  38 has 'content' => (
  39  is       => 'ro',
  40  isa      => 'Str',
  41  required => 1,
  42 );
  43
  44 =head1 METHODS
  45
  46 =head2 C<tag>
  47
  48 =cut
  49
  50 sub tag {
  51  my ($self) = @_;
  52
  53  ref($self) . '/' . $self->content;
  54 }
  55
  56 =head2 C<covers>
  57
  58 =cut
  59
  60 sub covers { 0 }
  61
  62 =head2 C<declare>
  63
  64 =cut
  65
  66 sub declare { }
  67
  68 =head2 C<apply>
  69
  70 =cut
  71
  72 sub apply { $_[0]->content }
  73
  74 LaTeX::TikZ::Interface->register(
  75  raw_mod => sub {
  76   shift;
  77
  78   __PACKAGE__->new(content => $_[0]);
  79  },
  80 );
  81
  82 __PACKAGE__->meta->make_immutable;
  83
  84 =head1 SEE ALSO
  85
  86 L<LaTeX::TikZ>, L<LaTeX::TikZ::Mod>.
  87
  88 =head1 AUTHOR
  89
  90 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
  91
  92 You can contact me by mail or on C<irc.perl.org> (vincent).
  93
  94 =head1 BUGS
  95
  96 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>.
  97 I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
  98
  99 =head1 SUPPORT
 100
 101 You can find documentation for this module with the perldoc command.
 102
 103     perldoc LaTeX::TikZ
 104
 105 =head1 COPYRIGHT & LICENSE
 106
 107 Copyright 2010,2011,2012,2013,2014,2015 Vincent Pit, all rights reserved.
 108
 109 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
 110
 111 =cut
 112
 113 1; # End of LaTeX::TikZ::Mod::Raw