• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • tdeio/tdeio
 

tdeio/tdeio

Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
KScanDialog Class Reference

#include <kscan.h>

Inherits KDialogBase.

Signals

void preview (const TQImage &img, int id)
 
void finalImage (const TQImage &img, int id)
 
void textRecognized (const TQString &text, int id)
 

Public Member Functions

 ~KScanDialog ()
 
virtual bool setup ()
 

Static Public Member Functions

static KScanDialog * getScanDialog (TQWidget *parent=0L, const char *name=0, bool modal=false)
 

Protected Member Functions

 KScanDialog (int dialogFace=Tabbed, int buttonMask=Close|Help, TQWidget *parent=0L, const char *name=0, bool modal=false)
 
int id () const
 
int nextId ()
 
virtual void virtual_hook (int id, void *data)
 

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 tdegraphics/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, "scandialog" );
if ( !m_scanDialog ) // no scanning support installed?
return;
connect( m_scanDialog, TQ_SIGNAL( finalImage( const TQImage&, int )),
TQ_SLOT( slotScanned( const TQImage&, int ) ));
}
if ( m_scanDialog->setup() ) // only if scanner configured/available
m_scanDialog->show();
KScanDialog::finalImage
void finalImage(const TQImage &img, int id)
Informs you that an image has scanned.
KScanDialog::getScanDialog
static KScanDialog * getScanDialog(TQWidget *parent=0L, const char *name=0, bool modal=false)
Creates the user's preferred scanning dialog and returns it, or 0L if no scan-support is available.
Definition: kscan.cpp:28

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

If you implement an own scan-dialog, you also have to implement a KScanDialogFactory.

A baseclass and accessor for Scanning Dialogs

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

Definition at line 63 of file kscan.h.

Constructor & Destructor Documentation

◆ ~KScanDialog()

KScanDialog::~KScanDialog ( )

Destructs the scan dialog.

Definition at line 58 of file kscan.cpp.

◆ KScanDialog()

KScanDialog::KScanDialog ( int  dialogFace = Tabbed,
int  buttonMask = Close|Help,
TQWidget *  parent = 0L,
const char *  name = 0,
bool  modal = false 
)
protected

Constructs the scan dialog.

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

Parameters
dialogFacethe KDialogBase::DialogType
buttonMaska ORed mask of all buttons (see KDialogBase::ButtonCode)
parentthe TQWidget's parent, or 0
namethe name of the TQObject, can be 0
modalif true the dialog is model
See also
KDialogBase

Definition at line 50 of file kscan.cpp.

Member Function Documentation

◆ finalImage

void KScanDialog::finalImage ( const TQImage &  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

◆ getScanDialog()

KScanDialog * KScanDialog::getScanDialog ( TQWidget *  parent = 0L,
const char *  name = 0,
bool  modal = false 
)
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 TQWidget's parent, or 0
namethe name of the TQObject, can be 0
modalif true the dialog is model
Returns
the KScanDialog, or 0 if the function failed

Definition at line 28 of file kscan.cpp.

◆ id()

int KScanDialog::id ( ) const
inlineprotected

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 122 of file kscan.h.

◆ nextId()

int KScanDialog::nextId ( )
inlineprotected

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 135 of file kscan.h.

◆ preview

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

Informs you that an image has been previewed.

Parameters
imgthe image
idthe image's id

◆ setup()

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 62 of file kscan.cpp.

◆ textRecognized

void KScanDialog::textRecognized ( const TQString &  text,
int  id 
)
signal

Informs you that the image with the id id has been run through text-recognition.

The text is in the TQString 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

tdeio/tdeio

Skip menu "tdeio/tdeio"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

tdeio/tdeio

Skip menu "tdeio/tdeio"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdeioslave
  •   http
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for tdeio/tdeio by doxygen 1.9.1
This website is maintained by Timothy Pearson.