# class KScanDialog

###

Module | kio
Namespace |
Class | KScanDialog
Inherits | KPageDialog

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 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 );
    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.

A baseclass and accessor for Scanning Dialogs Author Carsten Pfeiffer <pfeiffer@kde.org>

### methods

- KScanDialog (dialogFace, buttonMask, parent)

  returns ctor
  KDE 4.1.0 and later only

  Argument | Type | Default
  --- | --- | ---
  dialogFace | int | Tabbed
  buttonMask | int | Close|Help
  parent | QWidget | 0

  Constructs the scan dialog. If you implement an own dialog, you can customize it with the usual KPageDialog flags.

  dialogFace - The KPageDialog.FaceType

  buttonMask - An ORed mask of all buttons (see KDialog.ButtonCode)

  parent - The QWidget's parent, or 0

  See also KPageDialog

- KScanDialog (a0, a1, a2)

  returns ctor
  before KDE 4.1.0 only

  Argument | Type | Default
  --- | --- | ---
  a0 | int | Tabbed
  a1 | int | Close|Help
  a2 | QWidget | 0

- finalImage (img, id)

  returns Nothing
  SIGNAL ("finalImage (const QImage&, int)")

  Argument | Type | Default
  --- | --- | ---
  img | QImage |
  id | int |

  Informs you that an image has scanned. id is the same as in the preview() signal, if this image had been previewed before.

  Note, that those id's may not be properly implemented in the current libkscan.

  img - the image

  id - the image's id

- getScanDialog (parent)

  returns KScanDialog
  static

  Argument | Type | Default
  --- | --- | ---
  parent | QWidget | 0

  Creates the user's preferred scanning dialog and returns it, or 0 if no scan-support is available. Pass a suitable parent widget, if you like. If you don't you have to 'delete' the returned pointer yourself.

  parent - the QWidget's parent, or 0 Returns the KScanDialog, or 0 if the function failed

- id ( )

  returns int

  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.

  Returns the current id for the image

  See also nextId

  See also finalImage

  See also preview

  See also textRecognized

- nextId ( )

  returns int

  Returns the id for the next image. You can use that in your subclass for the signals.

  Returns the id for the next image

  See also id

  See also finalImage

  See also preview

  See also textRecognized

- preview (img, id)

  returns Nothing
  SIGNAL ("preview (const QImage&, int)")

  Argument | Type | Default
  --- | --- | ---
  img | QImage |
  id | int |

  Informs you that an image has been previewed.

  img - the image

  id - the image's id

- setup ( )

  returns bool

  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.

- textRecognized (text, id)

  returns Nothing
  SIGNAL ("textRecognized (const QString&, int)")

  Argument | Type | Default
  --- | --- | ---
  text | QString |
  id | int |

  Informs you that the image with the id 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.

  text - the text that has been recognized

  id - the id of the image