KIO
#include <kscan.h>

Signals | |
void | finalImage (const QImage &img, int id) |
void | preview (const QImage &img, int id) |
void | textRecognized (const QString &text, int id) |
![]() | |
void | currentPageChanged (KPageWidgetItem *current, KPageWidgetItem *before) |
void | pageRemoved (KPageWidgetItem *page) |
![]() | |
void | aboutToShowDetails () |
void | applyClicked () |
void | buttonClicked (KDialog::ButtonCode button) |
void | cancelClicked () |
void | closeClicked () |
void | defaultClicked () |
void | finished () |
void | helpClicked () |
void | hidden () |
void | layoutHintChanged () |
void | noClicked () |
void | okClicked () |
void | resetClicked () |
void | tryClicked () |
void | user1Clicked () |
void | user2Clicked () |
void | user3Clicked () |
void | yesClicked () |
Public Member Functions | |
~KScanDialog () | |
virtual bool | setup () |
![]() | |
KPageDialog (QWidget *parent=0, Qt::WindowFlags flags=0) | |
~KPageDialog () | |
void | addPage (KPageWidgetItem *item) |
KPageWidgetItem * | addPage (QWidget *widget, const QString &name) |
void | addSubPage (KPageWidgetItem *parent, KPageWidgetItem *item) |
KPageWidgetItem * | addSubPage (KPageWidgetItem *parent, QWidget *widget, const QString &name) |
KPageWidgetItem * | currentPage () const |
void | insertPage (KPageWidgetItem *before, KPageWidgetItem *item) |
KPageWidgetItem * | insertPage (KPageWidgetItem *before, QWidget *widget, const QString &name) |
void | removePage (KPageWidgetItem *item) |
void | setCurrentPage (KPageWidgetItem *item) |
void | setFaceType (FaceType faceType) |
![]() | |
KDialog (QWidget *parent=0, Qt::WindowFlags flags=0) | |
~KDialog () | |
KPushButton * | button (ButtonCode id) const |
KIcon | buttonIcon (ButtonCode id) const |
QString | buttonText (ButtonCode id) const |
QString | buttonToolTip (ButtonCode id) const |
QString | buttonWhatsThis (ButtonCode id) const |
ButtonCode | defaultButton () const |
QString | helpLinkText () const |
void | incrementInitialSize (const QSize &size) |
bool | isButtonEnabled (ButtonCode id) const |
QWidget * | mainWidget () |
virtual QSize | minimumSizeHint () const |
void | restoreDialogSize (const KConfigGroup &config) |
void | saveDialogSize (KConfigGroup &config, KConfigGroup::WriteConfigFlags options=KConfigGroup::Normal) const |
void | setButtonFocus (ButtonCode id) |
void | setButtonGuiItem (ButtonCode id, const KGuiItem &item) |
void | setButtonIcon (ButtonCode id, const KIcon &icon) |
void | setButtonMenu (ButtonCode id, QMenu *menu, ButtonPopupMode popupmode=InstantPopup) |
void | setButtons (ButtonCodes buttonMask) |
void | setButtonsOrientation (Qt::Orientation orientation) |
void | setButtonText (ButtonCode id, const QString &text) |
void | setButtonToolTip (ButtonCode id, const QString &text) |
void | setButtonWhatsThis (ButtonCode id, const QString &text) |
void | setDefaultButton (ButtonCode id) |
void | setEscapeButton (ButtonCode id) |
void | setInitialSize (const QSize &size) |
void | setMainWidget (QWidget *widget) |
void | showButton (ButtonCode id, bool state) |
void | showButtonSeparator (bool state) |
virtual QSize | sizeHint () const |
Static Public Member Functions | |
static KScanDialog * | getScanDialog (QWidget *parent=0) |
![]() | |
static bool | avoidArea (QWidget *widget, const QRect &area, int screen=-1) |
static void | centerOnScreen (QWidget *widget, int screen=-1) |
static int | groupSpacingHint () |
static QString | makeStandardCaption (const QString &userCaption, QWidget *window=0, CaptionFlags flags=HIGCompliantCaption) |
static int | marginHint () |
static void | resizeLayout (QLayout *lay, int margin, int spacing) |
static void | resizeLayout (QWidget *widget, int margin, int spacing) |
static void | setAllowEmbeddingInGraphicsView (bool allowEmbedding) |
static int | spacingHint () |
Protected Member Functions | |
KScanDialog (int dialogFace=Tabbed, int buttonMask=Close|Help, QWidget *parent=0) | |
int | id () const |
int | nextId () |
![]() | |
KPageDialog (KPageDialogPrivate &dd, KPageWidget *widget, QWidget *parent, Qt::WindowFlags flags=0) | |
KPageDialog (KPageWidget *widget, QWidget *parent, Qt::WindowFlags flags=0) | |
KPageWidget * | pageWidget () |
const KPageWidget * | pageWidget () const |
void | setPageWidget (KPageWidget *widget) |
![]() | |
KDialog (KDialogPrivate &dd, QWidget *parent, Qt::WindowFlags flags=0) | |
virtual void | closeEvent (QCloseEvent *e) |
virtual void | hideEvent (QHideEvent *) |
virtual void | keyPressEvent (QKeyEvent *) |
Additional Inherited Members | |
![]() | |
enum | FaceType |
![]() | |
enum | ButtonCode |
enum | ButtonPopupMode |
enum | CaptionFlag |
![]() | |
void | delayedDestruct () |
void | enableButton (ButtonCode id, bool state) |
void | enableButtonApply (bool state) |
void | enableButtonCancel (bool state) |
void | enableButtonOk (bool state) |
void | enableLinkedHelp (bool state) |
bool | isDetailsWidgetVisible () const |
virtual void | setCaption (const QString &caption) |
virtual void | setCaption (const QString &caption, bool modified) |
void | setDetailsWidget (QWidget *detailsWidget) |
void | setDetailsWidgetVisible (bool visible) |
void | setHelp (const QString &anchor, const QString &appname=QString()) |
void | setHelpLinkText (const QString &text) |
virtual void | setPlainCaption (const QString &caption) |
![]() | |
Auto | |
List | |
Plain | |
Tabbed | |
Tree | |
![]() | |
Apply | |
AppNameCaption | |
Cancel | |
Close | |
Default | |
DelayedPopup | |
Details | |
Help | |
HIGCompliantCaption | |
InstantPopup | |
ModifiedCaption | |
No | |
NoCaptionFlags | |
NoDefault | |
None | |
Ok | |
Reset | |
Try | |
User1 | |
User2 | |
User3 | |
Yes | |
![]() | |
virtual void | slotButtonClicked (int button) |
void | updateGeometry () |
![]() | |
KDialogPrivate *const | d_ptr |
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 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):
This will create and show a non-modal scanning dialog. Connect to more signals if you like.
A baseclass and accessor for Scanning Dialogs
Constructor & Destructor Documentation
◆ ~KScanDialog()
◆ KScanDialog()
|
explicitprotected |
Constructs the scan dialog.
If you implement an own dialog, you can customize it with the usual KPageDialog flags.
- Parameters
-
dialogFace The KPageDialog::FaceType buttonMask An ORed mask of all buttons (see KDialog::ButtonCode) parent The QWidget's parent, or 0
- See also
- KPageDialog
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 QWidget's parent, or 0
- Returns
- the KScanDialog, or 0 if the function failed
◆ id()
|
protected |
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()
|
protected |
◆ 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 QString 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:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.