.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" 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" '' '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 turned on, 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. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "XML::Easy::Content 3pm" .TH XML::Easy::Content 3pm "2011-11-16" "perl v5.14.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" XML::Easy::Content \- abstract form of XML content .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use XML::Easy::Content; \& \& $content = XML::Easy::Content\->new([ \& "foo", \& $subelement, \& "bar", \& ]); \& \& $twine = $content\->twine; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" An object of this class represents a chunk of \s-1XML\s0 content, the kind of matter that can be contained within an \s-1XML\s0 element. This is in an abstract form, intended for general manipulation. It is completely isolated from the textual representation of \s-1XML\s0, and holds only the meaningful content of the chunk. The data in a content object cannot be modified: different data requires the creation of a new object. .PP An \s-1XML\s0 content chunk consists of a sequence of zero or more characters and \s-1XML\s0 elements, interspersed in any fashion. Character content can use almost all Unicode characters, with only a few characters (such as most of the \s-1ASCII\s0 control characters) prohibited by the specification from being directly represented in \s-1XML\s0. Each \s-1XML\s0 element in a content chunk itself recursively contains a chunk of content, in addition to having attached metadata. .PP This class is not meant to be subclassed. \s-1XML\s0 content is unextendable, dumb data. Content objects are better processed using the functions in XML::Easy::NodeBasics than using the methods of this class. .SH "CONSTRUCTOR" .IX Header "CONSTRUCTOR" .IP "XML::Easy::Content\->new(\s-1TWINE\s0)" 4 .IX Item "XML::Easy::Content->new(TWINE)" Constructs and returns a new content chunk object with the specified content. \&\fI\s-1TWINE\s0\fR must be a reference to an array listing the chunk's content in twine form (see \*(L"Twine\*(R" in XML::Easy::NodeBasics). The content is checked for validity, against the \s-1XML\s0 1.0 specification, and the function \f(CW\*(C`die\*(C'\fRs if it is invalid. .SH "METHODS" .IX Header "METHODS" .ie n .IP "$content\->twine" 4 .el .IP "\f(CW$content\fR\->twine" 4 .IX Item "$content->twine" Returns a reference to an array listing the chunk's content in twine form (see \*(L"Twine\*(R" in XML::Easy::NodeBasics). .Sp The returned array must not be subsequently modified. If possible, it will be marked as read-only in order to prevent modification. .ie n .IP "$content\->content" 4 .el .IP "\f(CW$content\fR\->content" 4 .IX Item "$content->content" Deprecated alias for the \*(L"twine\*(R" method. .SH "SEE ALSO" .IX Header "SEE ALSO" XML::Easy::Element, XML::Easy::NodeBasics .SH "AUTHOR" .IX Header "AUTHOR" Andrew Main (Zefram) .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (C) 2008, 2009 PhotoBox Ltd .PP Copyright (C) 2009, 2010, 2011 Andrew Main (Zefram) .SH "LICENSE" .IX Header "LICENSE" This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.