wxIA  0.0.3
SANE / TWAIN Add-on class library for wxWidgets.
 All Classes Files Functions Variables Enumerations Enumerator Pages
Public Member Functions | Static Public Member Functions | List of all members
wxIAManager Class Reference

Image Acquisition Manager. More...

#include <wx/ia/ia.h>

Inheritance diagram for wxIAManager:

Public Member Functions

void AddProvider (wxIAProvider *provider)
 Add a provider. More...
 
wxIAProviderPtrArray & GetProviders ()
 
wxIAProviderGetDefaultProvider ()
 Gets the default provider. More...
 
wxString GetReturnCodeDesc (wxIAReturnCode rc)
 Returns a string description. More...
 

Static Public Member Functions

static wxIAManagerGet ()
 Get the Image Acquistion Manager. More...
 

Detailed Description

Image Acquisition Manager.

Maintains the list of available wxIAProvider's. There is only one instance of this class and it is created the first time Get() is called. The application may add it's own providers after calling Get() if desired.

Note
You should set your app name and vendor strings before calling wxIAManager::Get() because this information is used by at least the TWAIN source.

Member Function Documentation

void wxIAManager::AddProvider ( wxIAProvider provider)

Add a provider.

The provider becomes the property of the wxIAManager.

Parameters
providerprovider to add
static wxIAManager& wxIAManager::Get ( )
static

Get the Image Acquistion Manager.

This method will create and initialize the manager the first time it is called, which will cause the various platform specific providers to be loaded and initialized.

Returns
A reference to the wxIAManager.
wxIAProvider* wxIAManager::GetDefaultProvider ( )

Gets the default provider.

Returns
the default provider for the platform or NULL if there is no default.

On Windows and MAC this will probably return a TWAIN provider. On Unix this will probably return a SANE provider.

wxIAProviderPtrArray& wxIAManager::GetProviders ( )
Returns
a reference to the provider array.
wxString wxIAManager::GetReturnCodeDesc ( wxIAReturnCode  rc)

Returns a string description.

Returns
A string describing the specified wxIAReturnCode for usable for displaying to the user.

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