#include <kscan.h>
Inherits KDialogBase.
Signals | |
void | preview (const TQImage &img, int id) |
void | finalImage (const TQImage &img, int id) |
void | textRecognized (const TQString &text, int id) |
Public Member Functions | |
~KScanDialog () | |
virtual bool | setup () |
Static Public Member Functions | |
static KScanDialog * | getScanDialog (TQWidget *parent=0L, const char *name=0, bool modal=false) |
Protected Member Functions | |
KScanDialog (int dialogFace=Tabbed, int buttonMask=Close|Help, TQWidget *parent=0L, const char *name=0, bool modal=false) | |
int | id () const |
int | nextId () |
virtual void | virtual_hook (int id, void *data) |
Detailed Description
This is a base class for scanning dialogs.
You can derive from this class and implement your own dialog. An implementation is available in tdegraphics/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):
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.
A baseclass and accessor for Scanning Dialogs
Constructor & Destructor Documentation
◆ ~KScanDialog()
◆ KScanDialog()
|
protected |
Constructs the scan dialog.
If you implement an own dialog, you can customize it with the usual KDialogBase flags.
- Parameters
-
dialogFace the KDialogBase::DialogType buttonMask a ORed mask of all buttons (see KDialogBase::ButtonCode) parent the TQWidget's parent, or 0 name the name of the TQObject, can be 0 modal if true the dialog is model
- See also
- KDialogBase
Member Function Documentation
◆ finalImage
|
signal |
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.
- Parameters
-
img the image id the image's id
◆ getScanDialog()
|
static |
Creates the user's preferred scanning dialog and returns it, or 0L 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.
- Parameters
-
parent the TQWidget's parent, or 0 name the name of the TQObject, can be 0 modal if true the dialog is model
- Returns
- the KScanDialog, or 0 if the function failed
◆ id()
|
inlineprotected |
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
- finalImage
- preview
- textRecognized
◆ nextId()
|
inlineprotected |
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
- finalImage
- preview
- textRecognized
◆ preview
|
signal |
Informs you that an image has been previewed.
- Parameters
-
img the image id the image's id
◆ setup()
|
virtual |
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
|
signal |
Informs you that the image with the id id
has been run through text-recognition.
The text is in the TQString parameter. In the future, a compound document, using rich text will be used instead.
- Parameters
-
text the text that has been recognized id the id of the image
The documentation for this class was generated from the following files: