ksane.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is part of the KDE project
 *
 * Date        : 2007-09-13
 * Description : Sane interface for KDE
 *
 * Copyright (C) 2007-2010 by Kare Sars <kare dot sars at iki dot fi>
 * Copyright (C) 2007 by Gilles Caulier <caulier dot gilles at gmail dot com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) version 3, or any
 * later version accepted by the membership of KDE e.V. (or its
 * successor approved by the membership of KDE e.V.), which shall
 * act as a proxy defined in Section 6 of version 3 of the license.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * ============================================================ */

#ifndef KSANE_H
#define KSANE_H

// Qt includes
#include <QtGui/QWidget>

// Local includes
#include "libksane_export.h"

namespace KSaneIface
{

class KSaneWidgetPrivate;

class LIBKSANE_EXPORT KSaneWidget : public QWidget
{
    Q_OBJECT
    friend class KSaneWidgetPrivate;

public:
    typedef enum
    {
        FormatBlackWhite,   
        FormatGrayScale8,   
        FormatGrayScale16,  
        FormatRGB_8_C,      
        FormatRGB_16_C,     
        FormatBMP,          
        FormatNone = 0xFFFF 
    } ImageFormat;

    typedef enum
    {
        NoError,            
        ErrorCannotSegment, 
        ErrorGeneral,        
        Information          
    } ScanStatus;
    
    struct DeviceInfo
    {
        QString name;     /* unique device name */
        QString vendor;   /* device vendor string */
        QString model;    /* device model name */
        QString type;     /* device type (e.g., "flatbed scanner") */
    };

    KSaneWidget(QWidget* parent=0);

    ~KSaneWidget();

    QString selectDevice(QWidget* parent=0);

    void initGetDeviceList() const;

    bool openDevice(const QString &device_name);

    bool closeDevice();
    
    KDE_DEPRECATED bool makeQImage(const QByteArray &, int, int, int, ImageFormat, QImage &);
     
    QImage toQImage(const QByteArray &data,
                    int width,
                    int height,
                    int bytes_per_line,
                    ImageFormat format);

    QImage toQImageSilent(const QByteArray &data,
                    int width,
                    int height,
                    int bytes_per_line,
                    ImageFormat format);

    QString vendor() const;
    QString make() const;
    QString model() const;

    float currentDPI();

    float scanAreaWidth();

    float scanAreaHeight();

    void setSelection(QPointF topLeft, QPointF bottomRight);
    
    void setPreviewResolution(float dpi);

    void getOptVals(QMap <QString, QString> &opts);

    int setOptVals(const QMap <QString, QString> &opts);

    bool getOptVal(const QString &optname, QString &value);

    bool setOptVal(const QString &optname, const QString &value);

    void setScanButtonText(const QString &scanLabel);

    void setPreviewButtonText(const QString &previewLabel);

    void enableAutoSelect(bool enable);

    void setOptionsCollapsed(bool collapse);

    void setScanButtonHidden(bool hidden);

public Q_SLOTS:
    void scanCancel();

    void scanFinal();

Q_SIGNALS:
    void imageReady(QByteArray &data, int width, int height,
                    int bytes_per_line, int format);

    void scanDone(int status, const QString &strStatus);

    void userMessage(int type, const QString &strStatus);

    void scanProgress(int percent);

    void availableDevices(const QList<KSaneWidget::DeviceInfo> &deviceList);

    void buttonPressed(const QString &optionName, const QString &optionLabel, bool pressed);

private:

    KSaneWidgetPrivate * const d;
};

}  // NameSpace KSaneIface

#endif // SANE_WIDGET_H