wxIScan
wxScanBase Class Reference

Abstract base class for all wxScan... classes. More...

#include <wxscan.h>

List of all members.

Public Member Functions

 wxScanBase ()
 Standard constructor.
virtual ~wxScanBase ()
 Virtual destructor.
virtual bool IsOk ()=0
 Check if the error state is 'OK'. This function returns 'true' on 'OK'.
virtual bool IsDeviceAvailable ()=0
 Check if the scan device is available.
virtual int GetResolution ()=0
 Get the scanning resolution.
virtual bool ScanImage (wxImage &oImage)=0
 Scan an image.

Detailed Description

Abstract base class for all wxScan... classes.

This class represents an interface to the various wxScan... classes. Note that every member function has to be implemented in the subclasses.

Definition at line 40 of file wxscan.h.


Constructor & Destructor Documentation

wxScanBase::wxScanBase ( ) [inline]

Standard constructor.

Definition at line 44 of file wxscan.h.

{}
virtual wxScanBase::~wxScanBase ( ) [inline, virtual]

Virtual destructor.

Definition at line 47 of file wxscan.h.

{}

Member Function Documentation

virtual int wxScanBase::GetResolution ( ) [pure virtual]

Get the scanning resolution.

virtual bool wxScanBase::IsDeviceAvailable ( ) [pure virtual]

Check if the scan device is available.

virtual bool wxScanBase::IsOk ( ) [pure virtual]

Check if the error state is 'OK'. This function returns 'true' on 'OK'.

virtual bool wxScanBase::ScanImage ( wxImage &  oImage) [pure virtual]

Scan an image.

Parameters:
oImagea reference to the image object that should hold the image

The result is in the parameter oImage.


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