File indexing completed on 2024-05-05 16:08:28

 /* This file is part of the KDE libraries
     Copyright (C) 2001 Carsten Pfeiffer <pfeiffer@kde.org>
 
     This library is free software; you can redistribute it and/or
     modify it under the terms of the GNU Library General Public
     License as published by the Free Software Foundation; either
     version 2 of the License, or (at your option) any later version.
 
     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
     Library General Public License for more details.
 
     You should have received a copy of the GNU Library General Public License
     along with this library; see the file COPYING.LIB.  If not, write to
     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
     Boston, MA 02110-1301, USA.
 */
 
 #ifndef KSCAN_H
 #define KSCAN_H
 
 #include <kdelibs4support_export.h>
 #include <kpagedialog.h>
 #include <QDialogButtonBox>
 
 class QByteArray;
 class QImage;
 
 /**
  * This is a base class for scanning dialogs. You can derive from this class
  * and implement your own dialog. An implementation is available in
  * kdegraphics/libkscan.
  *
  * Application developers that wish to add scanning support to their program
  * can use the static method @p KScanDialog::getScanDialog() to get an instance
  * of the user's preferred scanning dialog.
  *
  * Typical usage looks like this (e.g. in a slotShowScanDialog() method):
  *
  * \code
  * if ( !m_scanDialog ) {
  *     m_scanDialog = KScanDialog::getScanDialog( this );
  *     if ( !m_scanDialog ) // no scanning support installed?
  *         return;
  *
  *     connect( m_scanDialog, SIGNAL( finalImage( const QImage&, int )),
  *              SLOT( slotScanned( const QImage&, int ) ));
  * }
  *
  * if ( m_scanDialog->setup() ) // only if scanner configured/available
  *     m_scanDialog->show();
  * \endcode
  *
  * This will create and show a non-modal scanning dialog. Connect to more
  * signals if you like.
  *
  * @short A baseclass and accessor for Scanning Dialogs
  * @author Carsten Pfeiffer <pfeiffer@kde.org>
  * @deprecated since 5.0, use libksane instead
  */
 class KDELIBS4SUPPORT_DEPRECATED_EXPORT KScanDialog : public KPageDialog
 {
     Q_OBJECT
 
 public:
     /**
      * Creates the user's preferred scanning dialog and returns it,
      * or 0L if no scan-support
      * is available. Pass a suitable @p parent widget, if you like. If you
      * don't you have to 'delete' the returned pointer yourself.
      * @param parent the QWidget's parent, or 0
      * @return the KScanDialog, or 0 if the function failed
      */
     static KScanDialog *getScanDialog(QWidget *parent = nullptr);
     /**
      * Destructs the scan dialog.
      */
     ~KScanDialog() override;
 
     /**
      * Reimplement this if you need to set up some things, before showing the
      * dialog, e.g. to ask the user for the scanner device to use. If you
      * return false (e.g. there is no device available or the user aborted
      * device selection), the dialog will not be shown.
      *
      * @return true by default.
      */
     virtual bool setup();
 
 protected:
     /**
      * Constructs the scan dialog. If you implement an own dialog, you can
      * customize it with the usual KPageDialog flags.
      *
      * @param dialogFace The KPageDialog::FaceType
      * @param buttonMask An ORed mask of all buttons (see
      * QDialogButtonBox::StandardButton)
      * @param parent The QWidget's parent, or 0
      * @see KPageDialog
      */
     KDELIBS4SUPPORT_DEPRECATED explicit KScanDialog(int dialogFace = Tabbed,
                          int buttonMask = QDialogButtonBox::Close | QDialogButtonBox::Help,
                          QWidget *parent = nullptr);
 
     /**
      * Returns the current id for an image. You can use that in your subclass
      * for the signals. The id is used in the signals to let people know
      * which preview and which text-recognition belongs to which scan.
      *
      * @return the current id for the image
      * @see nextId
      * @see finalImage
      * @see preview
      * @see textRecognized
      */
     int id() const;
 
     /**
      * Returns the id for the next image. You can use that in your subclass
      * for the signals.
      *
      * @return the id for the next image
      * @see id
      * @see finalImage
      * @see preview
      * @see textRecognized
      *
      */
     int nextId();
 
 Q_SIGNALS:
     /**
      * Informs you that an image has been previewed.
      * @param img the image
      * @param id the image's id
      */
     void preview(const QImage &img, int id);
 
     /**
      * Informs you that an image has scanned. @p id is the same as in the
      * @p preview() signal, if this image had been previewed before.
      *
      * Note, that those id's may not be properly implemented in the current
      * libkscan.
      * @param img the image
      * @param id the image's id
      */
     void finalImage(const QImage &img, int id);
 
     /**
      * Informs you that the image with the id @p id has been run through
      * text-recognition. The text is in the QString parameter. In the future,
      * a compound document, using rich text will be used instead.
      *
      * @param text the text that has been recognized
      * @param id the id of the image
      */
     void textRecognized(const QString &text, int id);
 
 private:
     class KScanDialogPrivate;
     KScanDialogPrivate *const d;
 };
 
 /**
  * Base class for OCR Dialogs.
  */
 class KDELIBS4SUPPORT_DEPRECATED_EXPORT KOCRDialog : public KPageDialog
 {
     Q_OBJECT
 
 public:
     /**
      * Creates the user's preferred OCR dialog and returns it,
      * or 0L if no OCR-support
      * is available. Pass a suitable @p parent widget, if you like. If you
      * don't you have to 'delete' the returned pointer yourself.
      * @param parent the QWidget's parent, or 0
      * @return the KOCRDialog, or 0 if the function failed
      */
     static KOCRDialog *getOCRDialog(QWidget *parent = nullptr);
     ~KOCRDialog() override;
 
 protected:
     /**
      * Constructs the OCR dialog. If you implement an own dialog, you can
      * customize it with the usual KPageDialog flags.
      *
      * @param dialogFace the KPageDialog::FaceType
      * @param buttonMask a ORed mask of all buttons (see
      * KDialog::ButtonCode)
      * @param parent the QWidget's parent, or 0
      * @param modal if true the dialog is model
      */
     KDELIBS4SUPPORT_DEPRECATED explicit KOCRDialog(int dialogFace = Tabbed, int buttonMask = QDialogButtonBox::Close | QDialogButtonBox::Help,
                         QWidget *parent = nullptr, bool modal = false);
 
     /**
      * Returns the current id for an image. You can use that in your subclass
      * for the signals. The id is used in the signals to let people know
      * which text-recognition belongs to which scan.
      *
      * @return the current id for the image
      * @see nextId
      * @see textRecognized
      */
     int id() const;
 
     /**
      * Returns the id for the next image. You can use that in your subclass
      * for the signals.
      *
      * @return the id for the next image
      * @see id
      * @see textRecognized
      */
     int nextId();
 
 Q_SIGNALS:
     /**
      * Informs you that the image with the id @p id has been run through
      * text-recognition. The text is in the QString parameter. In the future,
      * a compound document, using rich text will be used instead.
      *
      * @param text the text that has been recognized
      * @param id the id of the image
      */
     void textRecognized(const QString &text, int id);
 
 private:
     class KOCRDialogPrivate;
     KOCRDialogPrivate *const d;
 };
 
 #endif // KSCAN_H