src/gui/image/qpictureformatplugin.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 "qpictureformatplugin.h"
       
    43 #if !defined(QT_NO_LIBRARY) && !defined(QT_NO_PICTURE)
       
    44 #include "qpicture.h"
       
    45 
       
    46 QT_BEGIN_NAMESPACE
       
    47 
       
    48 /*!
       
    49     \obsolete
       
    50 
       
    51     \class QPictureFormatPlugin
       
    52     \brief The QPictureFormatPlugin class provides an abstract base
       
    53     for custom picture format plugins.
       
    54 
       
    55     \ingroup plugins
       
    56 
       
    57     The picture format plugin is a simple plugin interface that makes
       
    58     it easy to create custom picture formats that can be used
       
    59     transparently by applications.
       
    60 
       
    61     Writing an picture format plugin is achieved by subclassing this
       
    62     base class, reimplementing the pure virtual functions keys(),
       
    63     loadPicture(), savePicture(), and installIOHandler(), and
       
    64     exporting the class with the Q_EXPORT_PLUGIN2() macro.
       
    65 
       
    66     \sa {How to Create Qt Plugins}
       
    67 */
       
    68 
       
    69 /*!
       
    70     \fn QStringList QPictureFormatPlugin::keys() const
       
    71 
       
    72     Returns the list of picture formats this plugin supports.
       
    73 
       
    74     \sa installIOHandler()
       
    75 */
       
    76 
       
    77 /*!
       
    78     \fn bool QPictureFormatPlugin::installIOHandler(const QString &format)
       
    79 
       
    80     Installs a QPictureIO picture I/O handler for the picture format \a
       
    81     format.
       
    82 
       
    83     \sa keys()
       
    84 */
       
    85 
       
    86 
       
    87 /*!
       
    88     Constructs an picture format plugin with the given \a parent.
       
    89     This is invoked automatically by the Q_EXPORT_PLUGIN2() macro.
       
    90 */
       
    91 QPictureFormatPlugin::QPictureFormatPlugin(QObject *parent)
       
    92     : QObject(parent)
       
    93 {
       
    94 }
       
    95 
       
    96 /*!
       
    97     Destroys the picture format plugin.
       
    98 
       
    99     You never have to call this explicitly. Qt destroys a plugin
       
   100     automatically when it is no longer used.
       
   101 */
       
   102 QPictureFormatPlugin::~QPictureFormatPlugin()
       
   103 {
       
   104 }
       
   105 
       
   106 
       
   107 /*!
       
   108     Loads the picture stored in the file called \a fileName, with the
       
   109     given \a format, into *\a picture. Returns true on success;
       
   110     otherwise returns false.
       
   111 
       
   112     \sa savePicture()
       
   113 */
       
   114 bool QPictureFormatPlugin::loadPicture(const QString &format, const QString &fileName, QPicture *picture)
       
   115 {
       
   116     Q_UNUSED(format)
       
   117     Q_UNUSED(fileName)
       
   118     Q_UNUSED(picture)
       
   119     return false;
       
   120 }
       
   121 
       
   122 /*!
       
   123     Saves the given \a picture into the file called \a fileName,
       
   124     using the specified \a format. Returns true on success; otherwise
       
   125     returns false.
       
   126 
       
   127     \sa loadPicture()
       
   128 */
       
   129 bool QPictureFormatPlugin::savePicture(const QString &format, const QString &fileName, const QPicture &picture)
       
   130 {
       
   131     Q_UNUSED(format)
       
   132     Q_UNUSED(fileName)
       
   133     Q_UNUSED(picture)
       
   134     return false;
       
   135 }
       
   136 
       
   137 #endif // QT_NO_LIBRARY || QT_NO_PICTURE
       
   138 
       
   139 QT_END_NAMESPACE