.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 "MouseX::NativeTraits::Counter 3pm"
.TH MouseX::NativeTraits::Counter 3pm "2022-06-16" "perl v5.34.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"
MouseX::NativeTraits::Counter \- Helper trait for counter attributes
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  package MyHomePage;
\&  use Mouse;
\&
\&  has \*(Aqcounter\*(Aq => (
\&      traits    => [\*(AqCounter\*(Aq],
\&      is        => \*(Aqro\*(Aq,
\&      isa       => \*(AqNum\*(Aq,
\&      default   => 0,
\&      handles   => {
\&          inc_counter   => \*(Aqinc\*(Aq,
\&          dec_counter   => \*(Aqdec\*(Aq,
\&          reset_counter => \*(Aqreset\*(Aq,
\&      },
\&  );
\&
\&  my $page = MyHomePage\->new();
\&  $page\->inc_counter; # same as $page\->counter( $page\->counter + 1 );
\&  $page\->dec_counter; # same as $page\->counter( $page\->counter \- 1 );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides a simple counter attribute, which can be
incremented and decremented.
.PP
If your attribute definition does not include any of \fIis\fR, \fIisa\fR,
\&\fIdefault\fR or \fIhandles\fR but does use the \f(CW\*(C`Counter\*(C'\fR trait,
then this module applies defaults as in the \*(L"\s-1SYNOPSIS\*(R"\s0
above. This allows for a very basic counter definition:
.PP
.Vb 2
\&  has \*(Aqfoo\*(Aq => (traits => [\*(AqCounter\*(Aq]);
\&  $obj\->inc_foo;
.Ve
.SH "PROVIDED METHODS"
.IX Header "PROVIDED METHODS"
These methods are implemented in
MouseX::NativeTraits::MethodProvider::Counter. It is important to
note that all those methods do in place modification of the value stored in
the attribute.
.IP "\fBset($value)\fR" 4
.IX Item "set($value)"
Set the counter to the specified value.
.IP "\fBinc\fR" 4
.IX Item "inc"
Increments the value stored in this slot by 1. Providing an argument will
cause the counter to be increased by specified amount.
.IP "\fBdec\fR" 4
.IX Item "dec"
Decrements the value stored in this slot by 1. Providing an argument will
cause the counter to be increased by specified amount.
.IP "\fBreset\fR" 4
.IX Item "reset"
Resets the value stored in this slot to it's default value.
.SH "METHODS"
.IX Header "METHODS"
.IP "\fBmeta\fR" 4
.IX Item "meta"
.PD 0
.IP "\fBmethod_provider_class\fR" 4
.IX Item "method_provider_class"
.IP "\fBhelper_type\fR" 4
.IX Item "helper_type"
.PD
.SH "SEE ALSO"
.IX Header "SEE ALSO"
MouseX::NativeTraits