lib/Locale/Constants.pm

   1 package Locale::Constants;
   2 #
   3 # Locale::Constants - defined constants for identifying codesets
   4 #
   5 # $Id: Constants.pm,v 1.1 2001/03/04 17:58:15 neilb Exp $
   6 #
   7
   8 use strict;
   9
  10 require Exporter;
  11
  12 use vars qw($VERSION @ISA @EXPORT);
  13 @ISA    = qw(Exporter);
  14 @EXPORT = qw(LOCALE_CODE_ALPHA_2 LOCALE_CODE_ALPHA_3 LOCALE_CODE_NUMERIC
  15                 LOCALE_CODE_DEFAULT);
  16
  17 use constant LOCALE_CODE_ALPHA_2 => 1;
  18 use constant LOCALE_CODE_ALPHA_3 => 2;
  19 use constant LOCALE_CODE_NUMERIC => 3;
  20
  21 $VERSION = '1.00';
  22
  23 use constant LOCALE_CODE_DEFAULT => LOCALE_CODE_ALPHA_2;
  24
  25 1;
  26
  27 __END__
  28
  29 =head1 NAME
  30
  31 Locale::Constants - constants for Locale codes
  32
  33 =head1 SYNOPSIS
  34
  35     use Locale::Constants;
  36
  37     $codeset = LOCALE_CODE_ALPHA_2;
  38
  39 =head1 DESCRIPTION
  40
  41 B<Locale::Constants> defines symbols which are used in
  42 the three modules from the Locale-Codes distribution:
  43
  44         Locale::Language
  45         Locale::Country
  46         Locale::Currency
  47
  48 B<Note:> at the moment only Locale::Country supports
  49 more than one code set.
  50
  51 The symbols defined are used to specify which codes you
  52 want to be used:
  53
  54         LOCALE_CODE_ALPHA_2
  55         LOCALE_CODE_ALPHA_3
  56         LOCALE_CODE_NUMERIC
  57
  58 You shouldn't have to C<use> this module directly yourself -
  59 it is used by the three Locale modules, which in turn export
  60 the symbols.
  61
  62 =head1 KNOWN BUGS AND LIMITATIONS
  63
  64 None at the moment.
  65
  66 =head1 SEE ALSO
  67
  68 =over 4
  69
  70 =item Locale::Language
  71
  72 Codes for identification of languages.
  73
  74 =item Locale::Country
  75
  76 Codes for identification of countries.
  77
  78 =item Locale::Currency
  79
  80 Codes for identification of currencies and funds.
  81
  82 =back
  83
  84 =head1 AUTHOR
  85
  86 Neil Bowers E<lt>neilb@cre.canon.co.ukE<gt>
  87
  88 =head1 COPYRIGHT
  89
  90 Copyright (C) 2001, Canon Research Centre Europe (CRE).
  91
  92 This module is free software; you can redistribute it and/or
  93 modify it under the same terms as Perl itself.
  94
  95 =cut
  96