libxml++  2.42.1
Public Member Functions | Protected Member Functions | List of all members
xmlpp::Schema Class Reference

Represents an XML Schema. More...

#include <libxml++/schema.h>

Inheritance diagram for xmlpp::Schema:
Inheritance graph
[legend]

Public Member Functions

LIBXMLPP_API Schema (_xmlSchema* schema)
 Create a schema from the underlying libxml schema element. More...
 
LIBXMLPP_API Schema (Document* document=nullptr, bool embed=false)
 Create a schema from an XML document. More...
 
 ~Schema ()
 
LIBXMLPP_API _xmlSchema* cobj ()
 Access the underlying libxml implementation. More...
 
LIBXMLPP_API const _xmlSchema* cobj () const
 Access the underlying libxml implementation. More...
 
LIBXMLPP_API Documentget_document ()
 Get the schema document. More...
 
LIBXMLPP_API const Documentget_document () const
 Get the schema document. More...
 
LIBXMLPP_API Glib::ustring get_name () const
 
LIBXMLPP_API Glib::ustring get_target_namespace () const
 
LIBXMLPP_API Glib::ustring get_version () const
 
virtual LIBXMLPP_API void set_document (Document* document=nullptr, bool embed=false)
 Set a new document to the schema. More...
 

Protected Member Functions

virtual LIBXMLPP_API void release_underlying ()
 

Detailed Description

Represents an XML Schema.

Since libxml++ 2.24:
Deprecated:
Use XsdSchema instead.

Constructor & Destructor Documentation

LIBXMLPP_API xmlpp::Schema::Schema ( _xmlSchema *  schema)
explicit

Create a schema from the underlying libxml schema element.

Deprecated:
Use XsdSchema instead.
LIBXMLPP_API xmlpp::Schema::Schema ( Document document = nullptr,
bool  embed = false 
)
explicit

Create a schema from an XML document.

Parameters
documentXMLSchema document, nullptr to create an empty schema document.
embedIf true, the document will be deleted when the schema is deleted or another document is set.
Exceptions
xmlpp::parse_error
xmlpp::internal_errorIf an empty schema document can't be created.
Deprecated:
Use XsdSchema instead.
xmlpp::Schema::~Schema ( )

Member Function Documentation

LIBXMLPP_API _xmlSchema* xmlpp::Schema::cobj ( )

Access the underlying libxml implementation.

Deprecated:
Use XsdSchema::cobj() instead.
LIBXMLPP_API const _xmlSchema* xmlpp::Schema::cobj ( ) const

Access the underlying libxml implementation.

Deprecated:
Use XsdSchema::cobj() instead.
LIBXMLPP_API Document* xmlpp::Schema::get_document ( )

Get the schema document.

Returns
A pointer to the schema document, or nullptr if none exists.
Deprecated:
There is no replacement.
LIBXMLPP_API const Document* xmlpp::Schema::get_document ( ) const

Get the schema document.

Returns
A pointer to the schema document, or nullptr if none exists.
Deprecated:
There is no replacement.
LIBXMLPP_API Glib::ustring xmlpp::Schema::get_name ( ) const
Deprecated:
There is no replacement.
LIBXMLPP_API Glib::ustring xmlpp::Schema::get_target_namespace ( ) const
Deprecated:
There is no replacement.
LIBXMLPP_API Glib::ustring xmlpp::Schema::get_version ( ) const
Deprecated:
There is no replacement.
virtual LIBXMLPP_API void xmlpp::Schema::release_underlying ( )
protectedvirtual
virtual LIBXMLPP_API void xmlpp::Schema::set_document ( Document document = nullptr,
bool  embed = false 
)
virtual

Set a new document to the schema.

If the old schema document is owned by the schema (embed == true), the old schema document and all its nodes are deleted.

Parameters
documentXMLSchema document, nullptr to create an empty schema document.
embedIf true, the document will be deleted when the schema is deleted or another document is set.
Exceptions
xmlpp::parse_error
xmlpp::internal_errorIf an empty schema document can't be created.
Deprecated:
Use XsdSchema::parse_document() instead.