← Back to branch summary

~ubuntu-branches/ubuntu/wily/mir/wily-proposed

« back to all changes in this revision

Viewing changes to src/include/server/mir/input/input_send_observer.h

  • Committer: Package Import Robot
  • Author(s): Ubuntu daily release
  • Date: 2014-10-10 14:01:26 UTC
  • mto: This revision was merged to the branch mainline in revision 84.
  • Revision ID: package-import@ubuntu.com-20141010140126-n1czko8na1kuz4ll
Tags: upstream-0.8.0+14.10.20141010
Import upstream version 0.8.0+14.10.20141010

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/include/server/mir/input/input_send_observer.h
 
1
/*
 
2
 * Copyright © 2014 Canonical Ltd.
 
3
 *
 
4
 * This program is free software: you can redistribute it and/or modify it
 
5
 * under the terms of the GNU General Public License version 3,
 
6
 * as published by the Free Software Foundation.
 
7
 *
 
8
 * This program is distributed in the hope that it will be useful,
 
9
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
 * GNU General Public License for more details.
 
12
 *
 
13
 * You should have received a copy of the GNU General Public License
 
14
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
15
 *
 
16
 * Authored by: Andreas Pokorny <andreas.pokorny@canonical.com>
 
17
 */
 
18
 
 
19
#ifndef MIR_INPUT_INPUT_SEND_OBSERVER_H_
 
20
#define MIR_INPUT_INPUT_SEND_OBSERVER_H_
 
21
 
 
22
#include <mir_toolkit/event.h>
 
23
 
 
24
#include <memory>
 
25
 
 
26
namespace mir
 
27
{
 
28
namespace input
 
29
{
 
30
class Surface;
 
31
 
 
32
class InputSendObserver
 
33
{
 
34
public:
 
35
    InputSendObserver() = default;
 
36
    virtual ~InputSendObserver() = default;
 
37
 
 
38
    enum FailureReason
 
39
    {
 
40
        surface_disappeared,
 
41
        no_response_received,
 
42
        socket_error
 
43
    };
 
44
    /*!
 
45
     * \brief An attempt to send an input event to a destination failed.
 
46
     *
 
47
     * Reasons for failure could be the surface disappearing from the scene, before the response
 
48
     * was received. Or the client not responding in time.
 
49
     */
 
50
    virtual void send_failed(MirEvent const& event, input::Surface* surface, FailureReason reason) = 0;
 
51
 
 
52
    enum InputResponse
 
53
    {
 
54
        consumed,
 
55
        not_consumed
 
56
    };
 
57
    /*!
 
58
     * \brief Client responded to an input event.
 
59
     */
 
60
    virtual void send_suceeded(MirEvent const& event, input::Surface* surface, InputResponse response) = 0;
 
61
 
 
62
    /*!
 
63
     * \brief Called when client is temporary blocked because input events are still in
 
64
     * the queue.
 
65
     */
 
66
    virtual void client_blocked(MirEvent const& event, input::Surface* client) = 0;
 
67
 
 
68
protected:
 
69
    InputSendObserver& operator=(InputSendObserver const&) = delete;
 
70
    InputSendObserver(InputSendObserver const&) = delete;
 
71
};
 
72
 
 
73
}
 
74
}
 
75
 
 
76
#endif