KOCRDialog Class Reference

#include <kscan.h>

Inheritance diagram for KOCRDialog:

Signals
void	textRecognized (const QString &text, int id)
Signals inherited from KPageDialog
void	currentPageChanged (KPageWidgetItem *current, KPageWidgetItem *before)
void	pageRemoved (KPageWidgetItem *page)
Signals inherited from KDialog
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
	~KOCRDialog ()
Public Member Functions inherited from KPageDialog
	KPageDialog (QWidget *parent=0, Qt::WindowFlags flags=0)
	~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)
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)
Public Member Functions inherited from KDialog
	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 KOCRDialog *	getOCRDialog (QWidget *parent=0)
Static Public Member Functions inherited from KDialog
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
	KOCRDialog (int dialogFace=Tabbed, int buttonMask=Close|Help, QWidget *parent=0L, bool modal=false)
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)
const KPageWidget *	pageWidget () const
KPageWidget *	pageWidget ()
void	setPageWidget (KPageWidget *widget)
Protected Member Functions inherited from KDialog
	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
Public Types inherited from KPageDialog
enum	FaceType
Public Types inherited from KDialog
enum	ButtonCode
enum	ButtonPopupMode
enum	CaptionFlag
Public Slots inherited from KDialog
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 Attributes inherited from KPageDialog
	Auto
	List
	Plain
	Tabbed
	Tree
Public Attributes inherited from KDialog
	Apply
	AppNameCaption
	Cancel
	Close
	Default
	DelayedPopup
	Details
	Help
	HIGCompliantCaption
	InstantPopup
	ModifiedCaption
	No
	NoCaptionFlags
	NoDefault
	None
	Ok
	Reset
	Try
	User1
	User2
	User3
	Yes
Protected Slots inherited from KDialog
virtual void	slotButtonClicked (int button)
void	updateGeometry ()
Protected Attributes inherited from KDialog
KDialogPrivate *const	d_ptr

Detailed Description

Base class for OCR Dialogs.

Definition at line 170 of file kscan.h.

Constructor & Destructor Documentation

KOCRDialog::~KOCRDialog

(

)

Definition at line 105 of file kscan.cpp.

KOCRDialog::KOCRDialog ( int  dialogFace = Tabbed, int  buttonMask = Close|Help, QWidget *  parent = 0L, bool  modal = false  )

explicitprotected

Constructs the OCR dialog.

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

Parameters

dialogFace	the KPageDialog::FaceType
buttonMask	a ORed mask of all buttons (see KDialog::ButtonCode)
parent	the QWidget's parent, or 0
modal	if true the dialog is model

Definition at line 93 of file kscan.cpp.

Member Function Documentation

KOCRDialog * KOCRDialog::getOCRDialog ( QWidget *  parent = 0 )

static

Creates the user's preferred OCR dialog and returns it, or 0L if no OCR-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 KOCRDialog, or 0 if the function failed

Definition at line 87 of file kscan.cpp.

int KOCRDialog::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 text-recognition belongs to which scan.

Returns

the current id for the image

See also

nextId

textRecognized

Definition at line 110 of file kscan.cpp.

int KOCRDialog::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

textRecognized

Definition at line 115 of file kscan.cpp.

void KOCRDialog::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

text	the text that has been recognized
id	the id of the image

---

The documentation for this class was generated from the following files:

• kscan.h
• kscan.cpp