.\" 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::XS 3pm"
.TH Xacobeo::XS 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::XS \- Functions rewritten in XS.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&        use Xacobeo::XS;
\&        
\&        Xacobeo::XS\->load_text_buffer($textview\->get_buffer, $node, $namespaces);
\&        Xacobeo::XS\->load_tree_store($treeview\->get_store, $node, $namespaces);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This package provides some functions that are implemented through \s-1XS\s0. These
functions are much faster than their Perl counterpart.
.SH "CLASS METHODS"
.IX Header "CLASS METHODS"
The following class methods are available:
.SS "load_text_buffer"
.IX Subsection "load_text_buffer"
Populates a Gtk2::TextBuffer with the contents of an XML::LibXML::Node.
The elements and attributes are displayed with the prefix corresponding to their
respective namespaces. The \s-1XML\s0 document is also displayed with proper syntax
highlighting.
.PP
Parameters:
.IP "\(bu" 4
\&\f(CW$buffer\fR
.Sp
The text buffer to fill. Must be an instance of Gtk2::TextBuffer.
.IP "\(bu" 4
\&\f(CW$node\fR
.Sp
The node to display in the the text view. Must be an instance of
XML::LibXML::Node.
.IP "\(bu" 4
\&\f(CW$namespaces\fR
.Sp
The namespaces declared in the document. Must be an hash ref where the keys are
the URIs and the values the prefixes of the namespaces.
.SS "load_tree_store"
.IX Subsection "load_tree_store"
Populates a Gtk2::TreeStore with the contents of an XML::LibXML::Node. The
tree will display only the nodes of type element. Furthermore, the elements are
displayed with the prefix corresponding to their respective namespaces.
.PP
Parameters:
.IP "\(bu" 4
\&\f(CW$store\fR
.Sp
The text store to fill. Must be an instance of Gtk2::TreeStore.
.IP "\(bu" 4
\&\f(CW$node\fR
.Sp
The node to display in the the tree view. Must be an instance of
XML::LibXML::Node.
.IP "\(bu" 4
\&\f(CW$namespaces\fR
.Sp
The namespaces declared in the document. Must be an hash ref where the keys are
the URIs and the values the prefixes of the namespaces.
.SS "get_node_mark"
.IX Subsection "get_node_mark"
Returns a unique identifier for the given node.
.PP
Parameters:
.IP "\(bu" 4
\&\f(CW$node\fR
.Sp
The node. Must be an instance of XML::LibXML::Node.
.SS "get_node_path"
.IX Subsection "get_node_path"
Returns a unique XPath path for the given XML::LibXML::Node. The path will
use node names using the right prefixes.
.PP
Parameters:
.IP "\(bu" 4
\&\f(CW$node\fR
.Sp
The node for which the path has to be computed. Must be an instance of
XML::LibXML::Node.
.IP "\(bu" 4
\&\f(CW$namespaces\fR
.Sp
The namespaces declared in the document. Must be an hash ref where the keys are
the URIs and the values the prefixes of the namespaces.
.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.