QXmlSchema

The QXmlSchema class provides loading and validation of a W3C XML Schema. More

Inheritance diagram of PySide2.QtXmlPatterns.QXmlSchema

New in version 4.6.

Synopsis

Functions

Detailed Description

The QXmlSchema class loads, compiles and validates W3C XML Schema files that can be used further for validation of XML instance documents via QXmlSchemaValidator .

The following example shows how to load a XML Schema file from the network and test whether it is a valid schema document:

QUrl url("http://www.schema-example.org/myschema.xsd");

QXmlSchema schema;
if (schema.load(url) == true)
    qDebug() << "schema is valid";
else
    qDebug() << "schema is invalid";

XML Schema Version

This class is used to represent schemas that conform to the XML Schema 1.0 specification.

class QXmlSchema

QXmlSchema(other)

param other

QXmlSchema

Constructs an invalid, empty schema that cannot be used until load() is called.

Constructs a QXmlSchema that is a copy of other . The new instance will share resources with the existing schema to the extent possible.

PySide2.QtXmlPatterns.QXmlSchema.documentUri()
Return type

QUrl

Returns the document URI of the schema or an empty URI if no schema has been set.

PySide2.QtXmlPatterns.QXmlSchema.isValid()
Return type

bool

Returns true if this schema is valid. Examples of invalid schemas are ones that contain syntax errors or that do not conform the W3C XML Schema specification.

PySide2.QtXmlPatterns.QXmlSchema.load(source[, documentUri=QUrl()])
Parameters
  • sourceQIODevice

  • documentUriQUrl

Return type

bool

PySide2.QtXmlPatterns.QXmlSchema.load(data[, documentUri=QUrl()])
Parameters
  • dataQByteArray

  • documentUriQUrl

Return type

bool

PySide2.QtXmlPatterns.QXmlSchema.load(source)
Parameters

sourceQUrl

Return type

bool

Sets this QXmlSchema to a schema loaded from the source URI.

If the schema is invalid , false is returned and the behavior is undefined.

Example:

QUrl url("http://www.schema-example.org/myschema.xsd");

QXmlSchema schema;
if (schema.load(url) == true)
    qDebug() << "schema is valid";
else
    qDebug() << "schema is invalid";

See also

isValid()

PySide2.QtXmlPatterns.QXmlSchema.messageHandler()
Return type

QAbstractMessageHandler

Returns the message handler that handles compile and validation messages for this QXmlSchema .

PySide2.QtXmlPatterns.QXmlSchema.namePool()
Return type

QXmlNamePool

Returns the name pool used by this QXmlSchema for constructing names . There is no setter for the name pool, because mixing name pools causes errors due to name confusion.

PySide2.QtXmlPatterns.QXmlSchema.networkAccessManager()
Return type

QNetworkAccessManager

Returns the network manager, or 0 if it has not been set.

PySide2.QtXmlPatterns.QXmlSchema.setMessageHandler(handler)
Parameters

handlerQAbstractMessageHandler

Changes the message handler for this QXmlSchema to handler . The schema sends all compile and validation messages to this message handler. QXmlSchema does not take ownership of handler .

Normally, the default message handler is sufficient. It writes compile and validation messages to stderr . The default message handler includes color codes if stderr can render colors.

When QXmlSchema calls message() , the arguments are as follows:

message() argument

Semantics

QtMsgType type

Only QtWarningMsg and QtFatalMsg are used. The former identifies a warning, while the latter identifies an error.

const QString & description

An XHTML document which is the actual message. It is translated into the current language.

const QUrl &identifier

Identifies the error with a URI, where the fragment is the error code, and the rest of the URI is the error namespace.

const QSourceLocation & sourceLocation

Identifies where the error occurred.

See also

messageHandler()

PySide2.QtXmlPatterns.QXmlSchema.setNetworkAccessManager(networkmanager)
Parameters

networkmanagerQNetworkAccessManager

Sets the network manager to manager . QXmlSchema does not take ownership of manager .

PySide2.QtXmlPatterns.QXmlSchema.setUriResolver(resolver)
Parameters

resolverQAbstractUriResolver

Sets the URI resolver to resolver . QXmlSchema does not take ownership of resolver .

See also

uriResolver()

PySide2.QtXmlPatterns.QXmlSchema.uriResolver()
Return type

QAbstractUriResolver

Returns the schema’s URI resolver. If no URI resolver has been set, Qt XML Patterns will use the URIs in schemas as they are.

The URI resolver provides a level of abstraction, or polymorphic URIs . A resolver can rewrite logical URIs to physical ones, or it can translate obsolete or invalid URIs to valid ones.

When Qt XML Patterns calls resolve() the absolute URI is the URI mandated by the schema specification, and the relative URI is the URI specified by the user.

See also

setUriResolver()