wxIAEvent Class Reference

Image Acquisition event. More...

#include <wx/ia/ia.h>

Inheritance diagram for wxIAEvent:

Public Member Functions
	wxIAEvent (wxEventType type, wxIAProvider *provider)
	Constructor.
	wxIAEvent (wxEventType type, wxIAProvider *provider, const wxString &text, size_t quantum, size_t span)
	Constructor.
	wxIAEvent (const wxIAEvent &event)
	Copy constructor.
virtual wxIAProvider *	GetProvider ()
virtual void	SetProvider (wxIAProvider *provider)
virtual wxString	GetText ()
virtual void	SetText (const wxString &text)
virtual size_t	GetQuantum ()
virtual void	SetQuantum (size_t quantum)
virtual size_t	GetSpan ()
virtual void	SetSpan (size_t span)
virtual bool	ShouldAbort ()
virtual void	Abort (bool val=TRUE)
wxEvent *	Clone (void) const
	Clone.

Detailed Description

Image Acquisition event.

Event sent by a wxIAProvider

Member Function Documentation

virtual void wxIAEvent::Abort ( bool  val = TRUE )

inlinevirtual

Set val to TRUE to tell the provider it should abort the operation.

Parameters

val

virtual wxIAProvider* wxIAEvent::GetProvider ( )

inlinevirtual

Returns

a pointer to the provider that posted the event

virtual size_t wxIAEvent::GetQuantum ( )

inlinevirtual

Get quantum - the value indicating the current status relative to span (GetSpan())

virtual size_t wxIAEvent::GetSpan ( )

inlinevirtual

Get the span

virtual wxString wxIAEvent::GetText ( )

inlinevirtual

Get update status text

virtual void wxIAEvent::SetProvider ( wxIAProvider *  provider )

inlinevirtual

Set the provider

virtual void wxIAEvent::SetQuantum ( size_t  quantum )

inlinevirtual

Set the quantum

virtual void wxIAEvent::SetSpan ( size_t  span )

inlinevirtual

Set the span

virtual void wxIAEvent::SetText ( const wxString &  text )

inlinevirtual

Set update status text

virtual bool wxIAEvent::ShouldAbort ( )

inlinevirtual

Returns

TRUE if the provider should abort the scan or FALSE if not.

---

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

• include/wx/ia/ia.h