wxIAMonitor Class Reference

Image Acquisition Monitor. More...

#include <wx/ia/ia.h>

Public Member Functions
	wxIAMonitor ()
	Constructor. More...
virtual	~wxIAMonitor ()
	Destructor.
virtual bool	Update (const wxString &text, const off_t quantum, const off_t span)=0
	Update method. More...

Detailed Description

Image Acquisition Monitor.

Class to monitor the progress of an image aquistion. Generally used to provide feedback to the user and allow the user to possibly abort the operation.

Note

Using this to provide a wxProgressDialog or similar interface is really only suggested when not using the user interface provided by the provider/source (i.e by specifying a wxUIMode of wxIA_UIMODE_NONE). Otherwise your windows and/or dialogs may interfere with the possibly native interface being provided by the provider/source.

Constructor & Destructor Documentation

wxIAMonitor::wxIAMonitor ( )

inline

Constructor.

Default constructor

Member Function Documentation

virtual bool wxIAMonitor::Update ( const wxString &  text, const off_t  quantum, const off_t  span  )

pure virtual

Update method.

Override this method. This method will be called by the provider periodically to indicate progress and allow the user to abort the operation.

Parameters

text	string describing the operation being performed
quantum	the position relative to span representing how much progress has been made towards completing the operation.
span	the span of the operation (i.e. the max value for quantum).

Returns

True to continue process or false to abort.

---

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

• include/wx/ia/ia.h