1=pod
2
3=head1 NAME
4
5Locale::Currency - module for dealing with currency code sets
6
7=head1 SYNOPSIS
8
9   use Locale::Currency;
10
11   $name = code2currency(CODE);
12   $code = currency2code(NAME);
13
14   @codes   = all_currency_codes();
15   @names   = all_currency_names();
16
17=head1 DESCRIPTION
18
19This module provides access to currency code sets.
20
21Please refer to the L<Locale::Codes::Types> document for a description
22of the code sets available.
23
24Most of the routines take an optional additional argument which
25specifies the code set to use. The code set can be specified using the
26name of a code set, or the perl constant specified in the above
27document.  If not specified, the default code set will be used.
28
29=head1 ROUTINES
30
31All routines in this module call the appropriate method in the
32L<Locale::Codes> module, using an object of type: currency
33Please refer to the documentation of the L<Locale::Codes> module
34for details about each function.
35
36The following functions are exported automatically:
37
38=over 4
39
40=item B<code2currency(CODE [,CODESET] [,'retired'])>
41
42See B<code2name> in L<Locale::Codes>
43
44=item B<currency2code(NAME [,CODESET] [,'retired'])>
45
46See B<name2code> in L<Locale::Codes>
47
48=item B<currency_code2code(CODE ,CODESET ,CODESET2)>
49
50See B<code2code> in L<Locale::Codes>
51
52=item B<all_currency_codes([CODESET] [,'retired'])>
53
54See B<all_codes> in L<Locale::Codes>
55
56=item B<all_currency_names([CODESET] [,'retired'])>
57
58See B<all_names> in L<Locale::Codes>
59
60=back
61
62The following functions are not exported and must be called fully
63qualified with the package name:
64
65=over 4
66
67=item B<Locale::Currency::show_errors(FLAG)>
68
69By default, invalid input will produce empty results, but no errors.  By
70passing in a non-zero value of FLAG, errors will be produced.
71
72See B<show_errors> in L<Locale::Codes> but note that the default for
73the non-OO modules are to NOT produce errors.
74
75=item B<Locale::Currency::rename_currency(CODE ,NEW_NAME [,CODESET])>
76
77See B<rename_code> in L<Locale::Codes>
78
79=item B<Locale::Currency::add_currency(CODE ,NAME [,CODESET])>
80
81See B<add_code> in L<Locale::Codes>
82
83=item B<Locale::Currency::delete_currency(CODE [,CODESET])>
84
85See B<delete_code> in L<Locale::Codes>
86
87=item B<Locale::Currency::add_currency_alias(NAME ,NEW_NAME)>
88
89See B<add_alias> in L<Locale::Codes>
90
91=item B<Locale::Currency::delete_currency_alias(NAME)>
92
93See B<delete_alias> in L<Locale::Codes>
94
95=item B<Locale::Currency::rename_currency_code(CODE ,NEW_CODE [,CODESET])>
96
97See B<replace_code> in L<Locale::Codes>
98
99=item B<Locale::Currency::add_currency_code_alias(CODE ,NEW_CODE [,CODESET])>
100
101See B<add_code_alias> in L<Locale::Codes>
102
103=item B<Locale::Currency::delete_currency_code_alias(CODE [,CODESET])>
104
105See B<delete_code_alias> in L<Locale::Codes>
106
107=back
108
109=head1 SEE ALSO
110
111=over 4
112
113=item L<Locale::Codes>
114
115The Locale-Codes distribution.
116
117=back
118
119=head1 AUTHOR
120
121See Locale::Codes for full author history.
122
123Currently maintained by Sullivan Beck (sbeck@cpan.org).
124
125=head1 COPYRIGHT
126
127   Copyright (c) 2011-2020 Sullivan Beck
128
129This module is free software; you can redistribute it and/or
130modify it under the same terms as Perl itself.
131
132=cut
133