src/gui/embedded/qmousedriverplugin_qws.cpp
changeset 0 1918ee327afb
child 4 3b1da2848fc7
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2009 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 QtGui module 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 #include "qmousedriverplugin_qws.h"
       
    43 
       
    44 #ifndef QT_NO_LIBRARY
       
    45 
       
    46 #include "qmouse_qws.h"
       
    47 
       
    48 QT_BEGIN_NAMESPACE
       
    49 
       
    50 /*!
       
    51     \class QMouseDriverPlugin
       
    52     \ingroup plugins
       
    53     \ingroup qws
       
    54 
       
    55     \brief The QMouseDriverPlugin class is an abstract base class for
       
    56     mouse driver plugins in Qt for Embedded Linux.
       
    57 
       
    58     Note that this class is only available in \l{Qt for Embedded Linux}.
       
    59 
       
    60     \l{Qt for Embedded Linux} provides ready-made drivers for several mouse
       
    61     protocols, see the \l{Qt for Embedded Linux Pointer Handling}{pointer
       
    62     handling} documentation for details. Custom mouse drivers can be
       
    63     implemented by subclassing the QWSMouseHandler class and creating
       
    64     a mouse driver plugin.
       
    65 
       
    66     A mouse driver plugin can be created by subclassing
       
    67     QMouseDriverPlugin and reimplementing the pure virtual keys() and
       
    68     create() functions. By exporting the derived class using the
       
    69     Q_EXPORT_PLUGIN2() macro, The default implementation of the
       
    70     QMouseDriverFactory class will automatically detect the plugin and
       
    71     load the driver into the server application at run-time. See \l
       
    72     {How to Create Qt Plugins} for details.
       
    73 
       
    74     \sa QWSMouseHandler, QMouseDriverFactory
       
    75 */
       
    76 
       
    77 /*!
       
    78     \fn QStringList QMouseDriverPlugin::keys() const
       
    79 
       
    80     Implement this function to return the list of valid keys, i.e. the
       
    81     mouse drivers supported by this plugin.
       
    82 
       
    83     \l{Qt for Embedded Linux} provides ready-made drivers for several mouse
       
    84     protocols, see the \l {Qt for Embedded Linux Pointer Handling}{pointer
       
    85     handling} documentation for details.
       
    86 
       
    87     \sa create()
       
    88 */
       
    89 
       
    90 /*!
       
    91     Constructs a mouse driver plugin with the given \a parent.
       
    92 
       
    93     Note that this constructor is invoked automatically by the
       
    94     Q_EXPORT_PLUGIN2() macro, so there is no need for calling it
       
    95     explicitly.
       
    96 */
       
    97 QMouseDriverPlugin::QMouseDriverPlugin(QObject *parent)
       
    98     : QObject(parent)
       
    99 {
       
   100 }
       
   101 
       
   102 /*!
       
   103     Destroys the mouse driver plugin.
       
   104 
       
   105     Note that Qt destroys a plugin automatically when it is no longer
       
   106     used, so there is no need for calling the destructor explicitly.
       
   107 */
       
   108 QMouseDriverPlugin::~QMouseDriverPlugin()
       
   109 {
       
   110 }
       
   111 
       
   112 /*!
       
   113     \fn QScreen* QMouseDriverPlugin::create(const QString &key, const QString& device)
       
   114 
       
   115     Implement this function to create a driver matching the type
       
   116     specified by the given \a key and \a device parameters. Note that
       
   117     keys are case-insensitive.
       
   118 
       
   119     \sa keys()
       
   120 */
       
   121 
       
   122 QT_END_NAMESPACE
       
   123 
       
   124 #endif // QT_NO_LIBRARY