ia.h

Go to the documentation of this file.

// Name:        ia.h
// Purpose:     wxIA - Image Acquisition Classes
// Author:      Derry Bryson, Technology Associates, Inc.
// Modified by:
// Created:     01/08/2003
// RCS-ID:      $Id: ia.h,v 1.2 2003/04/03 03:53:40 dbryson Exp $
// Copyright:   (c) 2003 Derry Bryson
// Licence:     wxWindows license

#ifndef _WX_IA_H_
#define _WX_IA_H_

#ifdef __GNUG__
#pragma interface "ia.h"
#endif

#include "wx/confbase.h"


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,
};


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,
};


enum wxIAUIMode
{
    wxIA_UIMODE_NONE = 0,
    wxIA_UIMODE_NORMAL,
};


enum wxIATransferMode
{

    wxIA_TRANSFERMODE_NATIVE = 0,

    wxIA_TRANSFERMODE_BUFFER,
    wxIA_TRANSFERMODE_FILE,
};

enum wxIATransferFileType
{
    wxIA_FILETYPE_JPG = 0,
    wxIA_FILETYPE_TIFF,
    wxIA_FILETYPE_BMP,
};


class wxIASourceInfo
{
public:

    wxIASourceInfo();


    wxIASourceInfo(const wxString &name, const wxString &model,
        const wxString &vendor, wxIASourceType type);

    //
    //  Accessors
    //

    void SetName(const wxString &name);

    wxString GetName() const;

    void SetModel(const wxString &model);

    wxString GetModel() const;

    void SetVendor(const wxString &vendor);

    wxString GetVendor() const;

    void SetType(wxIASourceType type);

    wxIASourceType GetType() const;

protected:
    wxString m_name;
    wxString m_model;
    wxString m_vendor;
    wxIASourceType m_type;
};

extern wxIASourceInfo wxNullIASourceInfo;


class wxIAMonitor
{
public:

    wxIAMonitor() {}
    virtual ~wxIAMonitor() {}


    virtual bool Update(const wxString &text, const off_t quantum, const off_t span) = 0;
};


class wxIAProvider : public wxObject
{
public:

    wxIAProvider();

    virtual ~wxIAProvider();

    virtual bool Ok();


    virtual wxString GetName();


    virtual int GetSourceCount();

    virtual wxIASourceInfo GetSourceInfo(int i);

    virtual wxIAReturnCode SelectSource(const wxString& name = wxEmptyString,
        wxIAUIMode uiMode = wxIA_UIMODE_NORMAL, wxWindow *parent = NULL);

    virtual wxIAReturnCode SelectDefaultSource();

    virtual bool IsSourceSelected();

    virtual wxIASourceInfo GetSelSourceInfo();


    virtual wxIAReturnCode SetSelSourceConfig(const wxString &configString);


    virtual wxString GetSelSourceConfig();


    virtual wxIAReturnCode AcquireImage(wxIAUIMode uiMode = wxIA_UIMODE_NORMAL,
        wxWindow *parent = NULL, wxIAMonitor *mon = NULL);


    virtual wxIAReturnCode AcquireImages(int numImages,
        wxIAUIMode uiMode = wxIA_UIMODE_NORMAL, wxWindow *parent = NULL,
        wxIAMonitor *mon = NULL);


    virtual void SetEvtHandler(wxEvtHandler *evtHandler);



    virtual wxIAReturnCode SetTransferMode(wxIATransferMode mode);


    virtual wxIATransferMode GetTransferMode();


    virtual wxIAReturnCode SetTransferFilename(const wxString &filename,
        wxIATransferFileType type);

    virtual wxString GetTransferFilename();

    virtual wxIATransferFileType GetTransferFileType();


    virtual wxIAReturnCode SetTransferBuffer(void *buffer, size_t size);


    virtual void *GetTransferBuffer();

    virtual size_t GetTransferBufferSize();


    wxEvtHandler *GetEvtHandler();


    virtual wxImage GetImage();


    virtual wxBitmap GetBitmap();


    virtual bool SaveSettings(wxConfigBase *config);


    virtual bool LoadSettings(wxConfigBase *config);

protected:
    wxEvtHandler *m_evtHandler;
    wxIATransferMode m_transferMode;
    void *m_transferBuffer;
    size_t m_transferBufferSize;
    wxString m_transferFilename;
    wxIATransferFileType m_transferFileType;

private:
    DECLARE_CLASS(wxIAProvider)
};

WX_DEFINE_ARRAY(wxIAProvider*, wxIAProviderPtrArray);


class wxIAManager : public wxObject
{
public:

    static wxIAManager &Get();


    void AddProvider(wxIAProvider *provider);

    wxIAProviderPtrArray &GetProviders();


    wxIAProvider *GetDefaultProvider();


    wxString GetReturnCodeDesc(wxIAReturnCode rc);

private:
    wxIAManager();
    ~wxIAManager();

    static bool s_init;
    wxIAProviderPtrArray m_providers;
    static wxIAProvider *s_defaultProvider;

    DECLARE_CLASS(wxIAManager)
};

BEGIN_DECLARE_EVENT_TYPES()
    DECLARE_EVENT_TYPE(wxEVT_IA_GETIMAGE, 0)
    DECLARE_EVENT_TYPE(wxEVT_IA_UPDATE, 0)
END_DECLARE_EVENT_TYPES()


class wxIAEvent : public wxEvent
{
public:
    wxIAEvent(wxEventType type, wxIAProvider *provider);
    wxIAEvent(wxEventType type, wxIAProvider *provider, const wxString &text,
        size_t quantum, size_t span);
    wxIAEvent(const wxIAEvent& event);

    virtual wxIAProvider *GetProvider() { return m_provider; }
    virtual void SetProvider(wxIAProvider *provider) { m_provider = provider; }
    virtual wxString GetText() { return m_text; }
    virtual void SetText(const wxString &text) { m_text = text; }
    virtual size_t GetQuantum() { return m_quantum; }
    virtual void SetQuantum(size_t quantum) { m_quantum = quantum; }
    virtual size_t GetSpan() { return m_span; }
    virtual void SetSpan(size_t span) { m_span = span; }
    virtual bool ShouldAbort() { return m_abort; }
    virtual void Abort(bool val = TRUE) { m_abort = val; }

    wxEvent *Clone(void) const { return new wxIAEvent(*this); }

private:
    wxIAProvider *m_provider;
    wxString m_text;
    size_t m_quantum;
    size_t m_span;
    bool m_abort;
};

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

#define EVT_IA_GETIMAGE(func) \
    DECLARE_EVENT_TABLE_ENTRY(wxEVT_IA_GETIMAGE, -1, -1, \
                              (wxObjectEventFunction) \
                              (wxEventFunction) \
                              (wxIAEventFunction)&func, \
                              NULL),
#define EVT_IA_UPDATE(func) \
    DECLARE_EVENT_TABLE_ENTRY(wxEVT_IA_UPDATE, -1, -1, \
                              (wxObjectEventFunction) \
                              (wxEventFunction) \
                              (wxIAEventFunction)&func, \
                              NULL),

#endif // _WX_IA_H_