tbx  0.7.5
usereventlistener.h
1 /*
2  * tbx RISC OS toolbox library
3  *
4  * Copyright (C) 2010 Alan Buckley All Rights Reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the "Software"),
8  * to deal in the Software without restriction, including without limitation
9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  * and/or sell copies of the Software, and to permit persons to whom the
11  * Software is furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included
14  * in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22  * THE SOFTWARE.
23  */
24 
25 #ifndef TBX_USEREVENTLISTENER_H_
26 #define TBX_USEREVENTLISTENER_H_
27 
28 #include "listener.h"
29 #include "eventinfo.h"
30 
31 namespace tbx {
32 
37 class UserEvent : public EventInfo
38 {
39 public:
44  UserEvent(IdBlock &id_block, PollBlock &data) : EventInfo(id_block, data) {}
45 
49  PollBlock &data() {return _data;}
50 };
51 
63 public:
64  virtual ~UserEventListener() {};
65 
69  virtual void user_event(UserEvent &event) = 0;
70 };
71 
73 void user_event_router(IdBlock &id_block, PollBlock &data, Listener *listener);
75 
76 }
77 
78 #endif /* USEREVENTLISTENER_H_ */
A library for creating RISC OS toolbox applications.
Definition: abouttobeshownlistener.cc:34
PollBlock & data()
Return a PollBlock with the raw data of the event.
Definition: usereventlistener.h:49
PollBlock & _data
raw data from the event
Definition: eventinfo.h:53
Structure holding the raw data from a call to Wimp_Poll.
Definition: pollinfo.h:71
const IdBlock & id_block() const
IdBlock for the current event.
Definition: eventinfo.h:71
UserEvent class holds details for a UserEventListener.
Definition: usereventlistener.h:37
Class to provide information on a toolbox event.
Definition: eventinfo.h:48
Base class for all toolbox event listeners.
Definition: listener.h:33
UserEvent(IdBlock &id_block, PollBlock &data)
Construct a user event listener with references to the underlying toolbox event.
Definition: usereventlistener.h:44
A UserEventListener can be used to capture any event on an object or component.
Definition: usereventlistener.h:62
Information passed back by the Toolbox with each toolbox event providing information on where the eve...
Definition: pollinfo.h:41