.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "HTML::Tidy::Message 3pm"
.TH HTML::Tidy::Message 3pm 2024-01-10 "perl v5.38.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
HTML::Tidy::Message \- Message object for the Tidy functionality
.SH SYNOPSIS
.IX Header "SYNOPSIS"
See HTML::Tidy for all the gory details.
.SH EXPORTS
.IX Header "EXPORTS"
None.  It's all object-based.
.SH METHODS
.IX Header "METHODS"
Almost everything is an accessor.
.ie n .SS "new( $file, $line, $column, $text )"
.el .SS "new( \f(CW$file\fP, \f(CW$line\fP, \f(CW$column\fP, \f(CW$text\fP )"
.IX Subsection "new( $file, $line, $column, $text )"
Create an object.  It's not very exciting.
.SS \fBwhere()\fP
.IX Subsection "where()"
Returns a formatted string that describes where in the file the
error has occurred.
.PP
For example,
.PP
.Vb 1
\&    (14:23)
.Ve
.PP
for line 14, column 23.
.PP
The terrible thing about this function is that it's both a plain
ol' formatting function as in
.PP
.Vb 1
\&    my $str = where( 14, 23 );
.Ve
.PP
AND it's an object method, as in:
.PP
.Vb 1
\&    my $str = $error\->where();
.Ve
.PP
I don't know what I was thinking when I set it up this way, but
it's bad practice.
.SS \fBas_string()\fP
.IX Subsection "as_string()"
Returns a nicely-formatted string for printing out to stdout or some similar user thing.
.SS \fBfile()\fP
.IX Subsection "file()"
Returns the filename of the error, as set by the caller.
.SS \fBtype()\fP
.IX Subsection "type()"
Returns the type of the error.  This will either be \f(CW\*(C`TIDY_ERROR\*(C'\fR,
or \f(CW\*(C`TIDY_WARNING\*(C'\fR.
.SS \fBline()\fP
.IX Subsection "line()"
Returns the line number of the error, or 0 if there isn't an applicable
line number.
.SS \fBcolumn()\fP
.IX Subsection "column()"
Returns the column number, or 0 if there isn't an applicable column
number.
.SS \fBtext()\fP
.IX Subsection "text()"
Returns the text of the message.  This does not include a type string,
like "Info: ".
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2005\-2017 Andy Lester.
.PP
This program is free software; you can redistribute it and/or modify
it under the terms of the Artistic License v2.0.
.SH AUTHOR
.IX Header "AUTHOR"
Andy Lester, \f(CW\*(C`<andy@petdance.com>\*(C'\fR