man XML::Mini::TreeComponent () - Perl implementation of the XML::Mini TreeComponent API.

NAME

XML::Mini::TreeComponent - Perl implementation of the XML::Mini TreeComponent API.

SYNOPSIS

Don't use this class - only presents an interface for other derived classes.

DESCRIPTION

This class is only to be used as a base class for others.

It presents the minimal interface we can expect from any component in the XML hierarchy.

All methods of this base class simply return NULL except a little default functionality included in the parent() method.

Warning: This class is not to be instatiated. Derive and override.

parent [NEWPARENT]

The parent() method is used to get/set the element's parent.

If the NEWPARENT parameter is passed, sets the parent to NEWPARENT (NEWPARENT must be an instance of a class derived from XML::MiniTreeComponent)

Returns a reference to the parent XML::MiniTreeComponent if set, NULL otherwise.

toString [DEPTH]

Return a stringified version of the XML representing this component and all sub-components

dump

Debugging aid, dump returns a nicely formatted dump of the current structure of the XML::Mini::TreeComponent-derived object.

AUTHOR

LICENSE 

    XML::Mini::TreeComponent module, part of the XML::Mini XML parser/generator package.
    Copyright (C) 2002 Patrick Deegan
    All rights reserved


    This program 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 2 of the License, or
    (at your option) any later version.


    This program 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 this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

Official XML::Mini site: http://minixml.psychogenic.com

Contact page for author available at http://www.psychogenic.com/en/contact.shtml

SEE ALSO

XML::Mini, XML::Mini::Document, XML::Mini::Element

http://minixml.psychogenic.com