Source: kscan.h


Annotated List
Files
Globals
Hierarchy
Index
/* This file is part of the KDE libraries
    Copyright (C) 2001 Carsten Pfeiffer 

    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., 59 Temple Place - Suite 330,
    Boston, MA 02111-1307, USA.
*/

#ifndef KSCAN_H
#define KSCAN_H

#include 
#include 
#include 

// Can be removed once KDE-2.2 is released
#define KSCANDIALOG_HAS_SETUP 1

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):
 *
 * 
 * if ( !m_scanDialog ) {
 *     m_scanDialog = KScanDialog::getScanDialog( this, "scandialog" );
 *     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();
 * 
* * This will create and show a non-modal scanning dialog. Connect to more * signals if you like. * * If you implement an own scan-dialog, you also have to implement a * KScanDialogFactory. * * @short A baseclass and accessor for Scanning Dialogs * @author Carsten Pfeiffer */ class KScanDialog : public KDialogBase { Q_OBJECT public: /** * @returns the user's preferred scanning dialog, 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. */ static KScanDialog * getScanDialog( QWidget *parent=0L, const char *name=0, bool modal=false ); ~KScanDialog(); /** * 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. * * Returns true by default. */ virtual bool setup(); protected: /** * Constructs the scan dialog. If you implement an own dialog, you can * customize it with the usual @ref KDialogBase flags. * * @see KDialogBase */ KScanDialog( int dialogFace=Tabbed, int buttonMask = Close|Help, QWidget *parent=0L, const char *name=0, 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 preview and which text-recognition belongs to which scan. * * @see #nextId * @see #finalImage * @see #preview * @see #textRecognized */ int id() const { return m_currentId; } /** * @returns the id for the next image. You can use that in your subclass * for the signals. * * @see #id * @see #finalImage * @see #preview * @see #textRecognized * */ int nextId() { return ++m_currentId; } signals: /** * Informs you that an image has been previewed. */ void preview( const QImage&, 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. */ void finalImage( const QImage&, 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. */ void textRecognized( const QString&, int id ); private: int m_currentId; class KScanDialogPrivate; KScanDialogPrivate *d; }; /** * A factory for creating a KScanDialog. You need to reimplement * @p createDialog(). * */ class KScanDialogFactory : public KLibFactory { public: virtual ~KScanDialogFactory(); /** * Your library should reimplement this method to return your KScanDialog * derived dialog. */ virtual KScanDialog * createDialog( QWidget *parent=0, const char *name=0, bool modal=false ) = 0; protected: KScanDialogFactory( QObject *parent=0, const char *name=0 ); virtual QObject* createObject( QObject* parent = 0, const char* name = 0, const char* classname = "QObject", const QStringList &args = QStringList() ); void setName( const QCString& instanceName ) { delete m_instance; m_instance = new KInstance( instanceName ); } KInstance *instance() const { return m_instance; } private: KInstance *m_instance; }; // baseclass for ocr-dialogs class KOCRDialog : public KDialogBase { Q_OBJECT public: static KOCRDialog * getOCRDialog( QWidget *parent=0L, const char *name=0, bool modal=false ); ~KOCRDialog(); protected: KOCRDialog( int dialogFace=Tabbed, int buttonMask = Close|Help, QWidget *parent=0L, const char *name=0, bool modal=false ); int id() const { return m_currentId; } int nextId() { return ++m_currentId; } signals: void textRecognized( const QString&, int id ); private: int m_currentId; class KOCRDialogPrivate; KOCRDialogPrivate *d; }; class KOCRDialogFactory : public KLibFactory { public: virtual ~KOCRDialogFactory(); /** * Your library should reimplement this method to return your KOCRDialog * derived dialog. */ virtual KOCRDialog * createDialog( QWidget *parent=0, const char *name=0, bool modal=false ) = 0; protected: KOCRDialogFactory( QObject *parent=0, const char *name=0 ); virtual QObject* createObject( QObject* parent = 0, const char* name = 0, const char* classname = "QObject", const QStringList &args = QStringList() ); void setName( const QCString& instanceName ) { delete m_instance; m_instance = new KInstance( instanceName ); } KInstance *instance() const { return m_instance; } private: KInstance *m_instance; }; #endif // KSCAN_H

Generated by: dfaure on kde.faure.org on Thu Jan 17 22:16:53 2002, using kdoc 2.0a53.