This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Upgrade to Locale::Codes 2.00.
[perl5.git] / lib / Locale / Constants.pm
1 package Locale::Constants;
2 #
3 # Locale::Constants - defined constants for identifying codesets
4 #
5 # $Id: Constants.pm,v 2.0 2002/02/05 22:37:58 neilb Exp $
6 #
7
8 use strict;
9
10 require Exporter;
11
12 use vars qw($VERSION @ISA @EXPORT);
13 $VERSION   = sprintf("%d.%02d", q$Revision: 2.0 $ =~ /(\d+)\.(\d+)/);
14 @ISA    = qw(Exporter);
15 @EXPORT = qw(LOCALE_CODE_ALPHA_2 LOCALE_CODE_ALPHA_3 LOCALE_CODE_NUMERIC
16                 LOCALE_CODE_DEFAULT);
17
18 use constant LOCALE_CODE_ALPHA_2 => 1;
19 use constant LOCALE_CODE_ALPHA_3 => 2;
20 use constant LOCALE_CODE_NUMERIC => 3;
21
22 use constant LOCALE_CODE_DEFAULT => LOCALE_CODE_ALPHA_2;
23
24 1;
25
26 __END__
27
28 =head1 NAME
29
30 Locale::Constants - constants for Locale codes
31
32 =head1 SYNOPSIS
33
34     use Locale::Constants;
35     
36     $codeset = LOCALE_CODE_ALPHA_2;
37
38 =head1 DESCRIPTION
39
40 B<Locale::Constants> defines symbols which are used in
41 the four modules from the Locale-Codes distribution:
42
43         Locale::Language
44         Locale::Country
45         Locale::Currency
46         Locale::Script
47
48 B<Note:> at the moment only Locale::Country and Locale::Script
49 support 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::Script
79
80 Codes for identification of scripts.
81
82 =item Locale::Currency
83
84 Codes for identification of currencies and funds.
85
86 =back
87
88 =head1 AUTHOR
89
90 Neil Bowers E<lt>neil@bowers.comE<gt>
91
92 =head1 COPYRIGHT
93
94 Copyright (C) 2002, Neil Bowers.
95
96 Copyright (C) 2001, Canon Research Centre Europe (CRE).
97
98 This module is free software; you can redistribute it and/or
99 modify it under the same terms as Perl itself.
100
101 =cut
102