KSaneIface::KSaneWidget

#include <ksanewidget.h>

Inheritance diagram for KSaneIface::KSaneWidget:

Public Types

enum  ImageFormat {
  FormatBlackWhite, FormatGrayScale8, FormatGrayScale16, FormatRGB_8_C,
  FormatRGB_16_C, FormatBMP, FormatNone = 0xFFFF
}
 
enum  ScanStatus { NoError, ErrorCannotSegment, ErrorGeneral, Information }
 
- Public Types inherited from QWidget
enum  RenderFlag
 
- Public Types inherited from QPaintDevice
enum  PaintDeviceMetric
 

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 Slots

void scanCancel ()
 
void scanFinal ()
 
void startPreviewScan ()
 

Public Member Functions

 KSaneWidget (QWidget *parent=nullptr)
 
 ~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
 
KSANE_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=nullptr)
 
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, Qt::WindowFlags f)
 
bool acceptDrops () const const
 
QString accessibleDescription () const const
 
QString accessibleName () const const
 
QList< QAction * > actions () const const
 
void activateWindow ()
 
void addAction (QAction *action)
 
void addActions (QList< QAction * > actions)
 
void adjustSize ()
 
bool autoFillBackground () const const
 
QPalette::ColorRole backgroundRole () const const
 
QBackingStorebackingStore () const const
 
QSize baseSize () const const
 
QWidgetchildAt (int x, int y) const const
 
QWidgetchildAt (const QPoint &p) const const
 
QRect childrenRect () const const
 
QRegion childrenRegion () const const
 
void clearFocus ()
 
void clearMask ()
 
bool close ()
 
QMargins contentsMargins () const const
 
QRect contentsRect () const const
 
Qt::ContextMenuPolicy contextMenuPolicy () const const
 
QCursor cursor () const const
 
void customContextMenuRequested (const QPoint &pos)
 
WId effectiveWinId () const const
 
void ensurePolished () const const
 
Qt::FocusPolicy focusPolicy () const const
 
QWidgetfocusProxy () const const
 
QWidgetfocusWidget () const const
 
const QFontfont () const const
 
QFontInfo fontInfo () const const
 
QFontMetrics fontMetrics () const const
 
QPalette::ColorRole foregroundRole () const const
 
QRect frameGeometry () const const
 
QSize frameSize () const const
 
const QRectgeometry () const const
 
void getContentsMargins (int *left, int *top, int *right, int *bottom) const const
 
QPixmap grab (const QRect &rectangle)
 
void grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags)
 
void grabKeyboard ()
 
void grabMouse ()
 
void grabMouse (const QCursor &cursor)
 
int grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)
 
QGraphicsEffectgraphicsEffect () const const
 
QGraphicsProxyWidgetgraphicsProxyWidget () const const
 
bool hasEditFocus () const const
 
bool hasFocus () const const
 
virtual bool hasHeightForWidth () const const
 
bool hasMouseTracking () const const
 
bool hasTabletTracking () const const
 
int height () const const
 
virtual int heightForWidth (int w) const const
 
void hide ()
 
Qt::InputMethodHints inputMethodHints () const const
 
virtual QVariant inputMethodQuery (Qt::InputMethodQuery query) const const
 
void insertAction (QAction *before, QAction *action)
 
void insertActions (QAction *before, QList< QAction * > actions)
 
bool isActiveWindow () const const
 
bool isAncestorOf (const QWidget *child) const const
 
bool isEnabled () const const
 
bool isEnabledTo (const QWidget *ancestor) const const
 
bool isEnabledToTLW () const const
 
bool isFullScreen () const const
 
bool isHidden () const const
 
bool isMaximized () const const
 
bool isMinimized () const const
 
bool isModal () const const
 
bool isTopLevel () const const
 
bool isVisible () const const
 
bool isVisibleTo (const QWidget *ancestor) const const
 
bool isWindow () const const
 
bool isWindowModified () const const
 
QLayoutlayout () const const
 
Qt::LayoutDirection layoutDirection () const const
 
QLocale locale () const const
 
void lower ()
 
QPoint mapFrom (const QWidget *parent, const QPoint &pos) const const
 
QPoint mapFromGlobal (const QPoint &pos) const const
 
QPoint mapFromParent (const QPoint &pos) const const
 
QPoint mapTo (const QWidget *parent, const QPoint &pos) const const
 
QPoint mapToGlobal (const QPoint &pos) const const
 
QPoint mapToParent (const QPoint &pos) const const
 
QRegion mask () const const
 
int maximumHeight () const const
 
QSize maximumSize () const const
 
int maximumWidth () const const
 
int minimumHeight () const const
 
QSize minimumSize () const const
 
virtual QSize minimumSizeHint () const const
 
int minimumWidth () const const
 
void move (int x, int y)
 
void move (const QPoint &)
 
QWidgetnativeParentWidget () const const
 
QWidgetnextInFocusChain () const const
 
QRect normalGeometry () const const
 
void overrideWindowFlags (Qt::WindowFlags flags)
 
virtual QPaintEnginepaintEngine () const const override
 
const QPalettepalette () const const
 
QWidgetparentWidget () const const
 
QPoint pos () const const
 
QWidgetpreviousInFocusChain () const const
 
 QWIDGETSIZE_MAX QWIDGETSIZE_MAX
 
void raise ()
 
QRect rect () const const
 
void releaseKeyboard ()
 
void releaseMouse ()
 
void releaseShortcut (int id)
 
void removeAction (QAction *action)
 
void render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)
 
void render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)
 
void repaint ()
 
void repaint (int x, int y, int w, int h)
 
void repaint (const QRect &rect)
 
void repaint (const QRegion &rgn)
 
void resize (int w, int h)
 
void resize (const QSize &)
 
bool restoreGeometry (const QByteArray &geometry)
 
QByteArray saveGeometry () const const
 
QScreenscreen () const 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 setAttribute (Qt::WidgetAttribute attribute, bool on)
 
void setAutoFillBackground (bool enabled)
 
void setBackgroundRole (QPalette::ColorRole role)
 
void setBaseSize (int basew, int baseh)
 
void setBaseSize (const QSize &)
 
void setContentsMargins (const QMargins &margins)
 
void setContentsMargins (int left, int top, int right, int bottom)
 
void setContextMenuPolicy (Qt::ContextMenuPolicy policy)
 
void setCursor (const QCursor &)
 
void setDisabled (bool disable)
 
void setEditFocus (bool enable)
 
void setEnabled (bool)
 
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 setForegroundRole (QPalette::ColorRole role)
 
void setGeometry (const QRect &)
 
void setGeometry (int x, int y, int w, int h)
 
void setGraphicsEffect (QGraphicsEffect *effect)
 
void setHidden (bool hidden)
 
void setInputMethodHints (Qt::InputMethodHints hints)
 
void setLayout (QLayout *layout)
 
void setLayoutDirection (Qt::LayoutDirection direction)
 
void setLocale (const QLocale &locale)
 
void setMask (const QBitmap &bitmap)
 
void setMask (const QRegion &region)
 
void setMaximumHeight (int maxh)
 
void setMaximumSize (int maxw, int maxh)
 
void setMaximumSize (const QSize &)
 
void setMaximumWidth (int maxw)
 
void setMinimumHeight (int minh)
 
void setMinimumSize (const QSize &)
 
void setMinimumSize (int minw, int minh)
 
void setMinimumWidth (int minw)
 
void setMouseTracking (bool enable)
 
void setPalette (const QPalette &)
 
void setParent (QWidget *parent, Qt::WindowFlags f)
 
void setParent (QWidget *parent)
 
void setShortcutAutoRepeat (int id, bool enable)
 
void setShortcutEnabled (int id, bool enable)
 
void setSizeIncrement (const QSize &)
 
void setSizeIncrement (int w, int h)
 
void setSizePolicy (QSizePolicy)
 
void setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
 
void setStatusTip (const QString &)
 
void setStyle (QStyle *style)
 
void setStyleSheet (const QString &styleSheet)
 
void setTabletTracking (bool enable)
 
void setToolTip (const QString &)
 
void setToolTipDuration (int msec)
 
void setUpdatesEnabled (bool enable)
 
void setupUi (QWidget *widget)
 
virtual void setVisible (bool visible)
 
void setWhatsThis (const QString &)
 
void setWindowFilePath (const QString &filePath)
 
void setWindowFlag (Qt::WindowType flag, bool on)
 
void setWindowFlags (Qt::WindowFlags 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 (Qt::WindowStates windowState)
 
void setWindowTitle (const QString &)
 
void show ()
 
void showFullScreen ()
 
void showMaximized ()
 
void showMinimized ()
 
void showNormal ()
 
QSize size () const const
 
virtual QSize sizeHint () const const
 
QSize sizeIncrement () const const
 
QSizePolicy sizePolicy () const const
 
void stackUnder (QWidget *w)
 
QString statusTip () const const
 
QStylestyle () const const
 
QString styleSheet () const const
 
bool testAttribute (Qt::WidgetAttribute attribute) const const
 
QString toolTip () const const
 
int toolTipDuration () const const
 
QWidgettopLevelWidget () const const
 
bool underMouse () const const
 
void ungrabGesture (Qt::GestureType gesture)
 
void unsetCursor ()
 
void unsetLayoutDirection ()
 
void unsetLocale ()
 
void update (int x, int y, int w, int h)
 
void update (const QRect &rect)
 
void update (const QRegion &rgn)
 
void update ()
 
void updateGeometry ()
 
bool updatesEnabled () const const
 
QRegion visibleRegion () const const
 
QString whatsThis () const const
 
int width () const const
 
QWidgetwindow () const const
 
QString windowFilePath () const const
 
Qt::WindowFlags windowFlags () const const
 
QWindowwindowHandle () const const
 
QIcon windowIcon () const const
 
void windowIconChanged (const QIcon &icon)
 
QString windowIconText () const const
 
void windowIconTextChanged (const QString &iconText)
 
Qt::WindowModality windowModality () const const
 
qreal windowOpacity () const const
 
QString windowRole () const const
 
Qt::WindowStates windowState () const const
 
QString windowTitle () const const
 
void windowTitleChanged (const QString &title)
 
Qt::WindowType windowType () const const
 
WId winId () const const
 
int x () const const
 
int y () const const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 
- Public Member Functions inherited from QPaintDevice
int colorCount () const const
 
int depth () const const
 
int devicePixelRatio () const const
 
qreal devicePixelRatioF () const const
 
int height () const const
 
int heightMM () const const
 
int logicalDpiX () const const
 
int logicalDpiY () const const
 
bool paintingActive () const const
 
int physicalDpiX () const const
 
int physicalDpiY () const const
 
int width () const const
 
int widthMM () const const
 

Static Public Member Functions

static QImage toQImageSilent (const QByteArray &data, int width, int height, int bytes_per_line, int dpi, ImageFormat format)
 
- Static Public Member Functions inherited from QWidget
QWidgetcreateWindowContainer (QWindow *window, QWidget *parent, Qt::WindowFlags flags)
 
QWidgetfind (WId id)
 
QWidgetkeyboardGrabber ()
 
QWidgetmouseGrabber ()
 
void setTabOrder (QWidget *first, QWidget *second)
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction 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)
 

Additional Inherited Members

- 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
 
 tabletTracking
 
 toolTip
 
 toolTipDuration
 
 updatesEnabled
 
 visible
 
 whatsThis
 
 width
 
 windowFilePath
 
 windowFlags
 
 windowIcon
 
 windowIconText
 
 windowModality
 
 windowModified
 
 windowOpacity
 
 windowTitle
 
 x
 
 y
 
- Properties inherited from QObject
 objectName
 
- Public Attributes inherited from QWidget
 DrawChildren
 
 DrawWindowBackground
 
 IgnoreMask
 
typedef RenderFlags
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Public Attributes inherited from QPaintDevice
 PdmDepth
 
 PdmDevicePixelRatio
 
 PdmDevicePixelRatioScaled
 
 PdmDpiX
 
 PdmDpiY
 
 PdmHeight
 
 PdmHeightMM
 
 PdmNumColors
 
 PdmPhysicalDpiX
 
 PdmPhysicalDpiY
 
 PdmWidth
 
 PdmWidthMM
 
- 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) override
 
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 initPainter (QPainter *painter) const const override
 
virtual void inputMethodEvent (QInputMethodEvent *event)
 
virtual void keyPressEvent (QKeyEvent *event)
 
virtual void keyReleaseEvent (QKeyEvent *event)
 
virtual void leaveEvent (QEvent *event)
 
virtual int metric (QPaintDevice::PaintDeviceMetric m) const const override
 
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 bool nativeEvent (const QByteArray &eventType, void *message, long *result)
 
virtual void paintEvent (QPaintEvent *event)
 
virtual void resizeEvent (QResizeEvent *event)
 
virtual void showEvent (QShowEvent *event)
 
virtual void tabletEvent (QTabletEvent *event)
 
void updateMicroFocus ()
 
virtual void wheelEvent (QWheelEvent *event)
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

This class provides the widget containing the scan options and the preview.

Author
Kare Sars kare.[email protected]sars[email protected]@iki.[email protected]fi

Definition at line 47 of file ksanewidget.h.

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.

Enumerator
FormatBlackWhite 

One bit per pixel 1 = black 0 = white.

FormatGrayScale8 

Grayscale with one byte per pixel 0 = black 255 = white.

FormatGrayScale16 

Grayscale withtTwo bytes per pixel.

The byte order is the one provided by libsane.

FormatRGB_8_C 

Every pixel consists of three colors in the order Read, Grean and Blue, with one byte per color (no alpha channel).

FormatRGB_16_C 

Every pixel consists of three colors in the order Read, Grean and Blue, with two bytes per color(no alpha channel).

The byte order is the one provided by libsane.

FormatBMP 

The image data is returned as a BMP.

FormatNone 

This enumeration value should never be returned to the user.

Definition at line 55 of file ksanewidget.h.

Note
There might come more enumerations in the future.
Enumerator
NoError 

The scanning was finished successfully.

ErrorCannotSegment 

If this error status is returned libksane can not segment the returned data.

Scanning without segmentation should work.

Note
segmentation is not implemented yet.
ErrorGeneral 

The error string should contain an error message.

Information 

There is some information to the user.

Definition at line 70 of file ksanewidget.h.

Constructor & Destructor Documentation

KSaneIface::KSaneWidget::KSaneWidget ( QWidget parent = nullptr)

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 71 of file ksanewidget.cpp.

KSaneIface::KSaneWidget::~KSaneWidget ( )

Standard destructor.

Definition at line 249 of file ksanewidget.cpp.

Member Function Documentation

void KSaneIface::KSaneWidget::availableDevices ( const QList< KSaneWidget::DeviceInfo > &  deviceList)
signal

This signal is emitted every time the device list is updated or after initGetDeviceList() is called.

Parameters
deviceListis 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.
void KSaneIface::KSaneWidget::buttonPressed ( const QString optionName,
const QString optionLabel,
bool  pressed 
)
signal

This Signal is emitted when a hardware button is pressed.

Parameters
optionNameis the untranslated technical name of the sane-option.
optionLabelis the translated user visible label of the sane-option.
pressedindicates 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 519 of file ksanewidget.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 884 of file ksanewidget.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
enablespecifies if the auto selection should be turned on or off.

Definition at line 879 of file ksanewidget.cpp.

bool KSaneIface::KSaneWidget::getOptVal ( const QString optname,
QString value 
)

This function reads one parameter value into a string.

Parameters
optnameis the name of the parameter to read.
valueis the string representation of the value.
Returns
this function returns true if the read was successful.

Definition at line 713 of file ksanewidget.cpp.

void KSaneIface::KSaneWidget::getOptVals ( QMap< QString, QString > &  opts)

This method reads the available parameters and their values and returns them in a QMap (Name, value)

Parameters
optsis a QMap with the parameter names and values.

Definition at line 697 of file ksanewidget.cpp.

void KSaneIface::KSaneWidget::imageReady ( QByteArray data,
int  width,
int  height,
int  bytes_per_line,
int  format 
)
signal

This Signal is emitted when a final scan is ready.

Parameters
datais the byte data containing the image.
widthis the width of the image in pixels.
heightis the height of the image in pixels.
bytes_per_lineis the number of bytes used per line. This might include padding and is probably only relevant for 'FormatBlackWhite'.
formatis 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 307 of file ksanewidget.cpp.

QString KSaneIface::KSaneWidget::make ( ) const

This method returns the make name of the scanner.

Definition at line 277 of file ksanewidget.cpp.

QString KSaneIface::KSaneWidget::model ( ) const

This method returns the model of the scanner.

Definition at line 281 of file ksanewidget.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_nameis 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 319 of file ksanewidget.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 914 of file ksanewidget.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 895 of file ksanewidget.cpp.

void KSaneIface::KSaneWidget::scanCancel ( )
slot

This method can be used to cancel a scan or prevent an automatic new scan.

Definition at line 680 of file ksanewidget.cpp.

void KSaneIface::KSaneWidget::scanDone ( int  status,
const QString strStatus 
)
signal

This signal is emitted when the scanning has ended.

Parameters
statuscontains a ScanStatus status code.
strStatusIf an error has occurred this string will contain an error message. otherwise the string is empty.
void KSaneIface::KSaneWidget::scanFinal ( )
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 660 of file ksanewidget.cpp.

void KSaneIface::KSaneWidget::scanProgress ( int  percent)
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
percentis the percentage of the scan progress (0-100).
QString KSaneIface::KSaneWidget::selectDevice ( QWidget parent = nullptr)

This helper method displays a dialog for selecting a scanner.

The libsane device name of the selected scanner device is returned.

Definition at line 290 of file ksanewidget.cpp.

void KSaneIface::KSaneWidget::setOptionsCollapsed ( bool  collapse)

This function is used to programatically collapse/restore the options.

Parameters
collapsedefines the state to set.

Definition at line 951 of file ksanewidget.cpp.

bool KSaneIface::KSaneWidget::setOptVal ( const QString optname,
const QString value 
)

This function writes one parameter value into a string.

Parameters
optnameis the name of the parameter to write.
valueis the string representation of the value.
Returns
this function returns true if the write was successful and false if it was unsuccessful or scanning is in progress.

Definition at line 809 of file ksanewidget.cpp.

int KSaneIface::KSaneWidget::setOptVals ( const QMap< QString, QString > &  opts)

This method can be used to write many parameter values at once.

Parameters
optsis a QMap with the parameter names and values.
Returns
This function returns the number of successful writes or -1 if scanning is in progress.

Definition at line 728 of file ksanewidget.cpp.

void KSaneIface::KSaneWidget::setPreviewButtonText ( const QString previewLabel)

This function sets the label on the preview button.

Parameters
previewLabelis the new label for the button.

Definition at line 870 of file ksanewidget.cpp.

void KSaneIface::KSaneWidget::setPreviewResolution ( float  dpi)

This function is used to set the preferred resolution for scanning the preview.

Parameters
dpiis 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 692 of file ksanewidget.cpp.

void KSaneIface::KSaneWidget::setScanButtonHidden ( bool  hidden)

This function is used hide/show the final scan button.

Parameters
hiddendefines the state to set.

Definition at line 960 of file ksanewidget.cpp.

void KSaneIface::KSaneWidget::setScanButtonText ( const QString scanLabel)

This function sets the label on the final scan button.

Parameters
scanLabelis the new label for the button.

Definition at line 861 of file ksanewidget.cpp.

void KSaneIface::KSaneWidget::setSelection ( QPointF  topLeft,
QPointF  bottomRight 
)

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
topLeftUpper left corner of the selection (in mm)
bottomRightLower right corner of the selection (in mm)

Definition at line 933 of file ksanewidget.cpp.

void KSaneIface::KSaneWidget::startPreviewScan ( )
slot

This method can be used to start a preview scan.

Definition at line 670 of file ksanewidget.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
datais the byte data containing the image.
widthis the width of the image in pixels.
heightis the height of the image in pixels.
bytes_per_lineis the number of bytes used per line. This might include padding and is probably only relevant for 'FormatBlackWhite'.
formatis the KSane image format of the data.
Returns
This function returns the provided image data as a QImage.

Definition at line 646 of file ksanewidget.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
datais the byte data containing the image.
widthis the width of the image in pixels.
heightis the height of the image in pixels.
bytes_per_lineis the number of bytes used per line. This might include padding and is probably only relevant for 'FormatBlackWhite'.
formatis the KSane image format of the data.
Returns
This function returns the provided image data as a QImage.

Definition at line 553 of file ksanewidget.cpp.

QImage KSaneIface::KSaneWidget::toQImageSilent ( const QByteArray data,
int  width,
int  height,
int  bytes_per_line,
int  dpi,
ImageFormat  format 
)
static

This is a static version of toQImageSilent() method that requires dpi as additional argument.

Non-static version uses currentDPI() for it.

Parameters
datais the byte data containing the image.
widthis the width of the image in pixels.
heightis the height of the image in pixels.
bytes_per_lineis the number of bytes used per line. This might include padding and is probably only relevant for 'FormatBlackWhite'.
formatis the KSane image format of the data.
dpiis the dpi value of the image.
Returns
This function returns the provided image data as a QImage.

Definition at line 562 of file ksanewidget.cpp.

void KSaneIface::KSaneWidget::userMessage ( int  type,
const QString strStatus 
)
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
typecontains a ScanStatus code to identify the type of message (error/info/...).
strStatusIf an error has occurred this string will contain an error message. 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 269 of file ksanewidget.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Thu Nov 26 2020 22:34:40 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.