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

Programs that use this code are bound to the terms and conditions of the GNU GPL (see the LICENSE file). If you wish to include these modules in non-GPL code, you need prior written authorisation from the authors.

This library is released under the terms of the GNU GPL version 3, making it available only for free programs ("free" here being used in the sense of the GPL, see http://www.gnu.org for more details). Anyone wishing to use this library within a proprietary or otherwise non-GPLed program MUST contact psychogenic.com to acquire a distinct license for their application. This approach encourages the use of free software while allowing for proprietary solutions that support further development.

LICENSE

    XML::Mini::TreeComponent module, part of the XML::Mini XML parser/generator package.
    Copyright (C) 2002-2008 Patrick Deegan
    All rights reserved
    
    XML::Mini 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 3 of the License, or
    (at your option) any later version.

    XML::Mini 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 XML::Mini.  If not, see <http://www.gnu.org/licenses/>.

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

Contact page for author available on http://www.psychogenic.com/