.TH "KOCRDialog" kde3 "11 Jun 2005" "Version Version 3.4.1" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KOCRDialog \- Base class for OCR Dialogs.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kscan.h>\fP
.PP
Inherits \fBKDialogBase\fP.
.PP
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBtextRecognized\fP (const \fBQString\fP &text, int id)"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static \fBKOCRDialog\fP * \fBgetOCRDialog\fP (\fBQWidget\fP *parent=0L, const char *name=0, bool modal=false)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBKOCRDialog\fP (int dialogFace=Tabbed, int buttonMask=Close|Help, \fBQWidget\fP *parent=0L, const char *name=0, bool modal=false)"
.br
.ti -1c
.RI "int \fBid\fP () const "
.br
.ti -1c
.RI "int \fBnextId\fP ()"
.br
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Base class for OCR Dialogs. 
.PP
Definition at line 236 of file kscan.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KOCRDialog::KOCRDialog (int dialogFace = \fCTabbed\fP, int buttonMask = \fCClose|Help\fP, \fBQWidget\fP * parent = \fC0L\fP, const char * name = \fC0\fP, bool modal = \fCfalse\fP)\fC [protected]\fP"
.PP
Constructs the OCR dialog. 
.PP
If you implement an own dialog, you can customize it with the usual \fBKDialogBase\fP flags.
.PP
\fBParameters:\fP
.RS 4
\fIdialogFace\fP the \fBKDialogBase::DialogType\fP 
.br
\fIbuttonMask\fP a ORed mask of all buttons (see \fBKDialogBase::ButtonCode\fP) 
.br
\fIparent\fP the QWidget's parent, or 0 
.br
\fIname\fP the name of the \fBQObject\fP, can be 0 
.br
\fImodal\fP if true the dialog is model 
.RE
.PP

.PP
Definition at line 93 of file kscan.cpp.
.SH "Member Function Documentation"
.PP 
.SS "\fBKOCRDialog\fP * KOCRDialog::getOCRDialog (\fBQWidget\fP * parent = \fC0L\fP, const char * name = \fC0\fP, bool modal = \fCfalse\fP)\fC [static]\fP"
.PP
Creates the user's preferred OCR dialog and returns it, or 0L if no OCR-support is available. 
.PP
Pass a suitable \fCparent\fP widget, if you like. If you don't you have to 'delete' the returned pointer yourself. 
.PP
\fBParameters:\fP
.RS 4
\fIparent\fP the QWidget's parent, or 0 
.br
\fIname\fP the name of the \fBQObject\fP, can be 0 
.br
\fImodal\fP if true the dialog is model 
.RE
.PP
\fBReturns:\fP
.RS 4
the KOCRDialog, or 0 if the function failed 
.RE
.PP

.PP
Definition at line 71 of file kscan.cpp.
.PP
References QValueList::begin(), KLibFactory::create(), KLibLoader::factory(), QValueList::isEmpty(), QString::number(), KTrader::query(), KLibLoader::self(), and KTrader::self().
.SS "int KOCRDialog::id () const\fC [inline, protected]\fP"
.PP
Returns the current id for an image. 
.PP
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.
.PP
\fBReturns:\fP
.RS 4
the current id for the image 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBnextId\fP 
.PP
\fBtextRecognized\fP 
.RE
.PP

.PP
Definition at line 279 of file kscan.h.
.SS "int KOCRDialog::nextId ()\fC [inline, protected]\fP"
.PP
Returns the id for the next image. 
.PP
You can use that in your subclass for the signals.
.PP
\fBReturns:\fP
.RS 4
the id for the next image 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBid\fP 
.PP
\fBtextRecognized\fP 
.RE
.PP

.PP
Definition at line 289 of file kscan.h.
.SS "void KOCRDialog::textRecognized (const \fBQString\fP & text, int id)\fC [signal]\fP"
.PP
Informs you that the image with the id \fCid\fP has been run through text-recognition. 
.PP
The text is in the \fBQString\fP parameter. In the future, a compound document, using rich text will be used instead.
.PP
\fBParameters:\fP
.RS 4
\fItext\fP the text that has been recognized 
.br
\fIid\fP the id of the image 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for kio Library from the source code.
