.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) .\" .\" 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 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. .\" .\" 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 .\" .\" 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::Doctype::ElementDecl 3pm" .TH XML::Doctype::ElementDecl 3pm "2014-09-17" "perl v5.20.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::Doctype::ElementDecl \- A class representing an tag .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 3 \& $elt = $dtd\->element( \*(Aqfoo\*(Aq ) ; \& $elt\->name() ; \& $elt\->attr( \*(Aqfoo\*(Aq ) ; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module is used to represent tags in an XML::Doctype object. It contains tags as well. .SH "STATUS" .IX Header "STATUS" This module is alpha code. It's developed enough to support XML::ValidWriter, but need a lot of work. Some big things that are lacking are: .SH "METHODS" .IX Header "METHODS" .IP "new" 4 .IX Item "new" .Vb 3 \& # Undefined element constructors: \& $dtd = XML::Doctype::ElementDecl\->new( $name ) ; \& $dtd = XML::Doctype::ElementDecl\->new( $name, undef, \e@attdefs ) ; \& \& # Defined element constructors \& $dtd = XML::Doctype::ElementDecl\->new( $name, \e@kids, \e@attdef ) ; \& $dtd = XML::Doctype::ElementDecl\->new( $name, [], \e@attdefs ) ; .Ve .IP "add_attdef" 4 .IX Item "add_attdef" .Vb 1 \& $elt_decl\->add_attdef( $att_def ) ; .Ve .IP "attdef" 4 .IX Item "attdef" .Vb 1 \& $attr = $elt\->attdef( $name ) ; .Ve .Sp Returns the XML::Doctype::AttDef named by \f(CW$name\fR or undef if there is no such attribute. .IP "attdefs" 4 .IX Item "attdefs" .Vb 1 \& $attdefs = $elt\->attdefs( $name ) ; .Ve .Sp Returns the list of XML::Doctype::AttDef instances associated with this element. .IP "attribute_names" 4 .IX Item "attribute_names" Returns a list of the attdefs' names. .IP "child_names" 4 .IX Item "child_names" .Vb 1 \& @names = $elt\->child_names ; .Ve .Sp Returns a list of names of elements in this element decl's content model. .IP "is_declared" 4 .IX Item "is_declared" .Vb 2 \& if ( $elt_decl\->is_declared ) ... \& $elt_decl\->is_declared( 1 ) ; .Ve .Sp Returns \s-1TRUE\s0 if there is any data defined in the element other than name and attributes or if is_declared has been set by calling is_declared( 1 ) or passing \s-1DECLARED\s0 => 1 to \fInew()\fR. .IP "is_empty" 4 .IX Item "is_empty" .PD 0 .IP "is_any" 4 .IX Item "is_any" .IP "is_mixed" 4 .IX Item "is_mixed" .IP "name" 4 .IX Item "name" .PD .Vb 1 \& $n = $elt_decl\->name ; .Ve .Sp Gets the name of the element. .IP "validate_content" 4 .IX Item "validate_content" .Vb 1 \& $v = $elt_decl\->validate_content( \e@seq ) ; .Ve .Sp Takes an \s-1ARRAY\s0 ref of tag names (or '#PCDATA') and checks to see if it would be valid content for elements of this type. .Sp Right now, this must be called only when an element's end tag is emitted. It can be broadened to be incremental if need be. .SH "SUBCLASSING" .IX Header "SUBCLASSING" This object uses the fields pragma, so you should use base and fields for any subclasses. .SH "AUTHOR" .IX Header "AUTHOR" Barrie Slaymaker .SH "COPYRIGHT" .IX Header "COPYRIGHT" This module is Copyright 2000, 2005 Barrie Slaymaker. All rights reserved. .PP This module is licensed under your choice of the Artistic, \s-1BSD\s0 or General Public License.