.\" 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 "XML::Mini::Node 3pm"
.TH XML::Mini::Node 3pm "2022-10-15" "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"
XML::Mini::Node \- XML node for XML::Midi parser/generator
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Nodes are used as atomic containers for numerical and text data
and act as leaves in the \s-1XML\s0 tree.
.PP
They have no name or children.
.PP
They always exist as children of XML::MiniElements.
For example,
this text is bold
Would be represented as a XML::MiniElement named 'B' with a single
child, a Node object which contains the string 'this text
is bold'.
.PP
a Node has
.PP
.Vb 2
\& \- a parent
\& \- data (text OR numeric)
.Ve
.SS "getValue"
.IX Subsection "getValue"
Returns the text or numeric value of this Node.
.SS "text [\s-1SETTO\s0 [\s-1SETTOALT\s0]]"
.IX Subsection "text [SETTO [SETTOALT]]"
The \fBtext()\fR method is used to get or set text data for this node.
If \s-1SETTO\s0 is passed, the node's content is set to the \s-1SETTO\s0 string.
.PP
If the optional \s-1SETTOALT\s0 is passed and \s-1SETTO\s0 is false, the
node's value is set to \s-1SETTOALT.\s0
.PP
Returns this node's text, if set or \s-1NULL\s0
.SS "numeric [\s-1SETTO\s0 [\s-1SETTOALT\s0]]"
.IX Subsection "numeric [SETTO [SETTOALT]]"
The \fBnumeric()\fR method is used to get or set numerical data for this node.
.PP
If \s-1SETTO\s0 is passed, the node's content is set to the \s-1SETTO\s0 string.
.PP
If the optional \s-1SETTOALT\s0 is passed and \s-1SETTO\s0 is \s-1NULL,\s0 the
node's value is set to \s-1SETTOALT.\s0
.PP
Returns this node's text, if set or \s-1NULL\s0
.SS "toString [\s-1DEPTH\s0]"
.IX Subsection "toString [DEPTH]"
Returns this node's contents as a string.
If the special \s-1DEPTH\s0 \f(CW$XML::Mini::NoWhiteSpaces\fR is passed,
no whitespaces will be inserted.
.SH "AUTHOR"
.IX Header "AUTHOR"
Copyright (C) 2002\-2008 Patrick Deegan, Psychogenic Inc.
.PP
Programs that use this code are bound to the terms and conditions of the \s-1GNU GPL\s0 (see the \s-1LICENSE\s0 file).
If you wish to include these modules in non-GPL code, you need prior written authorisation
from the authors.
.PP
This library is released under the terms of the \s-1GNU GPL\s0 version 3, making it available only for
free programs (\*(L"free\*(R" here being used in the sense of the \s-1GPL,\s0 see http://www.gnu.org for more details).
Anyone wishing to use this library within a proprietary or otherwise non-GPLed program \s-1MUST\s0 contact psychogenic.com to
acquire a distinct license for their application. This approach encourages the use of free software
while allowing for proprietary solutions that support further development.
.SS "\s-1LICENSE\s0"
.IX Subsection "LICENSE"
.Vb 3
\& XML::Mini::Node module, part of the XML::Mini XML parser/generator package.
\& Copyright (C) 2002\-2008 Patrick Deegan
\& All rights reserved
\&
\& XML::Mini is free software: you can redistribute it and/or modify
\& it under the terms of the GNU General Public License as published by
\& the Free Software Foundation, either version 3 of the License, or
\& (at your option) any later version.
\&
\& XML::Mini is distributed in the hope that it will be useful,
\& but WITHOUT ANY WARRANTY; without even the implied warranty of
\& MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
\& GNU General Public License for more details.
\&
\& You should have received a copy of the GNU General Public License
\& along with XML::Mini. If not, see .
.Ve
.PP
Official XML::Mini site: http://minixml.psychogenic.com
.PP
Contact page for author available on http://www.psychogenic.com/