• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.10.2 API Reference
  • KDE Home
  • Contact Us
 

KIO

Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions
KScanDialog Class Reference

#include <kscan.h>

Inheritance diagram for KScanDialog:
KPageDialog KDialog QDialog

List of all members.

Signals

void finalImage (const QImage &img, int id)
void preview (const QImage &img, int id)
void textRecognized (const QString &text, int id)
- Signals inherited from KPageDialog
void aboutToShowDetails ()
void applyClicked ()
void buttonClicked (KDialog::ButtonCode button)
void cancelClicked ()
void closeClicked ()
void currentPageChanged (KPageWidgetItem *current, KPageWidgetItem *before)
void defaultClicked ()
void finished ()
void helpClicked ()
void hidden ()
void layoutHintChanged ()
void noClicked ()
void okClicked ()
void pageRemoved (KPageWidgetItem *page)
void resetClicked ()
void tryClicked ()
void user1Clicked ()
void user2Clicked ()
void user3Clicked ()
void yesClicked ()
- Signals inherited from KDialog

Public Member Functions

 ~KScanDialog ()
virtual bool setup ()
- Public Member Functions inherited from KPageDialog
 KPageDialog (QWidget *parent=0, Qt::WindowFlags flags=0)
 ~KDialog ()
 ~KPageDialog ()
void addPage (KPageWidgetItem *item)
KPageWidgetItem * addPage (QWidget *widget, const QString &name)
KPageWidgetItem * addSubPage (KPageWidgetItem *parent, QWidget *widget, const QString &name)
void addSubPage (KPageWidgetItem *parent, KPageWidgetItem *item)
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
KPageWidgetItem * currentPage () const
ButtonCode defaultButton () const
QString helpLinkText () const
void incrementInitialSize (const QSize &size)
KPageWidgetItem * insertPage (KPageWidgetItem *before, QWidget *widget, const QString &name)
void insertPage (KPageWidgetItem *before, KPageWidgetItem *item)
bool isButtonEnabled (ButtonCode id) const
 KDialog (QWidget *parent=0, Qt::WindowFlags flags=0)
QWidget * mainWidget ()
virtual QSize minimumSizeHint () const
void removePage (KPageWidgetItem *item)
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 setCurrentPage (KPageWidgetItem *item)
void setDefaultButton (ButtonCode id)
void setEscapeButton (ButtonCode id)
void setFaceType (FaceType faceType)
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 Public Member Functions inherited from KPageDialog
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 ()
- Protected Member Functions inherited from KPageDialog
 KPageDialog (KPageWidget *widget, QWidget *parent, Qt::WindowFlags flags=0)
 KPageDialog (KPageDialogPrivate &dd, KPageWidget *widget, QWidget *parent, Qt::WindowFlags flags=0)
virtual void closeEvent (QCloseEvent *e)
virtual void hideEvent (QHideEvent *)
 KDialog (KDialogPrivate &dd, QWidget *parent, Qt::WindowFlags flags=0)
virtual void keyPressEvent (QKeyEvent *)
const KPageWidget * pageWidget () const
KPageWidget * pageWidget ()
void setPageWidget (KPageWidget *widget)

Additional Inherited Members

- Public Types inherited from KPageDialog
enum  ButtonCode
enum  ButtonPopupMode
enum  CaptionFlag
enum  FaceType
- Public Types inherited from KDialog
- Public Slots inherited from KPageDialog
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)
- Public Slots inherited from KDialog
- Public Attributes inherited from KPageDialog
 Apply
 AppNameCaption
 Auto
 Cancel
 Close
 Default
 DelayedPopup
 Details
 Help
 HIGCompliantCaption
 InstantPopup
 List
 ModifiedCaption
 No
 NoCaptionFlags
 NoDefault
 None
 Ok
 Plain
 Reset
 Tabbed
 Tree
 Try
 User1
 User2
 User3
 Yes
- Public Attributes inherited from KDialog
- Protected Slots inherited from KPageDialog
virtual void slotButtonClicked (int button)
void updateGeometry ()
- Protected Slots inherited from KDialog
- Protected Attributes inherited from KPageDialog
KDialogPrivate *const d_ptr
- Protected Attributes inherited from KDialog

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):

if ( !m_scanDialog ) {
m_scanDialog = KScanDialog::getScanDialog( this );
if ( !m_scanDialog ) // no scanning support installed?
return;
connect( m_scanDialog, SIGNAL( finalImage( const QImage&, int )),
SLOT( slotScanned( const QImage&, int ) ));
}
if ( m_scanDialog->setup() ) // only if scanner configured/available
m_scanDialog->show();

This will create and show a non-modal scanning dialog. Connect to more signals if you like.

A baseclass and accessor for Scanning Dialogs

Author:
Carsten Pfeiffer pfeif.nosp@m.fer@.nosp@m.kde.o.nosp@m.rg

Definition at line 62 of file kscan.h.


Constructor & Destructor Documentation

KScanDialog::~KScanDialog ( )

Destructs the scan dialog.

Definition at line 55 of file kscan.cpp.

KScanDialog::KScanDialog ( int  dialogFace = Tabbed,
int  buttonMask = Close|Help,
QWidget *  parent = 0 
)
explicitprotected

Constructs the scan dialog.

If you implement an own dialog, you can customize it with the usual KPageDialog flags.

Parameters:
dialogFaceThe KPageDialog::FaceType
buttonMaskAn ORed mask of all buttons (see KDialog::ButtonCode)
parentThe QWidget's parent, or 0
See also:
KPageDialog

Definition at line 44 of file kscan.cpp.


Member Function Documentation

void KScanDialog::finalImage ( const QImage &  img,
int  id 
)
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:
imgthe image
idthe image's id
KScanDialog * KScanDialog::getScanDialog ( QWidget *  parent = 0)
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:
parentthe QWidget's parent, or 0
Returns:
the KScanDialog, or 0 if the function failed

Definition at line 38 of file kscan.cpp.

int KScanDialog::id ( ) const
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

Definition at line 60 of file kscan.cpp.

int KScanDialog::nextId ( )
protected

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

Definition at line 65 of file kscan.cpp.

void KScanDialog::preview ( const QImage &  img,
int  id 
)
signal

Informs you that an image has been previewed.

Parameters:
imgthe image
idthe image's id
bool KScanDialog::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.

Definition at line 70 of file kscan.cpp.

void KScanDialog::textRecognized ( const QString &  text,
int  id 
)
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:
textthe text that has been recognized
idthe id of the image

The documentation for this class was generated from the following files:
  • kscan.h
  • kscan.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Sun Apr 28 2013 14:27:38 by doxygen 1.8.1.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KIO

Skip menu "KIO"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdelibs-4.10.2 API Reference

Skip menu "kdelibs-4.10.2 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal