Mir
Public Types | Public Member Functions | Protected Member Functions | List of all members
mir::input::InputSendObserver Class Referenceabstract

#include <input_send_observer.h>

Inheritance diagram for mir::input::InputSendObserver:
[legend]

Public Types

enum  FailureReason { surface_disappeared, no_response_received, socket_error }
 
enum  InputResponse { consumed, not_consumed }
 

Public Member Functions

 InputSendObserver ()=default
 
virtual ~InputSendObserver ()=default
 
virtual void send_failed (MirEvent const &event, input::Surface *surface, FailureReason reason)=0
 An attempt to send an input event to a destination failed. More...
 
virtual void send_suceeded (MirEvent const &event, input::Surface *surface, InputResponse response)=0
 Client responded to an input event. More...
 
virtual void client_blocked (MirEvent const &event, input::Surface *client)=0
 Called when client is temporary blocked because input events are still in the queue. More...
 

Protected Member Functions

InputSendObserveroperator= (InputSendObserver const &)=delete
 
 InputSendObserver (InputSendObserver const &)=delete
 

Member Enumeration Documentation

Enumerator
surface_disappeared 
no_response_received 
socket_error 
Enumerator
consumed 
not_consumed 

Constructor & Destructor Documentation

mir::input::InputSendObserver::InputSendObserver ( )
default
virtual mir::input::InputSendObserver::~InputSendObserver ( )
virtualdefault
mir::input::InputSendObserver::InputSendObserver ( InputSendObserver const &  )
protecteddelete

Member Function Documentation

virtual void mir::input::InputSendObserver::client_blocked ( MirEvent const &  event,
input::Surface client 
)
pure virtual

Called when client is temporary blocked because input events are still in the queue.

Implemented in mir::input::NullInputSendObserver.

InputSendObserver& mir::input::InputSendObserver::operator= ( InputSendObserver const &  )
protecteddelete
virtual void mir::input::InputSendObserver::send_failed ( MirEvent const &  event,
input::Surface surface,
FailureReason  reason 
)
pure virtual

An attempt to send an input event to a destination failed.

Reasons for failure could be the surface disappearing from the scene, before the response was received. Or the client not responding in time.

Implemented in mir::input::NullInputSendObserver.

virtual void mir::input::InputSendObserver::send_suceeded ( MirEvent const &  event,
input::Surface surface,
InputResponse  response 
)
pure virtual

Client responded to an input event.

Implemented in mir::input::NullInputSendObserver.


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

Copyright © 2012,2013 Canonical Ltd.
Generated on Tue Mar 24 16:15:19 UTC 2015