.\" 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 "Xacobeo::Utils 3pm"
.TH Xacobeo::Utils 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"
Xacobeo::Utils \- Utilities.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&        use Xacobeo::Utils qw(:dom :xml);
\&        
\&        if (isa_dom_text($node)) {
\&                my $text = escape_xml_text($node\->nodeValue);
\&                print "$text\en";
\&        }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This package provides utility functions that are shared among the different
modules in this project.
.SH "IMPORTS"
.IX Header "IMPORTS"
The following import tags are defined:
.SS ":xml"
.IX Subsection ":xml"
Import the \s-1XML\s0 utilities.
.SS ":dom"
.IX Subsection ":dom"
Imports the \s-1DOM\s0 utilities.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
The following functions are available:
.SS "escape_xml_text"
.IX Subsection "escape_xml_text"
Escapes the text as if would be added to a Text node. This function escapes only
the entities <, > and &.
.PP
Parameters:
.IP "\(bu" 4
\&\f(CW$string\fR
.Sp
The string to escape.
.SS "escape_xml_attribute"
.IX Subsection "escape_xml_attribute"
Escapes the text as if would be added to an Attribute. This function escapes the
entities <, >, &, ' and ".
.PP
Parameters:
.IP "\(bu" 4
\&\f(CW$string\fR
.Sp
The string to escape.
.SS "isa_dom_document"
.IX Subsection "isa_dom_document"
Returns true if the node is a \s-1DOM\s0 \f(CW\*(C`Document\*(C'\fR (instance of
XML::LibXML::Document).
.PP
Parameters:
.IP "\(bu" 4
\&\f(CW$node\fR
.Sp
The node to check.
.SS "isa_dom_element"
.IX Subsection "isa_dom_element"
Returns true if the node is a \s-1DOM\s0 \f(CW\*(C`Element\*(C'\fR (instance of
XML::LibXML::Element).
.PP
Parameters:
.IP "\(bu" 4
\&\f(CW$node\fR
.Sp
The node to check.
.SS "isa_dom_attr"
.IX Subsection "isa_dom_attr"
Returns true if the node is a \s-1DOM\s0 \f(CW\*(C`Attribute\*(C'\fR (instance of
XML::LibXML::Attr).
.PP
Parameters:
.IP "\(bu" 4
\&\f(CW$node\fR
.Sp
The node to check.
.SS "isa_dom_nodelist"
.IX Subsection "isa_dom_nodelist"
Returns true if the node is a \s-1DOM\s0 \f(CW\*(C`NodeList\*(C'\fR (instance of
XML::LibXML::NodeList).
.PP
Parameters:
.IP "\(bu" 4
\&\f(CW$node\fR
.Sp
The node to check.
.SS "isa_dom_text"
.IX Subsection "isa_dom_text"
Returns true if the node is a \s-1DOM\s0 \f(CW\*(C`Text\*(C'\fR (instance of
XML::LibXML::Text).
.PP
\&\fB\s-1NOTE\s0\fR: XML::LibXML considers that \f(CW\*(C`Comment\*(C'\fR and \f(CW\*(C`CDATA\*(C'\fR nodes are also
\&\f(CW\*(C`Text\*(C'\fR nodes. This method doesn't consider a \f(CW\*(C`Comment\*(C'\fR nor a \f(CW\*(C`CDATA\*(C'\fR node as
being \f(CW\*(C`Text\*(C'\fR nodes.
.PP
Parameters:
.IP "\(bu" 4
\&\f(CW$node\fR
.Sp
The node to check.
.SS "isa_dom_comment"
.IX Subsection "isa_dom_comment"
Returns true if the node is a \s-1DOM\s0 \f(CW\*(C`Comment\*(C'\fR (instance of
XML::LibXML::Comment).
.PP
Parameters:
.IP "\(bu" 4
\&\f(CW$node\fR
.Sp
The node to check.
.SS "isa_dom_node"
.IX Subsection "isa_dom_node"
Returns true if the node is a \s-1DOM\s0 \f(CW\*(C`Node\*(C'\fR (instance of
XML::LibXML::Node).
.PP
Parameters:
.IP "\(bu" 4
\&\f(CW$node\fR
.Sp
The node to check.
.SS "isa_dom_pi"
.IX Subsection "isa_dom_pi"
Returns true if the node is a \s-1DOM\s0 \f(CW\*(C`PI\*(C'\fR (also known as: processing instruction)
(instance of XML::LibXML::PI).
.PP
Parameters:
.IP "\(bu" 4
\&\f(CW$node\fR
.Sp
The node to check.
.SS "isa_dom_dtd"
.IX Subsection "isa_dom_dtd"
Returns true if the node is a \s-1DOM\s0 \f(CW\*(C`DTD\*(C'\fR (instance of
XML::LibXML::Dtd).
.PP
Parameters:
.IP "\(bu" 4
\&\f(CW$node\fR
.Sp
The node to check.
.SS "isa_dom_cdata"
.IX Subsection "isa_dom_cdata"
Returns true if the node is a \s-1DOM\s0 \f(CW\*(C`CDATASection\*(C'\fR (instance of
XML::LibXML::CDATASection).
.PP
Parameters:
.IP "\(bu" 4
\&\f(CW$node\fR
.Sp
The node to check.
.SS "isa_dom_namespace"
.IX Subsection "isa_dom_namespace"
Returns true if the node is a \f(CW\*(C`Namespace\*(C'\fR (instance of
XML::LibXML::Namespace).
.PP
\&\fB\s-1NOTE\s0\fR: The \s-1DOM\s0 doesn't define an object type named \f(CW\*(C`Namespaces\*(C'\fR but
XML::LibXML does so this function is named 'isa_dom' for consistency with the
other functions.
.PP
Parameters:
.IP "\(bu" 4
\&\f(CW$node\fR
.Sp
The node to check.
.SS "isa_dom_literal"
.IX Subsection "isa_dom_literal"
Returns true if the node is a \f(CW\*(C`Literal\*(C'\fR (instance of
XML::LibXML::Literal).
.PP
\&\fB\s-1NOTE\s0\fR: The \s-1DOM\s0 doesn't define an object type named \f(CW\*(C`Literal\*(C'\fR but XML::LibXML
does so this function is named 'isa_dom' for consistency with the other
functions.
.PP
Parameters:
.IP "\(bu" 4
\&\f(CW$node\fR
.Sp
The node to check.
.SS "isa_dom_boolean"
.IX Subsection "isa_dom_boolean"
Returns true if the node is a \f(CW\*(C`Boolean\*(C'\fR (instance of
XML::LibXML::Boolean).
.PP
\&\fB\s-1NOTE\s0\fR: The \s-1DOM\s0 doesn't define an object type named \f(CW\*(C`Boolean\*(C'\fR but XML::LibXML
does so this function is named 'isa_dom' for consistency with the other
functions.
.PP
Parameters:
.IP "\(bu" 4
\&\f(CW$node\fR
.Sp
The node to check.
.SS "isa_dom_number"
.IX Subsection "isa_dom_number"
Returns true if the node is a \f(CW\*(C`Number\*(C'\fR (instance of
XML::LibXML::Number).
.PP
\&\fB\s-1NOTE\s0\fR: The \s-1DOM\s0 doesn't define an object type named \f(CW\*(C`Number\*(C'\fR but XML::LibXML
does so this function is named 'isa_dom' for consistency with the other
functions.
.PP
Parameters:
.IP "\(bu" 4
\&\f(CW$node\fR
.Sp
The node to check.
.SS "scrollify"
.IX Subsection "scrollify"
Wraps a widget in a scrolled window.
.PP
Parameters:
.IP "\(bu" 4
\&\f(CW$widget\fR
.Sp
The widget to wrap.
.IP "\(bu" 4
\&\f(CW$width\fR
.Sp
The width of the scroll window. If \f(CW\*(C`undef\*(C'\fR then \-1 will be used.
.IP "\(bu" 4
\&\f(CW$height\fR
.Sp
The height of the scroll window. If \f(CW\*(C`undef\*(C'\fR then \-1 will be used.
.SH "AUTHORS"
.IX Header "AUTHORS"
Emmanuel Rodriguez <potyl@cpan.org>.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2008,2009 by Emmanuel Rodriguez.
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.8 or,
at your option, any later version of Perl 5 you may have available.