Class: TSimpleEventTargetter

Declaration: Input.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TEventReceiverTargetter

Inherited By:

None.

Purpose:

Derived from TEventReceiverTargetter, this class implements a policy targeting the event receiver that is the user focus.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

It is not intended that classes derive from TSimpleEventTargetter. Derive directly from TEventReceiverTargetter instead.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TSimpleEventTargetter::TSimpleEventTargetter

  1. TSimpleEventTargetter ()
  2. TSimpleEventTargetter (const TSimpleEventTargetter & copy)

Interface Category:

API.

Purpose:

  1. Default constructor.
  2. Copy constructor.

Calling Context:

  1. Called by the stream-in operators.
  2. Called to copy an object.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSimpleEventTargetter::~TSimpleEventTargetter

virtual ~ TSimpleEventTargetter ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSimpleEventTargetter::operator=

TSimpleEventTargetter & operator =(const TSimpleEventTargetter & assign)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function by using the operator in an assignment statement.

Parameters:

Return Value:

Returns a const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSimpleEventTargetter::operator>>=

virtual TStream & operator >>=(TStream & writeTo) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSimpleEventTargetter::operator<<=

virtual TStream & operator <<= (TStream & readFrom)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws a TInvalidVersionError if the version of the object on the stream is unknown to the version of the shared library installed.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSimpleEventTargetter::GetEventReceiverTarget

virtual bool GetEventReceiverTarget (TEventReceiverSurrogate & target)

Interface Category:

API.

Purpose:

Determines and returns the event receiver that is the current user focus.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns true if this function implements a policy that does not target the user-focused event receiver; false otherwise.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function overrides TEventReceiverTargetter's pure virtual function of the same name.