libs/libksane/libksane
#include <ksane.h>
Classes | |
struct | DeviceInfo |
Public Types | |
enum | ImageFormat { FormatBlackWhite, FormatGrayScale8, FormatGrayScale16, FormatRGB_8_C, FormatRGB_16_C, FormatBMP, FormatNone = 0xFFFF } |
enum | ScanStatus { NoError, ErrorCannotSegment, ErrorGeneral, Information } |
Public Slots | |
void | scanCancel () |
void | scanFinal () |
Signals | |
void | availableDevices (const QList< KSaneWidget::DeviceInfo > &deviceList) |
void | buttonPressed (const QString &optionName, const QString &optionLabel, bool pressed) |
void | imageReady (QByteArray &data, int width, int height, int bytes_per_line, int format) |
void | scanDone (int status, const QString &strStatus) |
void | scanProgress (int percent) |
void | userMessage (int type, const QString &strStatus) |
Public Member Functions | |
KSaneWidget (QWidget *parent=0) | |
~KSaneWidget () | |
bool | closeDevice () |
float | currentDPI () |
void | enableAutoSelect (bool enable) |
bool | getOptVal (const QString &optname, QString &value) |
void | getOptVals (QMap< QString, QString > &opts) |
void | initGetDeviceList () const |
QString | make () const |
KDE_DEPRECATED bool | makeQImage (const QByteArray &, int, int, int, ImageFormat, QImage &) |
QString | model () const |
bool | openDevice (const QString &device_name) |
float | scanAreaHeight () |
float | scanAreaWidth () |
QString | selectDevice (QWidget *parent=0) |
void | setOptionsCollapsed (bool collapse) |
bool | setOptVal (const QString &optname, const QString &value) |
int | setOptVals (const QMap< QString, QString > &opts) |
void | setPreviewButtonText (const QString &previewLabel) |
void | setPreviewResolution (float dpi) |
void | setScanButtonHidden (bool hidden) |
void | setScanButtonText (const QString &scanLabel) |
void | setSelection (QPointF topLeft, QPointF bottomRight) |
QImage | toQImage (const QByteArray &data, int width, int height, int bytes_per_line, ImageFormat format) |
QImage | toQImageSilent (const QByteArray &data, int width, int height, int bytes_per_line, ImageFormat format) |
QString | vendor () const |
Public Member Functions inherited from QWidget | |
QWidget (QWidget *parent, QFlags< Qt::WindowType > f) | |
QWidget (QWidget *parent, const char *name, QFlags< Qt::WindowType > f) | |
~QWidget () | |
bool | acceptDrops () const |
QString | accessibleDescription () const |
QString | accessibleName () const |
QList< QAction * > | actions () const |
void | activateWindow () |
void | addAction (QAction *action) |
void | addActions (QList< QAction * > actions) |
void | adjustSize () |
bool | autoFillBackground () const |
Qt::BackgroundMode | backgroundMode () const |
QPoint | backgroundOffset () const |
BackgroundOrigin | backgroundOrigin () const |
QPalette::ColorRole | backgroundRole () const |
QSize | baseSize () const |
QString | caption () const |
QWidget * | childAt (int x, int y, bool includeThis) const |
QWidget * | childAt (const QPoint &p, bool includeThis) const |
QWidget * | childAt (int x, int y) const |
QWidget * | childAt (const QPoint &p) const |
QRect | childrenRect () const |
QRegion | childrenRegion () const |
void | clearFocus () |
void | clearMask () |
bool | close (bool alsoDelete) |
bool | close () |
QColorGroup | colorGroup () const |
void | constPolish () const |
QMargins | contentsMargins () const |
QRect | contentsRect () const |
Qt::ContextMenuPolicy | contextMenuPolicy () const |
QCursor | cursor () const |
void | customContextMenuRequested (const QPoint &pos) |
void | drawText (const QPoint &p, const QString &s) |
void | drawText (int x, int y, const QString &s) |
WId | effectiveWinId () const |
void | ensurePolished () const |
void | erase () |
void | erase (const QRect &rect) |
void | erase (const QRegion &rgn) |
void | erase (int x, int y, int w, int h) |
Qt::FocusPolicy | focusPolicy () const |
QWidget * | focusProxy () const |
QWidget * | focusWidget () const |
const QFont & | font () const |
QFontInfo | fontInfo () const |
QFontMetrics | fontMetrics () const |
QPalette::ColorRole | foregroundRole () const |
QRect | frameGeometry () const |
QSize | frameSize () const |
const QRect & | geometry () const |
void | getContentsMargins (int *left, int *top, int *right, int *bottom) const |
virtual HDC | getDC () const |
void | grabGesture (Qt::GestureType gesture, QFlags< Qt::GestureFlag > flags) |
void | grabKeyboard () |
void | grabMouse () |
void | grabMouse (const QCursor &cursor) |
int | grabShortcut (const QKeySequence &key, Qt::ShortcutContext context) |
QGraphicsEffect * | graphicsEffect () const |
QGraphicsProxyWidget * | graphicsProxyWidget () const |
bool | hasEditFocus () const |
bool | hasFocus () const |
bool | hasMouse () const |
bool | hasMouseTracking () const |
int | height () const |
virtual int | heightForWidth (int w) const |
void | hide () |
const QPixmap * | icon () const |
void | iconify () |
QString | iconText () const |
QInputContext * | inputContext () |
Qt::InputMethodHints | inputMethodHints () const |
virtual QVariant | inputMethodQuery (Qt::InputMethodQuery query) const |
void | insertAction (QAction *before, QAction *action) |
void | insertActions (QAction *before, QList< QAction * > actions) |
bool | isActiveWindow () const |
bool | isAncestorOf (const QWidget *child) const |
bool | isDesktop () const |
bool | isDialog () const |
bool | isEnabled () const |
bool | isEnabledTo (QWidget *ancestor) const |
bool | isEnabledToTLW () const |
bool | isFullScreen () const |
bool | isHidden () const |
bool | isInputMethodEnabled () const |
bool | isMaximized () const |
bool | isMinimized () const |
bool | isModal () const |
bool | isPopup () const |
bool | isShown () const |
bool | isTopLevel () const |
bool | isUpdatesEnabled () const |
bool | isVisible () const |
bool | isVisibleTo (QWidget *ancestor) const |
bool | isVisibleToTLW () const |
bool | isWindow () const |
bool | isWindowModified () const |
QLayout * | layout () const |
Qt::LayoutDirection | layoutDirection () const |
QLocale | locale () const |
void | lower () |
Qt::HANDLE | macCGHandle () const |
Qt::HANDLE | macQDHandle () const |
QPoint | mapFrom (QWidget *parent, const QPoint &pos) const |
QPoint | mapFromGlobal (const QPoint &pos) const |
QPoint | mapFromParent (const QPoint &pos) const |
QPoint | mapTo (QWidget *parent, const QPoint &pos) const |
QPoint | mapToGlobal (const QPoint &pos) const |
QPoint | mapToParent (const QPoint &pos) const |
QRegion | mask () const |
int | maximumHeight () const |
QSize | maximumSize () const |
int | maximumWidth () const |
int | minimumHeight () const |
QSize | minimumSize () const |
virtual QSize | minimumSizeHint () const |
int | minimumWidth () const |
void | move (int x, int y) |
void | move (const QPoint &) |
QWidget * | nativeParentWidget () const |
QWidget * | nextInFocusChain () const |
QRect | normalGeometry () const |
void | overrideWindowFlags (QFlags< Qt::WindowType > flags) |
bool | ownCursor () const |
bool | ownFont () const |
bool | ownPalette () const |
virtual QPaintEngine * | paintEngine () const |
const QPalette & | palette () const |
QWidget * | parentWidget (bool sameWindow) const |
QWidget * | parentWidget () const |
QPlatformWindow * | platformWindow () const |
QPlatformWindowFormat | platformWindowFormat () const |
void | polish () |
QPoint | pos () const |
QWidget * | previousInFocusChain () const |
void | raise () |
void | recreate (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt) |
QRect | rect () const |
virtual void | releaseDC (HDC hdc) const |
void | releaseKeyboard () |
void | releaseMouse () |
void | releaseShortcut (int id) |
void | removeAction (QAction *action) |
void | render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags) |
void | render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags) |
void | repaint (int x, int y, int w, int h, bool b) |
void | repaint (const QRegion &rgn, bool b) |
void | repaint () |
void | repaint (int x, int y, int w, int h) |
void | repaint (const QRegion &rgn) |
void | repaint (bool b) |
void | repaint (const QRect &rect) |
void | repaint (const QRect &r, bool b) |
void | reparent (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt) |
void | reparent (QWidget *parent, const QPoint &p, bool showIt) |
void | resize (int w, int h) |
void | resize (const QSize &) |
bool | restoreGeometry (const QByteArray &geometry) |
QByteArray | saveGeometry () const |
void | scroll (int dx, int dy) |
void | scroll (int dx, int dy, const QRect &r) |
void | setAcceptDrops (bool on) |
void | setAccessibleDescription (const QString &description) |
void | setAccessibleName (const QString &name) |
void | setActiveWindow () |
void | setAttribute (Qt::WidgetAttribute attribute, bool on) |
void | setAutoFillBackground (bool enabled) |
void | setBackgroundColor (const QColor &color) |
void | setBackgroundMode (Qt::BackgroundMode widgetBackground, Qt::BackgroundMode paletteBackground) |
void | setBackgroundOrigin (BackgroundOrigin background) |
void | setBackgroundPixmap (const QPixmap &pixmap) |
void | setBackgroundRole (QPalette::ColorRole role) |
void | setBaseSize (const QSize &) |
void | setBaseSize (int basew, int baseh) |
void | setCaption (const QString &c) |
void | setContentsMargins (int left, int top, int right, int bottom) |
void | setContentsMargins (const QMargins &margins) |
void | setContextMenuPolicy (Qt::ContextMenuPolicy policy) |
void | setCursor (const QCursor &) |
void | setDisabled (bool disable) |
void | setEditFocus (bool enable) |
void | setEnabled (bool) |
void | setEraseColor (const QColor &color) |
void | setErasePixmap (const QPixmap &pixmap) |
void | setFixedHeight (int h) |
void | setFixedSize (const QSize &s) |
void | setFixedSize (int w, int h) |
void | setFixedWidth (int w) |
void | setFocus (Qt::FocusReason reason) |
void | setFocus () |
void | setFocusPolicy (Qt::FocusPolicy policy) |
void | setFocusProxy (QWidget *w) |
void | setFont (const QFont &) |
void | setFont (const QFont &f, bool b) |
void | setForegroundRole (QPalette::ColorRole role) |
void | setGeometry (int x, int y, int w, int h) |
void | setGeometry (const QRect &) |
void | setGraphicsEffect (QGraphicsEffect *effect) |
void | setHidden (bool hidden) |
void | setIcon (const QPixmap &i) |
void | setIconText (const QString &it) |
void | setInputContext (QInputContext *context) |
void | setInputMethodEnabled (bool enabled) |
void | setInputMethodHints (QFlags< Qt::InputMethodHint > hints) |
void | setKeyCompression (bool b) |
void | setLayout (QLayout *layout) |
void | setLayoutDirection (Qt::LayoutDirection direction) |
void | setLocale (const QLocale &locale) |
void | setMask (const QBitmap &bitmap) |
void | setMask (const QRegion ®ion) |
void | setMaximumHeight (int maxh) |
void | setMaximumSize (const QSize &) |
void | setMaximumSize (int maxw, int maxh) |
void | setMaximumWidth (int maxw) |
void | setMinimumHeight (int minh) |
void | setMinimumSize (int minw, int minh) |
void | setMinimumSize (const QSize &) |
void | setMinimumWidth (int minw) |
void | setMouseTracking (bool enable) |
void | setPalette (const QPalette &) |
void | setPalette (const QPalette &p, bool b) |
void | setPaletteBackgroundColor (const QColor &color) |
void | setPaletteBackgroundPixmap (const QPixmap &pixmap) |
void | setPaletteForegroundColor (const QColor &color) |
void | setParent (QWidget *parent) |
void | setParent (QWidget *parent, QFlags< Qt::WindowType > f) |
void | setPlatformWindow (QPlatformWindow *window) |
void | setPlatformWindowFormat (const QPlatformWindowFormat &format) |
void | setShortcutAutoRepeat (int id, bool enable) |
void | setShortcutEnabled (int id, bool enable) |
void | setShown (bool shown) |
void | setSizeIncrement (const QSize &) |
void | setSizeIncrement (int w, int h) |
void | setSizePolicy (QSizePolicy::Policy hor, QSizePolicy::Policy ver, bool hfw) |
void | setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical) |
void | setSizePolicy (QSizePolicy) |
void | setStatusTip (const QString &) |
void | setStyle (QStyle *style) |
QStyle * | setStyle (const QString &style) |
void | setStyleSheet (const QString &styleSheet) |
void | setToolTip (const QString &) |
void | setUpdatesEnabled (bool enable) |
void | setupUi (QWidget *widget) |
virtual void | setVisible (bool visible) |
void | setWhatsThis (const QString &) |
void | setWindowFilePath (const QString &filePath) |
void | setWindowFlags (QFlags< Qt::WindowType > type) |
void | setWindowIcon (const QIcon &icon) |
void | setWindowIconText (const QString &) |
void | setWindowModality (Qt::WindowModality windowModality) |
void | setWindowModified (bool) |
void | setWindowOpacity (qreal level) |
void | setWindowRole (const QString &role) |
void | setWindowState (QFlags< Qt::WindowState > windowState) |
void | setWindowSurface (QWindowSurface *surface) |
void | setWindowTitle (const QString &) |
void | show () |
void | showFullScreen () |
void | showMaximized () |
void | showMinimized () |
void | showNormal () |
QSize | size () const |
virtual QSize | sizeHint () const |
QSize | sizeIncrement () const |
QSizePolicy | sizePolicy () const |
void | stackUnder (QWidget *w) |
QString | statusTip () const |
QStyle * | style () const |
QString | styleSheet () const |
bool | testAttribute (Qt::WidgetAttribute attribute) const |
QString | toolTip () const |
QWidget * | topLevelWidget () const |
bool | underMouse () const |
void | ungrabGesture (Qt::GestureType gesture) |
void | unsetCursor () |
void | unsetFont () |
void | unsetLayoutDirection () |
void | unsetLocale () |
void | unsetPalette () |
void | update (const QRect &rect) |
void | update (const QRegion &rgn) |
void | update (int x, int y, int w, int h) |
void | update () |
void | updateGeometry () |
bool | updatesEnabled () const |
QRect | visibleRect () const |
QRegion | visibleRegion () const |
QString | whatsThis () const |
int | width () const |
QWidget * | window () const |
QString | windowFilePath () const |
Qt::WindowFlags | windowFlags () const |
QIcon | windowIcon () const |
QString | windowIconText () const |
Qt::WindowModality | windowModality () const |
qreal | windowOpacity () const |
QString | windowRole () const |
Qt::WindowStates | windowState () const |
QWindowSurface * | windowSurface () const |
QString | windowTitle () const |
Qt::WindowType | windowType () const |
WId | winId () const |
int | x () const |
const QX11Info & | x11Info () const |
Qt::HANDLE | x11PictureHandle () const |
int | y () const |
Public Member Functions inherited from QObject | |
QObject (QObject *parent) | |
QObject (QObject *parent, const char *name) | |
virtual | ~QObject () |
bool | blockSignals (bool block) |
QObject * | child (const char *objName, const char *inheritsClass, bool recursiveSearch) const |
const QObjectList & | children () const |
const char * | className () const |
bool | connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const |
void | deleteLater () |
void | destroyed (QObject *obj) |
bool | disconnect (const QObject *receiver, const char *method) |
bool | disconnect (const char *signal, const QObject *receiver, const char *method) |
void | dumpObjectInfo () |
void | dumpObjectTree () |
QList< QByteArray > | dynamicPropertyNames () const |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name) const |
QList< T > | findChildren (const QRegExp ®Exp) const |
QList< T > | findChildren (const QString &name) const |
bool | inherits (const char *className) const |
void | insertChild (QObject *object) |
void | installEventFilter (QObject *filterObj) |
bool | isA (const char *className) const |
bool | isWidgetType () const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const |
void | moveToThread (QThread *targetThread) |
const char * | name () const |
const char * | name (const char *defaultName) const |
QString | objectName () const |
QObject * | parent () const |
QVariant | property (const char *name) const |
void | removeChild (QObject *object) |
void | removeEventFilter (QObject *obj) |
void | setName (const char *name) |
void | setObjectName (const QString &name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | signalsBlocked () const |
int | startTimer (int interval) |
QThread * | thread () const |
Public Member Functions inherited from QPaintDevice | |
virtual | ~QPaintDevice () |
int | colorCount () const |
int | depth () const |
int | height () const |
int | heightMM () const |
int | logicalDpiX () const |
int | logicalDpiY () const |
int | numColors () const |
virtual QPaintEngine * | paintEngine () const =0 |
bool | paintingActive () const |
int | physicalDpiX () const |
int | physicalDpiY () const |
int | width () const |
int | widthMM () const |
int | x11Cells () const |
Qt::HANDLE | x11Colormap () const |
bool | x11DefaultColormap () const |
bool | x11DefaultVisual () const |
int | x11Depth () const |
Display * | x11Display () const |
int | x11Screen () const |
void * | x11Visual () const |
Additional Inherited Members | |
Static Public Member Functions inherited from QWidget | |
QWidget * | find (WId id) |
QWidget * | keyboardGrabber () |
QWidget * | mouseGrabber () |
void | setTabOrder (QWidget *first, QWidget *second) |
QWidgetMapper * | wmapper () |
Static Public Member Functions inherited from QObject | |
bool | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type) |
bool | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) |
bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method) |
bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
QString | trUtf8 (const char *sourceText, const char *disambiguation, int n) |
Static Public Member Functions inherited from QPaintDevice | |
int | x11AppCells (int screen) |
Qt::HANDLE | x11AppColormap (int screen) |
bool | x11AppDefaultColormap (int screen) |
bool | x11AppDefaultVisual (int screen) |
int | x11AppDepth (int screen) |
Display * | x11AppDisplay () |
int | x11AppDpiX (int screen) |
int | x11AppDpiY (int screen) |
Qt::HANDLE | x11AppRootWindow (int screen) |
int | x11AppScreen () |
void * | x11AppVisual (int screen) |
void | x11SetAppDpiX (int dpi, int screen) |
void | x11SetAppDpiY (int dpi, int screen) |
Public Attributes inherited from QWidget | |
typedef | RenderFlags |
Protected Member Functions inherited from QWidget | |
virtual void | actionEvent (QActionEvent *event) |
virtual void | changeEvent (QEvent *event) |
virtual void | closeEvent (QCloseEvent *event) |
virtual void | contextMenuEvent (QContextMenuEvent *event) |
void | create (WId window, bool initializeWindow, bool destroyOldWindow) |
void | destroy (bool destroyWindow, bool destroySubWindows) |
virtual void | dragEnterEvent (QDragEnterEvent *event) |
virtual void | dragLeaveEvent (QDragLeaveEvent *event) |
virtual void | dragMoveEvent (QDragMoveEvent *event) |
virtual void | dropEvent (QDropEvent *event) |
virtual void | enterEvent (QEvent *event) |
virtual bool | event (QEvent *event) |
virtual void | focusInEvent (QFocusEvent *event) |
bool | focusNextChild () |
virtual bool | focusNextPrevChild (bool next) |
virtual void | focusOutEvent (QFocusEvent *event) |
bool | focusPreviousChild () |
virtual void | hideEvent (QHideEvent *event) |
virtual void | inputMethodEvent (QInputMethodEvent *event) |
virtual void | keyPressEvent (QKeyEvent *event) |
virtual void | keyReleaseEvent (QKeyEvent *event) |
virtual void | languageChange () |
virtual void | leaveEvent (QEvent *event) |
virtual bool | macEvent (EventHandlerCallRef caller, EventRef event) |
virtual int | metric (PaintDeviceMetric m) const |
virtual void | mouseDoubleClickEvent (QMouseEvent *event) |
virtual void | mouseMoveEvent (QMouseEvent *event) |
virtual void | mousePressEvent (QMouseEvent *event) |
virtual void | mouseReleaseEvent (QMouseEvent *event) |
virtual void | moveEvent (QMoveEvent *event) |
virtual void | paintEvent (QPaintEvent *event) |
virtual bool | qwsEvent (QWSEvent *event) |
void | resetInputContext () |
virtual void | resizeEvent (QResizeEvent *event) |
virtual void | showEvent (QShowEvent *event) |
virtual void | tabletEvent (QTabletEvent *event) |
void | updateMicroFocus () |
virtual void | wheelEvent (QWheelEvent *event) |
virtual bool | winEvent (MSG *message, long *result) |
virtual bool | x11Event (XEvent *event) |
Protected Member Functions inherited from QObject | |
bool | checkConnectArgs (const char *signal, const QObject *object, const char *method) |
virtual void | childEvent (QChildEvent *event) |
virtual void | connectNotify (const char *signal) |
virtual void | customEvent (QEvent *event) |
virtual void | disconnectNotify (const char *signal) |
int | receivers (const char *signal) const |
QObject * | sender () const |
int | senderSignalIndex () const |
virtual void | timerEvent (QTimerEvent *event) |
Protected Member Functions inherited from QPaintDevice | |
QPaintDevice () | |
Static Protected Member Functions inherited from QObject | |
QByteArray | normalizeSignalSlot (const char *signalSlot) |
Properties inherited from QWidget | |
acceptDrops | |
accessibleDescription | |
accessibleName | |
autoFillBackground | |
baseSize | |
childrenRect | |
childrenRegion | |
contextMenuPolicy | |
cursor | |
enabled | |
focus | |
focusPolicy | |
font | |
frameGeometry | |
frameSize | |
fullScreen | |
geometry | |
height | |
inputMethodHints | |
isActiveWindow | |
layoutDirection | |
locale | |
maximized | |
maximumHeight | |
maximumSize | |
maximumWidth | |
minimized | |
minimumHeight | |
minimumSize | |
minimumSizeHint | |
minimumWidth | |
modal | |
mouseTracking | |
normalGeometry | |
palette | |
pos | |
rect | |
size | |
sizeHint | |
sizeIncrement | |
sizePolicy | |
statusTip | |
styleSheet | |
toolTip | |
updatesEnabled | |
visible | |
whatsThis | |
width | |
windowFilePath | |
windowFlags | |
windowIcon | |
windowIconText | |
windowModality | |
windowModified | |
windowOpacity | |
windowTitle | |
x | |
y | |
Properties inherited from QObject | |
objectName | |
Detailed Description
This class provides the widget containing the scan options and the preview.
Member Enumeration Documentation
This enumeration describes the type of the returned data.
The number of formats might grow, so it is wise to be prepared fro more.
- Note
- There might come more enumerations in the future.
Constructor & Destructor Documentation
KSaneIface::KSaneWidget::KSaneWidget | ( | QWidget * | parent = 0 | ) |
This constructor initializes the private class variables, but the widget is left empty.
The options and the preview are added with the call to openDevice().
Definition at line 69 of file ksane_widget.cpp.
KSaneIface::KSaneWidget::~KSaneWidget | ( | ) |
Standard destructor.
Definition at line 245 of file ksane_widget.cpp.
Member Function Documentation
|
signal |
This signal is emitted every time the device list is updated or after initGetDeviceList() is called.
- Parameters
-
deviceList is a QList of KSaneWidget::DeviceInfo that contain the device name, model, vendor and type of the attached scanners.
- Note
- The list is only a snapshot of the current available devices. Devices might be added or removed/opened after the signal is emitted.
|
signal |
This Signal is emitted when a hardware button is pressed.
- Parameters
-
optionName is the untranslated technical name of the sane-option. optionLabel is the translated user visible label of the sane-option. pressed indicates if the value is true or false.
- Note
- The SANE standard does not specify hardware buttons and their behaviors, so this signal is emitted for sane-options that behave like hardware buttons. That is the sane-options are read-only and type boolean. The naming of hardware buttons also differ from backend to backend.
bool KSaneIface::KSaneWidget::closeDevice | ( | ) |
This method closes the currently open scanner device.
- Returns
- 'true' if all goes well and 'false' if no device is open.
Definition at line 505 of file ksane_widget.cpp.
float KSaneIface::KSaneWidget::currentDPI | ( | ) |
This method returns the current resolution of the acquired image, in dots per inch.
- Note
- This function should be called from the slot connected to the imageReady signal. The connection should not be queued.
- Returns
- the resolution used for scanning or 0.0 on failure.
Definition at line 825 of file ksane_widget.cpp.
void KSaneIface::KSaneWidget::enableAutoSelect | ( | bool | enable | ) |
This function can be used to enable/disable automatic selections on previews.
The default state is enabled.
- Parameters
-
enable specifies if the auto selection should be turned on or off.
Definition at line 820 of file ksane_widget.cpp.
This function reads one parameter value into a string.
- Parameters
-
optname is the name of the parameter to read. value is the string representation of the value.
- Returns
- this function returns true if the read was successful.
Definition at line 684 of file ksane_widget.cpp.
This method reads the available parameters and their values and returns them in a QMap (Name, value)
- Parameters
-
opts is a QMap with the parameter names and values.
Definition at line 668 of file ksane_widget.cpp.
|
signal |
This Signal is emitted when a final scan is ready.
- Parameters
-
data is the byte data containing the image. width is the width of the image in pixels. height is the height of the image in pixels. bytes_per_line is the number of bytes used per line. This might include padding and is probably only relevant for 'FormatBlackWhite'. format is the KSane image format of the data.
void KSaneIface::KSaneWidget::initGetDeviceList | ( | ) | const |
Get the list of available scanning devices.
Connect to availableDevices() which is fired once these devices are known.
Definition at line 297 of file ksane_widget.cpp.
QString KSaneIface::KSaneWidget::make | ( | ) | const |
This method returns the make name of the scanner.
Definition at line 271 of file ksane_widget.cpp.
KDE_DEPRECATED bool KSaneIface::KSaneWidget::makeQImage | ( | const QByteArray & | , |
int | , | ||
int | , | ||
int | , | ||
ImageFormat | , | ||
QImage & | |||
) |
QString KSaneIface::KSaneWidget::model | ( | ) | const |
This methos returns the model of the scanner.
Definition at line 275 of file ksane_widget.cpp.
bool KSaneIface::KSaneWidget::openDevice | ( | const QString & | device_name | ) |
This method opens the specified scanner device and adds the scan options to the KSane widget.
- Parameters
-
device_name is the libsane device name for the scanner to open.
- Returns
- 'true' if all goes well and 'false' if the specified scanner can not be opened.
Definition at line 310 of file ksane_widget.cpp.
float KSaneIface::KSaneWidget::scanAreaHeight | ( | ) |
This method returns the scan area's height in mm.
- Returns
- Height of the scannable area in mm
Definition at line 851 of file ksane_widget.cpp.
float KSaneIface::KSaneWidget::scanAreaWidth | ( | ) |
This method returns the scan area's width in mm.
- Returns
- Width of the scannable area in mm
Definition at line 836 of file ksane_widget.cpp.
|
slot |
This method can be used to cancel a scan or prevent an automatic new scan.
Definition at line 652 of file ksane_widget.cpp.
|
signal |
This signal is emitted when the scanning has ended.
- Parameters
-
status contains a ScanStatus status code. strStatus If an error has occurred this string will contain an error message. otherwise the string is empty.
|
slot |
This method can be used to start a scan (if no GUI is needed).
- Note
- libksane may return one or more images as a result of one invocation of this slot. If no more images are wanted scanCancel should be called in the slot handling the imageReady signal.
Definition at line 641 of file ksane_widget.cpp.
|
signal |
This Signal is emitted for progress information during a scan.
The GUI already has a progress bar, but if the GUI is hidden, this can be used to display a progress bar.
- Parameters
-
percent is the percentage of the scan progress (0-100).
This helper method displays a dialog for selecting a scanner.
The libsane device name of the selected scanner device is returned.
Definition at line 284 of file ksane_widget.cpp.
void KSaneIface::KSaneWidget::setOptionsCollapsed | ( | bool | collapse | ) |
This function is used to programatically collapse/restore the options.
- Parameters
-
collapse defines the state to set.
Definition at line 916 of file ksane_widget.cpp.
This function writes one parameter value into a string.
- Parameters
-
optname is the name of the parameter to write. value is the string representation of the value.
- Returns
- this function returns true if the write was successful.
Definition at line 751 of file ksane_widget.cpp.
This method can be used to write many parameter values at once.
- Parameters
-
opts is a QMap with the parameter names and values.
- Returns
- This function returns the number of successful writes.
Definition at line 699 of file ksane_widget.cpp.
void KSaneIface::KSaneWidget::setPreviewButtonText | ( | const QString & | previewLabel | ) |
This function sets the label on the preview button.
- Parameters
-
previewLabel is the new label for the button.
Definition at line 811 of file ksane_widget.cpp.
void KSaneIface::KSaneWidget::setPreviewResolution | ( | float | dpi | ) |
This function is used to set the preferred resolution for scanning the preview.
- Parameters
-
dpi is the wanted scan resolution for the preview
- Note
- if the set value is not supported, the cloasest one is used
- setting the value 0 means that the default calculated value should be used
Definition at line 663 of file ksane_widget.cpp.
void KSaneIface::KSaneWidget::setScanButtonHidden | ( | bool | hidden | ) |
This function is used hide/show the final scan button.
- Parameters
-
hidden defines the state to set.
Definition at line 926 of file ksane_widget.cpp.
void KSaneIface::KSaneWidget::setScanButtonText | ( | const QString & | scanLabel | ) |
This function sets the label on the final scan button.
- Parameters
-
scanLabel is the new label for the button.
Definition at line 802 of file ksane_widget.cpp.
This method sets the selection according to the given points.
- Note
- The points are defined with respect to the scan areas top-left corner in mm
- Parameters
-
topLeft Upper left corner of the selection (in mm) bottomRight Lower right corner of the selection (in mm)
Definition at line 866 of file ksane_widget.cpp.
QImage KSaneIface::KSaneWidget::toQImage | ( | const QByteArray & | data, |
int | width, | ||
int | height, | ||
int | bytes_per_line, | ||
ImageFormat | format | ||
) |
This is a convenience method that can be used to create a QImage from the image data returned by the imageReady(...) signal.
- Note
- : If the image data has 16 bits/color the * data is truncated to 8 bits/color since QImage does not support 16 bits/color. A warning message will be shown.
- Parameters
-
data is the byte data containing the image. width is the width of the image in pixels. height is the height of the image in pixels. bytes_per_line is the number of bytes used per line. This might include padding and is probably only relevant for 'FormatBlackWhite'. format is the KSane image format of the data.
- Returns
- This function returns the provided image data as a QImage.
Definition at line 627 of file ksane_widget.cpp.
QImage KSaneIface::KSaneWidget::toQImageSilent | ( | const QByteArray & | data, |
int | width, | ||
int | height, | ||
int | bytes_per_line, | ||
ImageFormat | format | ||
) |
This is a convenience method that can be used to create a QImage from the image data returned by the imageReady(...) signal.
- Note
- : If the image data has 16 bits/color the * data is truncated to 8 bits/color, but unlike toQImage() this function will not give a warning.
- Parameters
-
data is the byte data containing the image. width is the width of the image in pixels. height is the height of the image in pixels. bytes_per_line is the number of bytes used per line. This might include padding and is probably only relevant for 'FormatBlackWhite'. format is the KSane image format of the data.
- Returns
- This function returns the provided image data as a QImage.
Definition at line 539 of file ksane_widget.cpp.
|
signal |
This signal is emitted when the user is to be notified about something.
- Note
- If no slot is connected to this signal the message will be displayed in a KMessageBox.
- Parameters
-
type contains a ScanStatus code to identify the type of message (error/info/...). msg is the message to the user. otherwise the string is empty.
QString KSaneIface::KSaneWidget::vendor | ( | ) | const |
This method returns the vendor name of the scanner (Same as make).
Definition at line 263 of file ksane_widget.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:19:47 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.