tests/auto/xmlpatternssdk/ErrorHandler.h
branchRCL_3
changeset 7 3f74d0d4af4c
equal deleted inserted replaced
6:dee5afe5301f 7:3f74d0d4af4c
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the test suite of the Qt Toolkit.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    32 **
       
    33 **
       
    34 **
       
    35 **
       
    36 **
       
    37 **
       
    38 ** $QT_END_LICENSE$
       
    39 **
       
    40 ****************************************************************************/
       
    41 
       
    42 #ifndef PatternistSDK_ErrorHandler_H
       
    43 #define PatternistSDK_ErrorHandler_H
       
    44 
       
    45 #include "Global.h"
       
    46 #include "qabstractmessagehandler.h"
       
    47 
       
    48 
       
    49 QT_BEGIN_HEADER
       
    50 
       
    51 QT_BEGIN_NAMESPACE
       
    52 
       
    53 template<typename T> class QList;
       
    54 
       
    55 namespace QPatternistSDK
       
    56 {
       
    57     /**
       
    58      * @short A MessageHandler which
       
    59      * accumulates all its received ErrorHandler::Message instances
       
    60      * in a list, retrievable via messages().
       
    61      *
       
    62      * Thus, ErrorHandler does not report errors, but collects them
       
    63      * and allows easy access to them.
       
    64      *
       
    65      * @ingroup PatternistSDK
       
    66      * @author Frans Englich <frans.englich@nokia.com>
       
    67      */
       
    68     class Q_PATTERNISTSDK_EXPORT ErrorHandler : public QAbstractMessageHandler
       
    69     {
       
    70     public:
       
    71         class Message
       
    72         {
       
    73         public:
       
    74             typedef QList<Message> List;
       
    75 
       
    76             QString description() const
       
    77             {
       
    78                 return m_description;
       
    79             }
       
    80 
       
    81             void setDescription(const QString &desc)
       
    82             {
       
    83                 m_description = desc;
       
    84             }
       
    85 
       
    86             void setIdentifier(const QUrl &newId)
       
    87             {
       
    88                 m_identifier = newId;
       
    89             }
       
    90 
       
    91             QUrl identifier() const
       
    92             {
       
    93                 return m_identifier;
       
    94             }
       
    95 
       
    96             QtMsgType type() const
       
    97             {
       
    98                 return m_type;
       
    99             }
       
   100 
       
   101             void setType(const QtMsgType t)
       
   102             {
       
   103                 m_type = t;
       
   104             }
       
   105 
       
   106         private:
       
   107             QUrl        m_identifier;
       
   108             QtMsgType   m_type;
       
   109             QString     m_description;
       
   110         };
       
   111 
       
   112         /**
       
   113          * Clears all accumulated errors.
       
   114          */
       
   115         void reset();
       
   116 
       
   117         Message::List messages() const;
       
   118 
       
   119         /**
       
   120          * Calling this function causes all Qt's internal debug messages to be
       
   121          * sent to @p handler. If @p handler is @c null, Qt's default message
       
   122          * handler is re-installed. In other words, via an internal proxy function,
       
   123          * it installs @p handler as Qt's message handler.
       
   124          *
       
   125          * If @p handler is heap allocated, it will be leaked.
       
   126          *
       
   127          * @see qInstallMsgHandler()
       
   128          */
       
   129         static void installQtMessageHandler(ErrorHandler *const handler);
       
   130 
       
   131         static ErrorHandler *handler;
       
   132 
       
   133     protected:
       
   134         virtual void handleMessage(QtMsgType type,
       
   135                                    const QString &description,
       
   136                                    const QUrl &identifier = QUrl(),
       
   137                                    const QSourceLocation &sourceLocation = QSourceLocation());
       
   138 
       
   139     private:
       
   140         ErrorHandler::Message::List m_messages;
       
   141     };
       
   142 }
       
   143 
       
   144 QT_END_NAMESPACE
       
   145 
       
   146 QT_END_HEADER
       
   147 
       
   148 #endif
       
   149 // vim: et:ts=4:sw=4:sts=4