.\" Automatically generated by Pod::Man 4.09 (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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "MouseX::Types 3pm"
.TH MouseX::Types 3pm "2017-07-31" "perl v5.26.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::Types \- Organize your Mouse types in libraries
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.SS "Library Definition"
.IX Subsection "Library Definition"
.Vb 1
\&  package MyLibrary;
\&
\&  # predeclare our own types
\&  use MouseX::Types 
\&    \-declare => [qw(
\&        PositiveInt NegativeInt
\&    )];
\&
\&  # import builtin types
\&  use MouseX::Types::Mouse \*(AqInt\*(Aq;
\&
\&  # type definition.
\&  subtype PositiveInt, 
\&      as Int, 
\&      where { $_ > 0 },
\&      message { "Int is not larger than 0" };
\&  
\&  subtype NegativeInt,
\&      as Int,
\&      where { $_ < 0 },
\&      message { "Int is not smaller than 0" };
\&
\&  # type coercion
\&  coerce PositiveInt,
\&      from Int,
\&          via { 1 };
\&
\&  1;
.Ve
.SS "Usage"
.IX Subsection "Usage"
.Vb 3
\&  package Foo;
\&  use Mouse;
\&  use MyLibrary qw( PositiveInt NegativeInt );
\&
\&  # use the exported constants as type names
\&  has \*(Aqbar\*(Aq,
\&      isa    => PositiveInt,
\&      is     => \*(Aqrw\*(Aq;
\&  has \*(Aqbaz\*(Aq,
\&      isa    => NegativeInt,
\&      is     => \*(Aqrw\*(Aq;
\&
\&  sub quux {
\&      my ($self, $value);
\&
\&      # test the value
\&      print "positive\en" if is_PositiveInt($value);
\&      print "negative\en" if is_NegativeInt($value);
\&
\&      # coerce the value, NegativeInt doesn\*(Aqt have a coercion
\&      # helper, since it didn\*(Aqt define any coercions.
\&      $value = to_PositiveInt($value) or die "Cannot coerce";
\&  }
\&
\&  1;
.Ve
.SH "AUTHORS"
.IX Header "AUTHORS"
Kazuhiro Osawa <yappo <at> shibuya <döt> pl>
.PP
Shawn M Moore
.PP
tokuhirom
.PP
Goro Fuji
.PP
with plenty of code borrowed from MooseX::Types
.SH "REPOSITORY"
.IX Header "REPOSITORY"
.Vb 1
\&  git clone git://github.com/yappo/p5\-mousex\-types.git MouseX\-Types
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mouse
.PP
MooseX::Types
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (c) 2008\-2010, Kazuhiro Osawa and partly based on MooseX::Types, which
is (c) Robert Sedlacek.
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.