wxTst::CREventCaptureManager Class Reference

Manages the event filtering for C&R capturing (Singleton pattern). More...

#include <CREventCaptureManager.h>

Inheritance diagram for wxTst::CREventCaptureManager:

[legend]

Collaboration diagram for wxTst::CREventCaptureManager:

[legend]

List of all members.

Public Member Functions
virtual void	EmitPendingEvent ()
	Emit pending event, if existing.
virtual void	FilterEvent (wxEvent &event)
	Filter all events in capturing mode.
virtual void	IgnoreWindow (wxWindow *wdw)
	Events from/on dialog used in capturing for user interaction must be ignored.
virtual bool	IsOn () const
	Get status of event capturing switch.
virtual void	Off ()
	Switch off event capturing (called by CRCaptureControl class).
virtual void	On ()
	Switch on event capturing (called by CRCaptureControl class).
virtual void	SetLogger (CRLogInterface *log)
	Set logging target.
Static Public Member Functions
static void	Destroy ()
	Threadsafe destruction of static singleton instance.
static CREventCaptureManager *	GetInstance ()
	Get single private instance (Singleton pattern).
Protected Member Functions
virtual bool	CanIgnore (wxEvent &event)
	Returns if given event must be ignored.
	CREventCaptureManager ()
	Constructor.
virtual wxString	GetDescForUnsupportedEvent (wxEvent &event) const
	Returns descriptive name for given event, if unsupported.
virtual wxString	GetEventDesc (wxEvent &event) const
	Returns descriptive name for given event.
virtual wxString	GetEventDetails (wxEvent &event) const
	Get descriptive string with event details.
virtual void	LogEventDetails (wxEvent &event, const wxString &prefix)
	Log event details (only called for unsupported event).
virtual	~CREventCaptureManager ()
	Destructor.

---

Detailed Description

Manages the event filtering for C&R capturing (Singleton pattern).

Definition at line 35 of file CREventCaptureManager.h.

---

Constructor & Destructor Documentation

CREventCaptureManager::CREventCaptureManager

(

)

[protected]

Constructor.

Definition at line 40 of file CREventCaptureManager.cpp.

Referenced by GetInstance().

CREventCaptureManager::~CREventCaptureManager

(

)

[protected, virtual]

Destructor.

Definition at line 53 of file CREventCaptureManager.cpp.

References EmitPendingEvent().

---

Member Function Documentation

bool CREventCaptureManager::CanIgnore

(

wxEvent &

event

)

[protected, virtual]

Returns if given event must be ignored.

That is, the event stems from the capturing dialog itself.

Parameters:

event

event to check for being ignored

Definition at line 202 of file CREventCaptureManager.cpp.

Referenced by FilterEvent().

void CREventCaptureManager::Destroy

(

)

[static]

Threadsafe destruction of static singleton instance.

Definition at line 85 of file CREventCaptureManager.cpp.

void CREventCaptureManager::EmitPendingEvent

(

)

[virtual]

Emit pending event, if existing.

Definition at line 246 of file CREventCaptureManager.cpp.

References wxTst::CRCapturedEvent::EmitCpp().

Referenced by FilterEvent(), and ~CREventCaptureManager().

void CREventCaptureManager::FilterEvent

(

wxEvent &

event

)

[virtual]

Filter all events in capturing mode.

Parameters:

event

event to process

Implements wxTst::CREventFilterInterface.

Definition at line 125 of file CREventCaptureManager.cpp.

References wxTst::CRCppEmitter::AddComment(), CanIgnore(), wxTst::CRCapturedEvent::EmitCpp(), EmitPendingEvent(), GetDescForUnsupportedEvent(), GetEventDesc(), GetEventDetails(), wxTst::CRCppEmitter::GetInstance(), wxTst::CREventFactory::GetInstance(), wxTst::CRCapturedEvent::IsIrrelevant(), IsOn(), wxTst::CRCapturedEvent::IsPending(), LogEventDetails(), and wxTst::CRCapturedEvent::Process().

wxString CREventCaptureManager::GetDescForUnsupportedEvent

(

wxEvent &

event

)

const [protected, virtual]

Returns descriptive name for given event, if unsupported.

Parameters:

event

event to get descriptive name for

Returns:

descriptive name for given event, if unsupported; or empty string otherwise

Definition at line 257 of file CREventCaptureManager.cpp.

References UNSUPPORTED_EVENT_DESC.

Referenced by FilterEvent().

wxString CREventCaptureManager::GetEventDesc

(

wxEvent &

event

)

const [protected, virtual]

Returns descriptive name for given event.

Parameters:

event

event to get descriptive name for

Returns:

descriptive name for given event

Definition at line 394 of file CREventCaptureManager.cpp.

References EVENT_DESC.

Referenced by FilterEvent().

wxString CREventCaptureManager::GetEventDetails

(

wxEvent &

event

)

const [protected, virtual]

Get descriptive string with event details.

Parameters:

event

event to get descriptive name for

Returns:

descriptive string with event details

Definition at line 544 of file CREventCaptureManager.cpp.

Referenced by FilterEvent(), and LogEventDetails().

CREventCaptureManager * CREventCaptureManager::GetInstance

(

)

[static]

Get single private instance (Singleton pattern).

Returns:

single private instance

Definition at line 75 of file CREventCaptureManager.cpp.

References CREventCaptureManager().

Referenced by wxTst::CRCapture::Show().

void CREventCaptureManager::IgnoreWindow

(

wxWindow *

wdw

)

[virtual]

Events from/on dialog used in capturing for user interaction must be ignored.

Parameters:

wdw

capturing dialog to ignore events from

Definition at line 95 of file CREventCaptureManager.cpp.

Referenced by wxTst::CRCapture::Show().

bool CREventCaptureManager::IsOn

(

)

const [virtual]

Get status of event capturing switch.

Returns:

true, if event capturing is switched on

Definition at line 113 of file CREventCaptureManager.cpp.

Referenced by FilterEvent().

void CREventCaptureManager::LogEventDetails	(	wxEvent &	event,
		const wxString &	prefix
	)			[protected, virtual]

Log event details (only called for unsupported event).

Parameters:

	event	event to log details for
	prefix	logging output prefix

Definition at line 637 of file CREventCaptureManager.cpp.

References GetEventDetails(), and wxTst::CRLogInterface::Log().

Referenced by FilterEvent().

void CREventCaptureManager::Off

(

)

[virtual]

Switch off event capturing (called by CRCaptureControl class).

Definition at line 107 of file CREventCaptureManager.cpp.

void CREventCaptureManager::On

(

)

[virtual]

Switch on event capturing (called by CRCaptureControl class).

Definition at line 101 of file CREventCaptureManager.cpp.

void CREventCaptureManager::SetLogger

(

CRLogInterface *

log

)

[virtual]

Set logging target.

Parameters:

log

logging target

Definition at line 119 of file CREventCaptureManager.cpp.

Referenced by wxTst::CRCapture::Show().

---

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

• CREventCaptureManager.h
• CREventCaptureManager.cpp