home *** CD-ROM | disk | FTP | other *** search
/ PC Professionell 2004 December / PCpro_2004_12.ISO / files / webserver / tsw / TSW_3.4.0.exe / Apache2 / perl / Constants.pm < prev    next >
Encoding:
Perl POD Document  |  2004-01-30  |  3.6 KB  |  139 lines
  1. #============================================================= -*-Perl-*-
  2. #
  3. # Template::Plugin::GD::Constants
  4. #
  5. # DESCRIPTION
  6. #
  7. #   Simple Template Toolkit plugin interfacing to the GD constants
  8. #   in the GD.pm module.
  9. #
  10. # AUTHOR
  11. #   Craig Barratt   <craig@arraycomm.com>
  12. #
  13. # COPYRIGHT
  14. #   Copyright (C) 2001 Craig Barratt.  All Rights Reserved.
  15. #
  16. #   This module is free software; you can redistribute it and/or
  17. #   modify it under the same terms as Perl itself.
  18. #
  19. #----------------------------------------------------------------------------
  20. #
  21. # $Id: Constants.pm,v 1.55 2004/01/13 16:20:46 abw Exp $
  22. #
  23. #============================================================================
  24.  
  25. package Template::Plugin::GD::Constants;
  26.  
  27. require 5.004;
  28.  
  29. use strict;
  30. use GD qw(/^gd/ /^GD/);
  31. use Template::Plugin;
  32. use base qw( Template::Plugin );
  33. use vars qw( @ISA $VERSION );
  34.  
  35. $VERSION = sprintf("%d.%02d", q$Revision: 1.55 $ =~ /(\d+)\.(\d+)/);
  36.  
  37. sub new
  38. {
  39.     my $class   = shift;
  40.     my $context = shift;
  41.     my $self    = { };
  42.     bless $self, $class;
  43.  
  44.     #
  45.     # GD has exported various gd* and GD_* contstants.  Find them.
  46.     #
  47.     foreach my $v ( keys(%Template::Plugin::GD::Constants::) ) {
  48.         $self->{$v} = eval($v) if ( $v =~ /^gd/ || $v =~ /^GD_/ );
  49.     }
  50.     return $self;
  51. }
  52.  
  53. 1;
  54.  
  55. __END__
  56.  
  57.  
  58. #------------------------------------------------------------------------
  59. # IMPORTANT NOTE
  60. #   This documentation is generated automatically from source
  61. #   templates.  Any changes you make here may be lost.
  62. # 
  63. #   The 'docsrc' documentation source bundle is available for download
  64. #   from http://www.template-toolkit.org/docs.html and contains all
  65. #   the source templates, XML files, scripts, etc., from which the
  66. #   documentation for the Template Toolkit is built.
  67. #------------------------------------------------------------------------
  68.  
  69. =head1 NAME
  70.  
  71. Template::Plugin::GD::Constants - Interface to GD module constants
  72.  
  73. =head1 SYNOPSIS
  74.  
  75.     [% USE gdc = GD.Constants %]
  76.  
  77.     # --> the constants gdc.gdBrushed, gdc.gdSmallFont, gdc.GD_CMP_IMAGE
  78.     #     are now available
  79.  
  80. =head1 EXAMPLES
  81.  
  82.     [% FILTER null;
  83.         USE gdc = GD.Constants;
  84.         USE im  = GD.Image(200,100);
  85.         black = im.colorAllocate(0  ,0,  0);
  86.         red   = im.colorAllocate(255,0,  0);
  87.         r = im.string(gdc.gdLargeFont, 10, 10, "Large Red Text", red);
  88.         im.png | stdout(1);
  89.        END;
  90.     -%]
  91.  
  92. =head1 DESCRIPTION
  93.  
  94. The GD.Constants plugin provides access to the various GD module's
  95. constants (such as gdBrushed, gdSmallFont, gdTransparent, GD_CMP_IMAGE
  96. etc).  When GD.pm is used in perl it exports various contstants
  97. into the caller's namespace.  This plugin makes those exported
  98. constants available as template variables.
  99.  
  100. See L<Template::Plugin::GD::Image> and L<GD> for further examples and
  101. details.
  102.  
  103. =head1 AUTHOR
  104.  
  105. Craig Barratt E<lt>craig@arraycomm.comE<gt>
  106.  
  107.  
  108. Lincoln D. Stein wrote the GD.pm interface to the GD library.
  109.  
  110.  
  111. =head1 VERSION
  112.  
  113. 1.55, distributed as part of the
  114. Template Toolkit version 2.13, released on 30 January 2004.
  115.  
  116. =head1 COPYRIGHT
  117.  
  118.  
  119. Copyright (C) 2001 Craig Barratt E<lt>craig@arraycomm.comE<gt>
  120.  
  121. The GD.pm interface is copyright 1995-2000, Lincoln D. Stein.
  122.  
  123. This module is free software; you can redistribute it and/or
  124. modify it under the same terms as Perl itself.
  125.  
  126. =head1 SEE ALSO
  127.  
  128. L<Template::Plugin|Template::Plugin>, L<Template::Plugin::GD|Template::Plugin::GD>, L<Template::Plugin::GD::Image|Template::Plugin::GD::Image>, L<Template::Plugin::GD::Polygon|Template::Plugin::GD::Polygon>, L<GD|GD>
  129.  
  130. =cut
  131.  
  132. # Local Variables:
  133. # mode: perl
  134. # perl-indent-level: 4
  135. # indent-tabs-mode: nil
  136. # End:
  137. #
  138. # vim: expandtab shiftwidth=4:
  139.