/usr/lib/perl5/Glib/Flags.pod is in libglib-perl 3:1.260-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 | =head1 NAME
Glib::Flags - Overloaded operators representing GLib flags
=cut
=head1 HIERARCHY
Glib::Flags
=cut
=for object Glib::Flags Overloaded operators representing GLib flags
=for position DESCRIPTION
=head1 DESCRIPTION
Glib maps flag and enum values to the nicknames strings provided by the
underlying C libraries. Representing flags this way in Perl is an interesting
problem, which Glib solves by using some cool overloaded operators.
The functions described here actually do the work of those overloaded
operators. See the description of the flags operators in the "This Is
Now That" section of L<Glib> for more info.
=cut
=head1 METHODS
=head2 scalar = $class-E<gt>B<new> ($a)
=over
=item * $a (scalar)
=back
Create a new flags object with given bits. This is for use from a
subclass, it's not possible to create a C<Glib::Flags> object as such.
For example,
my $f1 = Glib::ParamFlags->new ('readable');
my $f2 = Glib::ParamFlags->new (['readable','writable']);
An object like this can then be used with the overloaded operators.
=head2 scalar = $a-E<gt>B<all> ($b, $swap)
=over
=item * $b (scalar)
=item * $swap (scalar)
=back
=head2 aref = $f->B<as_arrayref>
=over
=back
Return the bits of $f as a reference to an array of strings, like
['flagbit1','flagbit2']. This is the overload function for C<@{}>,
ie. arrayizing $f. You can call it directly as a method too.
Note that @$f gives the bits as a list, but as_arrayref gives an arrayref.
If an arrayref is what you want then the method style
somefunc()->as_arrayref can be more readable than [@{somefunc()}].
=head2 bool = $f->B<bool>
=over
=back
Return 1 if any bits are set in $f, or 0 if none are set. This is the
overload for $f in boolean context (like C<if>, etc). You can call it
as a method to get a true/false directly too.
=head2 integer = $a-E<gt>B<eq> ($b, $swap)
=over
=item * $b (scalar)
=item * $swap (integer)
=back
=head2 integer = $a-E<gt>B<ge> ($b, $swap)
=over
=item * $b (scalar)
=item * $swap (integer)
=back
=head2 scalar = $a-E<gt>B<intersect> ($b, $swap)
=over
=item * $b (scalar)
=item * $swap (scalar)
=back
=head2 integer = $a-E<gt>B<ne> ($b, $swap)
=over
=item * $b (scalar)
=item * $swap (integer)
=back
=head2 scalar = $a-E<gt>B<sub> ($b, $swap)
=over
=item * $b (scalar)
=item * $swap (scalar)
=back
=head2 scalar = $a-E<gt>B<union> ($b, $swap)
=over
=item * $b (scalar)
=item * $swap (scalar)
=back
=head2 scalar = $a-E<gt>B<xor> ($b, $swap)
=over
=item * $b (scalar)
=item * $swap (scalar)
=back
=cut
=head1 SEE ALSO
L<Glib>
=cut
=head1 COPYRIGHT
Copyright (C) 2003-2011 by the gtk2-perl team.
This software is licensed under the LGPL. See L<Glib> for a full notice.
=cut
|