.\" 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 "Gtk2::Ex::PodViewer::Parser 3pm"
.TH Gtk2::Ex::PodViewer::Parser 3pm "2018-06-30" "perl v5.26.2" "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"
Gtk2::Ex::PodViewer::Parser \- a custom POD Parser for Gtk2::Ex::PodViewer.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&        $Gtk2::Ex::PodViewer::Parser::LINK_TEXT_TEMPLATE = \*(Aq{section} in the {document} manpage\*(Aq;
\&
\&        my $parser = Gtk2::Ex::PodViewer::Parser\->new(
\&                buffer  => $Gtk2TextView\->get_buffer,
\&        );
\&
\&        $parser\->parse_from_file($file);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Gtk2::Ex::PodViewer::Parser is a custom Pod parser for the Gtk2::Ex::PodViewer widget. You should never need to use it directly.
.PP
It is based on Pod::Parser.
.SH "METHODS"
.IX Header "METHODS"
One neat method not implemented by Pod::Parser is
.PP
.Vb 1
\&        $parser\->parse_from_string($string);
.Ve
.PP
This parses a scalar containing \s-1POD\s0 data, using IO::Scalar to create a tied filehandle.
.SH "IMPORTABLE FUNCTIONS"
.IX Header "IMPORTABLE FUNCTIONS"
.Vb 2
\&        use Gtk2::Ex::PodViewer::Parser qw(decode_entities);
\&        my $text = decode_entities($pod);
.Ve
.PP
This function takes a string of \s-1POD,\s0 and returns it with all the \s-1POD\s0 entities (eg \f(CW\*(C`E<gt>\*(C'\fR => \*(L">\*(R") decoded into readable characters.
.SH "VARIABLES"
.IX Header "VARIABLES"
The \f(CW$LINK_TEXT_TEMPLATE\fR class variable contains a string that is used to generate link text for \s-1POD\s0 links for the form
.PP
.Vb 1
\&        LE<lt>foo/barE<gt>
.Ve
.PP
This string is run through the \f(CW\*(C`gettext()\*(C'\fR function from Locale::gettext (if installed) before it is used, so if your application supports internationalisation, then the string will be translated if it appears in your translation domain. It contains two tokens, \f(CW\*(C`{section}\*(C'\fR and \f(CW\*(C`{document}\*(C'\fR, that are replaced with \f(CW\*(C`foo\*(C'\fR and \f(CW\*(C`bar\*(C'\fR respectively.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\(bu" 4
Gtk2::Ex::PodViewer
.IP "\(bu" 4
Pod::Parser
.IP "\(bu" 4
Locale::gettext
.SH "AUTHORS"
.IX Header "AUTHORS"
Gavin Brown, Torsten Schoenfeld and Scott Arrington.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
(c) 2003\-2005 Gavin Brown (gavin.brown@uk.com). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.