qxmldeclhandler(3qt)

1QXmlDeclHandler(3qt)                                      QXmlDeclHandler(3qt)
2
3
4

NAME

6       QXmlDeclHandler - Interface to report declaration content of XML data
7

SYNOPSIS

9       All the functions in this class are reentrant when Qt is built with
10       thread support.</p>
11
12       #include <qxml.h>
13
14       Inherited by QXmlDefaultHandler.
15
16   Public Members
17       virtual bool attributeDecl ( const QString & eName, const QString &
18           aName, const QString & type, const QString & valueDefault, const
19           QString & value ) = 0
20       virtual bool internalEntityDecl ( const QString & name, const QString &
21           value ) = 0
22       virtual bool externalEntityDecl ( const QString & name, const QString &
23           publicId, const QString & systemId ) = 0
24       virtual QString errorString () = 0
25

DESCRIPTION

27       The QXmlDeclHandler class provides an interface to report declaration
28       content of XML data.
29
30       You can set the declaration handler with QXmlReader::setDeclHandler().
31
32       This interface is based on the SAX2 extension DeclHandler.
33
34       The interface provides attributeDecl(), internalEntityDecl() and
35       externalEntityDecl() functions.
36
37       See also the Introduction to SAX2.
38
39       See also QXmlDTDHandler, QXmlContentHandler, QXmlEntityResolver,
40       QXmlErrorHandler, QXmlLexicalHandler, and XML.
41

MEMBER FUNCTION DOCUMENTATION

bool QXmlDeclHandler::attributeDecl ( const QString & eName, const QString &

44       aName, const QString & type, const QString & valueDefault, const
45       QString & value ) [pure virtual]
46       The reader calls this function to report an attribute type declaration.
47       Only the effective (first) declaration for an attribute is reported.
48
49       The reader passes the name of the associated element in eName and the
50       name of the attribute in aName. It passes a string that represents the
51       attribute type in type and a string that represents the attribute
52       default in valueDefault. This string is one of "#IMPLIED", "#REQUIRED",
53       "#FIXED" or QString::null (if none of the others applies). The reader
54       passes the attribute's default value in value. If no default value is
55       specified in the XML file, value is QString::null.
56
57       If this function returns FALSE the reader stops parsing and reports an
58       error. The reader uses the function errorString() to get the error
59       message.
60

QString QXmlDeclHandler::errorString () [pure virtual]

62       The reader calls this function to get an error string if any of the
63       handler functions returns FALSE.
64

bool QXmlDeclHandler::externalEntityDecl ( const QString & name, const QString

66       & publicId, const QString & systemId ) [pure virtual]
67       The reader calls this function to report a parsed external entity
68       declaration. Only the effective (first) declaration for each entity is
69       reported.
70
71       The reader passes the name of the entity in name, the public identifier
72       in publicId and the system identifier in systemId. If there is no
73       public identifier specified, it passes QString::null in publicId.
74
75       If this function returns FALSE the reader stops parsing and reports an
76       error. The reader uses the function errorString() to get the error
77       message.
78

bool QXmlDeclHandler::internalEntityDecl ( const QString & name, const QString

80       & value ) [pure virtual]
81       The reader calls this function to report an internal entity
82       declaration. Only the effective (first) declaration is reported.
83
84       The reader passes the name of the entity in name and the value of the
85       entity in value.
86
87       If this function returns FALSE the reader stops parsing and reports an
88       error. The reader uses the function errorString() to get the error
89       message.
90
91