.\" 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::Bool 3pm"
.TH MouseX::NativeTraits::Bool 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::Bool \- Helper trait for Bool attributes
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  package Room;
\&  use Mouse;
\&
\&  has \*(Aqis_lit\*(Aq => (
\&      traits    => [\*(AqBool\*(Aq],
\&      is        => \*(Aqrw\*(Aq,
\&      isa       => \*(AqBool\*(Aq,
\&      default   => 0,
\&      handles   => {
\&          illuminate  => \*(Aqset\*(Aq,
\&          darken      => \*(Aqunset\*(Aq,
\&          flip_switch => \*(Aqtoggle\*(Aq,
\&          is_dark     => \*(Aqnot\*(Aq,
\&      },
\&  );
\&
\&  my $room = Room\->new();
\&  $room\->illuminate;     # same as $room\->is_lit(1);
\&  $room\->darken;         # same as $room\->is_lit(0);
\&  $room\->flip_switch;    # same as $room\->is_lit(not $room\->is_lit);
\&  return $room\->is_dark; # same as !$room\->is_lit
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This provides a simple boolean attribute, which supports most of the
basic math operations.
.SH "PROVIDED METHODS"
.IX Header "PROVIDED METHODS"
These methods are implemented in
MouseX::NativeTraits::MethodProvider::Bool. It is important to
note that all those methods do in place modification of the value stored in
the attribute.
.IP "\fBset\fR" 4
.IX Item "set"
Sets the value to true.
.IP "\fBunset\fR" 4
.IX Item "unset"
Set the value to false.
.IP "\fBtoggle\fR" 4
.IX Item "toggle"
Toggles the value. If it's true, set to false, and vice versa.
.IP "\fBnot\fR" 4
.IX Item "not"
Equivalent of 'not \f(CW$value\fR'.
.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.