kicad/include/xnode.h

100 lines
3.1 KiB
C
Raw Normal View History

2010-08-07 15:25:18 +00:00
/*
* This program source code file is part of KiCad, a free EDA CAD application.
2010-08-07 15:25:18 +00:00
*
* Copyright (C) 2010 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
2020-12-21 15:17:52 +00:00
* Copyright (C) 1992-2020 KiCad Developers, see AUTHORS.txt for contributors.
2010-08-07 15:25:18 +00:00
*
* 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, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
2016-01-12 16:33:33 +00:00
#ifndef XNODE_H_
#define XNODE_H_
#include <richio.h>
// quiet the deprecated warnings with 3 lines:
#include <wx/defs.h>
#undef wxDEPRECATED
#define wxDEPRECATED(x) x
2010-08-07 15:25:18 +00:00
#include <wx/xml/xml.h>
/**
2020-12-21 15:17:52 +00:00
* Hold an XML or S-expression element.
*
* It is used for exporting a document tree in either XML or S-expression.
2010-08-07 15:25:18 +00:00
*/
class XNODE : public wxXmlNode
{
public:
XNODE() :
wxXmlNode()
{
}
XNODE( wxXmlNodeType aType, const wxString& aName, const wxString& aContent = wxEmptyString ) :
2020-12-21 15:17:52 +00:00
wxXmlNode( nullptr, aType, aName, aContent )
2010-08-07 15:25:18 +00:00
{
}
XNODE( XNODE* aParent, wxXmlNodeType aType, const wxString& aName,
2020-12-21 15:17:52 +00:00
const wxString& aContent = wxEmptyString, wxXmlAttribute* aProperties = nullptr ) :
wxXmlNode( aParent, aType, aName, aContent, aProperties )
{
}
XNODE* GetChildren() const
{
return (XNODE* )wxXmlNode::GetChildren();
}
XNODE* GetNext() const
{
return (XNODE* )wxXmlNode::GetNext();
}
XNODE* GetParent() const
{
return (XNODE* )wxXmlNode::GetParent();
}
2010-08-07 15:25:18 +00:00
/**
2020-12-21 15:17:52 +00:00
* Write this object as #UTF8 out to an #OUTPUTFORMATTER as an S-expression.
*
2010-08-07 15:25:18 +00:00
* @param out The formatter to write to.
2020-12-21 15:17:52 +00:00
* @param nestLevel A multiple of the number of spaces to precede the output with.
* @throw IO_ERROR if a system error writing the output, such as a full disk.
2010-08-07 15:25:18 +00:00
*/
virtual void Format( OUTPUTFORMATTER* out, int nestLevel );
2010-08-07 15:25:18 +00:00
/**
2020-12-21 15:17:52 +00:00
* Write the contents of object as #UTF8 out to an #OUTPUTFORMATTER as an S-expression.
*
2010-08-07 15:25:18 +00:00
* This is the same as Format() except that the outer wrapper is not included.
2020-12-21 15:17:52 +00:00
*
2010-08-07 15:25:18 +00:00
* @param out The formatter to write to.
2020-12-21 15:17:52 +00:00
* @param nestLevel A multiple of the number of spaces to precede the output with.
* @throw IO_ERROR if a system error writing the output, such as a full disk.
2010-08-07 15:25:18 +00:00
*/
virtual void FormatContents( OUTPUTFORMATTER* out, int nestLevel );
2010-08-19 14:02:49 +00:00
2010-08-07 15:25:18 +00:00
};
2016-01-12 16:33:33 +00:00
#endif // XNODE_H_