local-lib5/man/man3/Moose::Meta::Attribute::Native::Trait::Counter.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "Moose::Meta::Attribute::Native::Trait::Counter 3"
 132 .TH Moose::Meta::Attribute::Native::Trait::Counter 3 "2009-11-19" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Moose::Meta::Attribute::Native::Trait::Counter \- Helper trait for counters
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 2
 138 \&  package MyHomePage;
 139 \&  use Moose;
 140 .Ve
 141 .PP
 142 .Vb 11
 143 \&  has 'counter' => (
 144 \&      traits    => ['Counter'],
 145 \&      is        => 'ro',
 146 \&      isa       => 'Num',
 147 \&      default   => 0,
 148 \&      handles   => {
 149 \&          inc_counter   => 'inc',
 150 \&          dec_counter   => 'dec',
 151 \&          reset_counter => 'reset',
 152 \&      },
 153 \&  );
 154 .Ve
 155 .PP
 156 .Vb 3
 157 \&  my $page = MyHomePage\->new();
 158 \&  $page\->inc_counter; # same as $page\->counter( $page\->counter + 1 );
 159 \&  $page\->dec_counter; # same as $page\->counter( $page\->counter \- 1 );
 160 .Ve
 161 .SH "DESCRIPTION"
 162 .IX Header "DESCRIPTION"
 163 This module provides a simple counter attribute, which can be
 164 incremented and decremented.
 165 .PP
 166 If your attribute definition does not include any of \fIis\fR, \fIisa\fR,
 167 \&\fIdefault\fR or \fIhandles\fR but does use the \f(CW\*(C`Counter\*(C'\fR trait,
 168 then this module applies defaults as in the \*(L"\s-1SYNOPSIS\s0\*(R"
 169 above. This allows for a very basic counter definition:
 170 .PP
 171 .Vb 2
 172 \&  has 'foo' => (traits => ['Counter']);
 173 \&  $obj\->inc_foo;
 174 .Ve
 175 .SH "PROVIDED METHODS"
 176 .IX Header "PROVIDED METHODS"
 177 These methods are implemented in
 178 Moose::Meta::Attribute::Native::MethodProvider::Counter. It is important to
 179 note that all those methods do in place modification of the value stored in
 180 the attribute.
 181 .IP "\fBset($value)\fR" 4
 182 .IX Item "set($value)"
 183 Set the counter to the specified value.
 184 .IP "\fBinc\fR" 4
 185 .IX Item "inc"
 186 Increments the value stored in this slot by 1. Providing an argument will
 187 cause the counter to be increased by specified amount.
 188 .IP "\fBdec\fR" 4
 189 .IX Item "dec"
 190 Decrements the value stored in this slot by 1. Providing an argument will
 191 cause the counter to be increased by specified amount.
 192 .IP "\fBreset\fR" 4
 193 .IX Item "reset"
 194 Resets the value stored in this slot to it's default value.
 195 .SH "METHODS"
 196 .IX Header "METHODS"
 197 .IP "\fBmeta\fR" 4
 198 .IX Item "meta"
 199 .PD 0
 200 .IP "\fBmethod_provider\fR" 4
 201 .IX Item "method_provider"
 202 .IP "\fBhas_method_provider\fR" 4
 203 .IX Item "has_method_provider"
 204 .PD
 205 .SH "BUGS"
 206 .IX Header "BUGS"
 207 All complex software has bugs lurking in it, and this module is no
 208 exception. If you find a bug please either email me, or add the bug
 209 to cpan\-RT.
 210 .SH "AUTHOR"
 211 .IX Header "AUTHOR"
 212 Stevan Little <stevan@iinteractive.com>
 213 .SH "COPYRIGHT AND LICENSE"
 214 .IX Header "COPYRIGHT AND LICENSE"
 215 Copyright 2007\-2009 by Infinity Interactive, Inc.
 216 .PP
 217 <http://www.iinteractive.com>
 218 .PP
 219 This library is free software; you can redistribute it and/or modify
 220 it under the same terms as Perl itself.