The KScan Library
The content of the Libkscan documentation was generated by doxygen.
The KScan Library provides an interface for the SANE-lib (see http://www.mostang.com/sane for more information) for KDE applications.
Introduction
The KScan Library furnishes each KDE application with an object which can connect to a scanner set up by SANE, as well as read out and manage the scanner's parameters. The difficulty with this is that SANE scanners do not have a uniform set of options. The scanners support various scan options. An interface for establishing contact to the scanners has to be set up dynamically after the decision is made as to which available device in the system should be used (dynamic GUI).
How to use libkscan
Libkscan provides a dialog for you to include scan functionality to your application. This includes on the main page of the dialog
- The scanner setting parts with dynamically generated controls of scan parameters and the buttons to start scanning
- A preview window to select the scan area
- An option tab to edit basically scan options. The scan dialog works completely as KPart and allows the user to scan a preview, select the interesting part on the preview scan, and than start the final scan. Your application will be notified by a signal finalImage that informs you that a new image is available from the scanner.
Abstract KScan Objects
The KScan Library defines the following classes which are responsible for managing the scanner's parameters:
- KGammaTable
This is a base class which implements a gamma table and carries out the calculations etc. internally.
- KScanOption
The object KScanOption implements exactly one scanning option, such as the scanning resolution. A scanner supports several options which are, in part, independent of one another. This means that if option A is modified, option B could be modified along with it. The KScanLib supports the handling of these dependencies.
- KScanDevice
The object KScanDevice maps the scanners available in the system. This object assists the detection of reachable devices and the options they support.
Once a device is decided upon and this has been opened, the KScanDevice will represent the scanning device. By way of this class, the hardware will actually utilize the options (KScanOption). Furthermore, scanned image data is supplied by KScanDevice.
- KScanOptSet
The object KScanOptSet represents a container for the KScanOption options, apart from a specific device. Up until now, this was made possible by saving several options during the course of the program, e.g. previously configured scanning parameters if a preview scan were to be carried out so that this can be restored following the preview scan.
Furthermore, option sets can be saved to disk.
Helper Classes
There are some helper widgets which simplify the dynamic setup of the scanning interface. These objects provide simple combinations of base widgets to make their usage easier.
Itemized, these are:
- KScanEntry
(defined in kscanslider.h)
Provides an entry field preceded by text.
- KScanSlider
(defined in kscanslider.h)
Slider preceded by text. Range values are transferred with the data type double.
- KScanCombo
(defined in kscanslider.h)
Combobox widget which precedes description text and can represent icons.
- DispGamma
(defined in dispgamma.h)
Widget for displaying gamma tables.
Interface Objects
The KScan Library offers some ready-made objects which can be used as a sort of pre-fabricated dialog in order to integrate the scanning functionality into an application. This results in the availability of scanning functionality in all applications over the same interface.
Currently, there are the following interface elements:
- DeviceSelector
is a class which represents a dialog for scanner selection.
- GammaDialog
is a dialog where a gamma table can be edited. To represent the gamma tables, the gamma dialog uses KGammaTable internally. This class is returned in such as way that it can set the relevant scanner options directly, once the dialog has been completed.
- MassScanDialog
is a mass scanning dialog which informs the user about how the scanning is progressing when the automatic document feeder is used. very beta !
- ScanSourceDialog
Small dialog which enables scanning source selection, e.g. Flatbed, automatic document feeder...
- ScanParams
The ScanParams class is the actual core of the KScan Library in terms of interface layout. The ScanParams class provides a ready-to-use interface for the selected scanner.
The scanner device is analyzed in this class and dynamically generates an interface, according to the device's properties, containing the most important operational elements. These are currently
- Setting options for scanning resolution
- Scanning source selection
- Scanning mode
- Brightness and contrast settings
- Gamma table
- Preview scanning
-
Author:
-
Klaas Freitag <freitag@suse.de>
|
