/usr/share/qt5/doc/qtxmlpatterns/qabstractmessagehandler.html is in qtxmlpatterns5-doc-html 5.2.1-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qabstractmessagehandler.cpp -->
<title>QAbstractMessageHandler Class | QtXmlPatterns </title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.2</li>
<li><a href="qtxmlpatterns-index.html">Qt XML Patterns</a></li>
<li><a href="qtxmlpatterns-module.html">C++ Classes</a></li>
<li>QAbstractMessageHandler</li>
<li id="buildversion">
Qt 5.2.1 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QAbstractMessageHandler Class</h1>
<!-- $$$QAbstractMessageHandler-brief -->
<p>The QAbstractMessageHandler class provides a callback interface for handling messages. <a href="#details">More...</a></p>
<!-- @@@QAbstractMessageHandler -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QAbstractMessageHandler></span>
</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> <tt>QT += xmlpatterns</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 4.4</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p></p>
</td></tr></table><p><b>Note:</b> All functions in this class are thread-safe.</p>
<ul>
<li><a href="qabstractmessagehandler-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qabstractmessagehandler.html#QAbstractMessageHandler">QAbstractMessageHandler</a></b>(QObject *<i> parent</i> = 0)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qabstractmessagehandler.html#dtor.QAbstractMessageHandler">~QAbstractMessageHandler</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractmessagehandler.html#message">message</a></b>(QtMsgType<i> type</i>, const QString &<i> description</i>, const QUrl &<i> identifier</i> = QUrl(), const QSourceLocation &<i> sourceLocation</i> = QSourceLocation())</td></tr>
</table>
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qabstractmessagehandler.html#handleMessage">handleMessage</a></b>(QtMsgType<i> type</i>, const QString &<i> description</i>, const QUrl &<i> identifier</i>, const QSourceLocation &<i> sourceLocation</i>) = 0</td></tr>
</table>
<a name="details"></a>
<!-- $$$QAbstractMessageHandler-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QAbstractMessageHandler class provides a callback interface for handling messages.</p>
<p>QAbstractMessageHandler is an abstract base class that provides a callback interface for handling messages. For example, class <a href="qxmlquery.html">QXmlQuery</a> parses and runs an <a href="xmlprocessing.html">XQuery</a>. When it detects a compile or runtime error, it generates an appropriate error message, but rather than output the message itself, it passes the message to the <a href="qabstractmessagehandler.html#message">message</a>() function of its QAbstractMessageHandler. See <a href="qxmlquery.html#setMessageHandler">QXmlQuery::setMessageHandler</a>().</p>
<p>You create a message handler by subclassing QAbstractMessageHandler and implementing <a href="qabstractmessagehandler.html#handleMessage">handleMessage</a>(). You then pass a pointer to an instance of your subclass to any classes that must generate messages. The messages are sent to the message handler via the <a href="qabstractmessagehandler.html#message">message</a>() function, which forwards them to your handleMessge(). The effect is to serialize the handling of all messages, which means your QAbstractMessageHandler subclass is thread safe.</p>
<p>A single instance of QAbstractMessageHandler can be called on to handle messages from multiple sources. Hence, the content of a message, which is the <i>description</i> parameter passed to <a href="qabstractmessagehandler.html#message">message</a>() and <a href="qabstractmessagehandler.html#handleMessage">handleMessage</a>(), must be interpreted in light of the context that required the message to be sent. That context is specified by the <i>identifier</i> and <i>sourceLocation</i> parameters to <a href="qabstractmessagehandler.html#message">message</a>() <a href="qabstractmessagehandler.html#handleMessage">handleMessage</a>().</p>
</div>
<!-- @@@QAbstractMessageHandler -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QAbstractMessageHandler[overload1]$$$QAbstractMessageHandlerQObject* -->
<h3 class="fn"><a name="QAbstractMessageHandler"></a>QAbstractMessageHandler::<span class="name">QAbstractMessageHandler</span>(<span class="type">QObject</span> *<i> parent</i> = 0)</h3>
<p>Constructs a <a href="qabstractmessagehandler.html">QAbstractMessageHandler</a>. The <i>parent</i> is passed to the QObject base class constructor.</p>
<!-- @@@QAbstractMessageHandler -->
<!-- $$$~QAbstractMessageHandler[overload1]$$$~QAbstractMessageHandler -->
<h3 class="fn"><a name="dtor.QAbstractMessageHandler"></a>QAbstractMessageHandler::<span class="name">~QAbstractMessageHandler</span>()<tt> [virtual]</tt></h3>
<p>Destructs this <a href="qabstractmessagehandler.html">QAbstractMessageHandler</a>.</p>
<!-- @@@~QAbstractMessageHandler -->
<!-- $$$handleMessage[overload1]$$$handleMessageQtMsgTypeconstQString&constQUrl&constQSourceLocation& -->
<h3 class="fn"><a name="handleMessage"></a><span class="type">void</span> QAbstractMessageHandler::<span class="name">handleMessage</span>(<span class="type">QtMsgType</span><i> type</i>, const <span class="type">QString</span> &<i> description</i>, const <span class="type">QUrl</span> &<i> identifier</i>, const <span class="type"><a href="qsourcelocation.html">QSourceLocation</a></span> &<i> sourceLocation</i>)<tt> [pure virtual protected]</tt></h3>
<p>This function must be implemented by the sub-class. <a href="qabstractmessagehandler.html#message">message</a>() will call this function, passing in its parameters, <i>type</i>, <i>description</i>, <i>identifier</i> and <i>sourceLocation</i> unmodified.</p>
<!-- @@@handleMessage -->
<!-- $$$message[overload1]$$$messageQtMsgTypeconstQString&constQUrl&constQSourceLocation& -->
<h3 class="fn"><a name="message"></a><span class="type">void</span> QAbstractMessageHandler::<span class="name">message</span>(<span class="type">QtMsgType</span><i> type</i>, const <span class="type">QString</span> &<i> description</i>, const <span class="type">QUrl</span> &<i> identifier</i> = QUrl(), const <span class="type"><a href="qsourcelocation.html">QSourceLocation</a></span> &<i> sourceLocation</i> = QSourceLocation())</h3>
<p>Sends a message to this message handler. <i>type</i> is the kind of message being sent. <i>description</i> is the message content. The <i>identifier</i> is a URI that identifies the message and is the key to interpreting the other arguments.</p>
<p>Typically, this class is used for reporting errors, as is the case for <a href="qxmlquery.html">QXmlQuery</a>, which uses a <a href="qabstractmessagehandler.html">QAbstractMessageHandler</a> to report compile and runtime <a href="xmlprocessing.html">XQuery</a> errors. Hence, using a QUrl as the message <i>identifier</i> is was inspired by the explanation of <a href="http://www.w3.org/TR/xquery/#errors">error handling in the XQuery language</a>. Because the <i>identifier</i> is composed of a namespace URI and a local part, identifiers with the same local part are unique. The caller is responsible for ensuring that <i>identifier</i> is either a valid QUrl or a default constructed QUrl.</p>
<p><i>sourceLocation</i> identifies a location in a resource (i.e., file or document) where the need for reporting a message was detected.</p>
<p>This function unconditionally calls <a href="qabstractmessagehandler.html#handleMessage">handleMessage</a>(), passing all its parameters unmodified.</p>
<p><b>See also </b><a href="http://www.w3.org/TR/xquery/#errors">http://www.w3.org/TR/xquery/#errors</a>.</p>
<!-- @@@message -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> Digia, Qt and their respective logos are trademarks of Digia Plc in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|