Main Page   Class Hierarchy   Compound List   File List   Compound Members   File Members  

ia.h File Reference

#include "wx/confbase.h"

Go to the source code of this file.

Compounds

class  wxIAManager
class  wxIAMonitor
class  wxIAProvider
class  wxIASourceInfo

Defines

#define EVT_IA_GETIMAGE(func)
#define EVT_IA_UPDATE(func)

Typedefs

typedef void (wxEvtHandler::* wxIAEventFunction )(wxIAEvent&)

Enumerations

enum  wxIAReturnCode {
  wxIA_RC_SUCCESS = 0, wxIA_RC_UNKNOWNERROR, wxIA_RC_NOTSUPPORTED, wxIA_RC_CANCELLED,
  wxIA_RC_NOTREADY, wxIA_RC_DEVICEBUSY, wxIA_RC_INVAL, wxIA_RC_JAMMED,
  wxIA_RC_NODOCS, wxIA_RC_COVEROPEN, wxIA_RC_IOERROR, wxIA_RC_NOMEM,
  wxIA_RC_ACCESSDENIED, wxIA_RC_NOSOURCE, wxIA_RC_NOTINITIALIZED
}
 IA Return Codes. More...

enum  wxIASourceType {
  wxIA_SOURCE_UNKNOWN = 0, wxIA_SOURCE_SCANNER, wxIA_SOURCE_FLATBEDSCANNER, wxIA_SOURCE_FILMSCANNER,
  wxIA_SOURCE_STILLCAMERA, wxIA_SOURCE_VIDEOCAMERA, wxIA_SOURCE_FILE, wxIA_SOURCE_IMAGEBASE,
  wxIA_SOURCE_FRAMEGRABBER, wxIA_SOURCE_MULTIFUNCTION, wxIA_SOURCE_SHEETFEDSCANNER, wxIA_SOURCE_HANDHELDSCANNER
}
 IA Source Types. More...

enum  wxIAUIMode { wxIA_UIMODE_NONE = 0, wxIA_UIMODE_NORMAL }
 User Interface Mode. More...

enum  wxIATransferMode { wxIA_TRANSFERMODE_NATIVE = 0, wxIA_TRANSFERMODE_BUFFER, wxIA_TRANSFERMODE_FILE }
 Source Image Transfer Mode. More...

enum  wxIATransferFileType { wxIA_FILETYPE_JPG = 0, wxIA_FILETYPE_TIFF, wxIA_FILETYPE_BMP }
 Image transfer file type. More...


Functions

 WX_DEFINE_ARRAY (wxIAProvider*, wxIAProviderPtrArray)
 Image Acquisition Provider Array.

 BEGIN_DECLARE_EVENT_TYPES () DECLARE_EVENT_TYPE(wxEVT_IA_GETIMAGE, 0) DECLARE_EVENT_TYPE(wxEVT_IA_UPDATE, 0) END_DECLARE_EVENT_TYPES() class wxIAEvent
 Image Acquisition event. More...


Variables

wxIASourceInfo wxNullIASourceInfo
 Null source info.

Detailed Description

Define Documentation

#define EVT_IA_GETIMAGE( func )
 

Initializer:

\
    DECLARE_EVENT_TABLE_ENTRY(wxEVT_IA_GETIMAGE, -1, -1, \
                              (wxObjectEventFunction) \
                              (wxEventFunction) \
                              (wxIAEventFunction)&func, \
                              NULL),

#define EVT_IA_UPDATE( func )
 

Initializer:

\
    DECLARE_EVENT_TABLE_ENTRY(wxEVT_IA_UPDATE, -1, -1, \
                              (wxObjectEventFunction) \
                              (wxEventFunction) \
                              (wxIAEventFunction)&func, \
                              NULL),

Typedef Documentation

typedef void (wxEvtHandler::* wxIAEventFunction)(wxIAEvent&)
 

Enumeration Type Documentation

enum wxIAReturnCode
 

IA Return Codes.

Enumeration values:
wxIA_RC_SUCCESS   Operation completed successfully.
wxIA_RC_UNKNOWNERROR   Unknown error.
wxIA_RC_NOTSUPPORTED   Operation, mode, or value not supported.
wxIA_RC_CANCELLED   Operation was cancelled by user.
wxIA_RC_NOTREADY   Device is not ready.
wxIA_RC_DEVICEBUSY   Device is busy.
wxIA_RC_INVAL   Invalid data or argument.
wxIA_RC_JAMMED   Document feeder jammed.
wxIA_RC_NODOCS   Document feeder out of documents.
wxIA_RC_COVEROPEN   Scanner cover is open.
wxIA_RC_IOERROR   Error during device I/O.
wxIA_RC_NOMEM   Out of memory.
wxIA_RC_ACCESSDENIED   Access to resource has been denied.
wxIA_RC_NOSOURCE   No source selected.
wxIA_RC_NOTINITIALIZED   Provider not initialized.

enum wxIASourceType
 

IA Source Types.

Specifies the type of device encapsulated by the source.

Enumeration values:
wxIA_SOURCE_UNKNOWN   Unknown.
wxIA_SOURCE_SCANNER   Generic scanner - exact type is unknown, but it is a scanner.
wxIA_SOURCE_FLATBEDSCANNER   Flatbed scanner.
wxIA_SOURCE_FILMSCANNER   Film scanner.
wxIA_SOURCE_STILLCAMERA   Still camera.
wxIA_SOURCE_VIDEOCAMERA   Video camera.
wxIA_SOURCE_FILE   Image file.
wxIA_SOURCE_IMAGEBASE   ImageBase - Image data base.
wxIA_SOURCE_FRAMEGRABBER   Frame grabber.
wxIA_SOURCE_MULTIFUNCTION   Multifunction device - fax/scanner/printer etc.
wxIA_SOURCE_SHEETFEDSCANNER   Sheetfed scanner.
wxIA_SOURCE_HANDHELDSCANNER   Handheld scanner.

enum wxIATransferFileType
 

Image transfer file type.

Enumeration values:
wxIA_FILETYPE_JPG   JPG - JPEG.
wxIA_FILETYPE_TIFF   TIFF.
wxIA_FILETYPE_BMP   BMP - Windows/OS2 bitmap.

enum wxIATransferMode
 

Source Image Transfer Mode.

Mode used to transfer image data from the source.

Enumeration values:
wxIA_TRANSFERMODE_NATIVE   Native image transfer mode.

Image data will be supplied as both wxBitmap and wxImage. For TWAIN the native mode supplies DIB and for Mac OS the native mode supplies a PICT. No matter what native format is actually used, the user will retrieve the data as a wxBitmap or wxImage.

wxIA_TRANSFERMODE_BUFFER   Transfer raw data a buffer at a time.

Image data will be transfered to a user supplied buffer using as many transfers as necessary.

wxIA_TRANSFERMODE_FILE   Transfer image data by storing data in a file.

enum wxIAUIMode
 

User Interface Mode.

Mode of the user interface presented

Enumeration values:
wxIA_UIMODE_NONE   No user interface if possible.
wxIA_UIMODE_NORMAL   Normal user interface. Provides a dialog or whatever is appropriate.

Function Documentation

BEGIN_DECLARE_EVENT_TYPES ( )
 

Image Acquisition event.

Event sent by a wxIAProvider

WX_DEFINE_ARRAY ( wxIAProvider *,
wxIAProviderPtrArray )
 

Image Acquisition Provider Array.

Variable Documentation

wxIASourceInfo wxNullIASourceInfo
 

Null source info.

Generated at Tue Apr 1 17:02:58 2003 for wxIA by doxygen1.2.3 written by Dimitri van Heesch, © 1997-2000