.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "HTML::CalendarMonth::Locale 3pm"
.TH HTML::CalendarMonth::Locale 3pm "2018-11-25" "perl v5.28.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
HTML::CalendarMonth::Locale \- Front end class for DateTime::Locale
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use HTML::CalendarMonth::Locale;
\&
\&  my $loc = HTML::CalendarMonth::Locale\->new( code => \*(Aqen\-US\*(Aq );
\&
\&  # list of days of the week for locale
\&  my @days = $loc\->days;
\&
\&  # list of months of the year for locale
\&  my @months = $loc\->months;
\&
\&  # the name of the current locale, as supplied the code parameter to
\&  # new()
\&  my $locale_name = $loc\->code;
\&
\&  # the actual DateTime::Locale object
\&  my $loc = $loc\->loc;
\&
\&  1;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
HTML::CalendarMonth utilizes the powerful locale capabilities of
DateTime::Locale for rendering its calendars. The default locale is
\&'en\-US' but many others are available. To see this list, invoke the
class method HTML::CalendarMonth::Locale\->\fBlocales()\fR which in turn
invokes \fBDateTime::Locale::codes()\fR.
.PP
This module is mostly intended for internal usage within
HTML::CalendarMonth, but some of its functionality may be of use for
developers:
.SH "METHODS"
.IX Header "METHODS"
.IP "\fBnew()\fR" 4
.IX Item "new()"
Constructor. Takes the following parameters:
.RS 4
.IP "code" 4
.IX Item "code"
Locale code, e.g. 'en\-US'.
.IP "full_days" 4
.IX Item "full_days"
Specifies whether full day names or their abbreviations are desired.
Default 0, use abbreviated days.
.IP "full_months" 4
.IX Item "full_months"
Specifies whether full month names or their abbreviations are desired.
Default 1, use full months.
.RE
.RS 4
.RE
.IP "\fBcode()\fR" 4
.IX Item "code()"
Returns the locale code used during object construction.
.IP "\fBlocale()\fR" 4
.IX Item "locale()"
Accessor method for the DateTime::Locale class, which in turn offers
several class methods of specific interest. See DateTime::Locale.
.IP "\fBlocale_map()\fR" 4
.IX Item "locale_map()"
Returns a hash of all available locales, mapping their code to their
full name.
.IP "\fBloc()\fR" 4
.IX Item "loc()"
Accessor method for the DateTime::Locale instance as specified by \f(CW\*(C`code\*(C'\fR.
See DateTime::Locale.
.IP "\fBlocales()\fR" 4
.IX Item "locales()"
Lists all available locale codes. Equivalent to \fBlocale()\fR\->\fBcodes()\fR, or
DateTime::Locale\->\fBcodes()\fR.
.IP "\fBdays()\fR" 4
.IX Item "days()"
Returns a list of days of the week, Sunday first. These are the actual
unique day strings used for rendering calendars, so depending on which
attributes were provided to \f(CW\*(C`new()\*(C'\fR, this list will either be
abbreviations or full names. The default uses abbreviated day names.
Returns a list in list context or an array ref in scalar context.
.IP "\fBnarrow_days()\fR" 4
.IX Item "narrow_days()"
Returns a list of short day abbreviations, beginning with Sunday. The
narrow abbreviations are not guaranteed to be unique (i.e. 'S' for both
Sat and Sun).
.IP "\fBdays_minmatch()\fR" 4
.IX Item "days_minmatch()"
Provides a hash reference containing minimal case-insensitive match
strings for each day of the week, e.g., 'sa' for Saturday, 'm' for
Monday, etc.
.IP "\fBmonths()\fR" 4
.IX Item "months()"
Returns a list of months of the year, beginning with January. Depending
on which attributes were provided to \f(CW\*(C`new()\*(C'\fR, this list will either be
full names or abbreviations. The default uses full names. Returns a list
in list context or an array ref in scalar context.
.IP "\fBnarrow_months()\fR" 4
.IX Item "narrow_months()"
Returns a list of short month abbreviations, beginning with January. The
narrow abbreviations are not guaranteed to be unique.
.IP "\fBmonths_minmatch()\fR" 4
.IX Item "months_minmatch()"
Provides a hash reference containing minimal case-insensitive match
strings for each month of the year, e.g., 'n' for November, 'ja' for
January, 'jul' for July, 'jun' for June, etc.
.IP "\fBdaynums()\fR" 4
.IX Item "daynums()"
Provides a hash reference containing day of week indices for each fully
qualified day name as returned by \fBdays()\fR.
.IP "daynum($day)" 4
.IX Item "daynum($day)"
Provides the day of week index for a particular day name.
.IP "dayname($day)" 4
.IX Item "dayname($day)"
Provides the fully qualified day name for a given string or day index.
.IP "\fBmonthnums()\fR" 4
.IX Item "monthnums()"
Provides a hash reference containing month of year indices for each
fully qualified month name as returned by \fBmonths()\fR.
.IP "monthnum($month)" 4
.IX Item "monthnum($month)"
Provides the month of year index for a particular month name.
.IP "monthname($month)" 4
.IX Item "monthname($month)"
Provides the month name for a given string or month index.
.IP "minmatch_hash(@list)" 4
.IX Item "minmatch_hash(@list)"
This is the method used to generate the case-insensitive minimal match
hash referenced above. Given an arbitrary list, a hash reference will
be returned with minimal match strings as keys and the original strings
as values.
.IP "lc_minmatch_hash(@list)" 4
.IX Item "lc_minmatch_hash(@list)"
Same as minmatch_hash, except keys are forced to lower case.
.IP "\fBfirst_day_of_week()\fR" 4
.IX Item "first_day_of_week()"
Returns a number from 0 to 6 representing the first day of the week for
this locale, where 0 represents Sunday.
.SH "AUTHOR"
.IX Header "AUTHOR"
Matthew P. Sisk, <\fIsisk@mojotoad.com\fR>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2010\-2015 Matthew P. Sisk. All rights reserved. All wrongs
revenged. This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBHTML::CalendarMonth\fR\|(3), \fBDateTime::Locale\fR\|(3)