tbx  0.7.6
scrollrequestlistener.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 /*
26  * scrollrequestlistener.h
27  *
28  * Created on: 24 Nov 2010
29  * Author: alanb
30  */
31 
32 #ifndef TBX_SCROLLREQUESTLISTENER_H_
33 #define TBX_SCROLLREQUESTLISTENER_H_
34 
35 #include "listener.h"
36 #include "eventinfo.h"
37 #include "window.h"
38 
39 namespace tbx
40 {
41 
46 {
47 public:
55  EventInfo(id_block, poll_block)
56  {}
57 
61  const WindowOpenInfo &open_info() const {return *reinterpret_cast<WindowOpenInfo *>(&_data.word[0]);}
62 
67  {
68  PAGE_LEFT = -2,
69  LEFT = -1,
70  NONE_X = 0,
71  RIGHT = 1,
72  PAGE_RIGHT = 2
73  };
78  {
79  PAGE_DOWN = -2,
80  DOWN = -1,
81  NONE_Y = 0,
82  UP = 1,
83  PAGE_UP = 2
84  };
85 
90 
95 };
96 
104 {
105 public:
106  virtual ~ScrollRequestListener() {}
107 
116  virtual void scroll_request(const ScrollRequestEvent &event) = 0;
117 };
118 
119 }
120 
121 #endif /* TBX_SCROLLREQUESTLISTENER_H_ */
tbx::ScrollRequestEvent::open_info
const WindowOpenInfo & open_info() const
Window open information with details of visible area and current scroll setttings.
Definition: scrollrequestlistener.h:61
tbx::ScrollRequestEvent::NONE_Y
@ NONE_Y
No scrolling in Y direction.
Definition: scrollrequestlistener.h:81
tbx
A library for creating RISC OS toolbox applications.
Definition: abouttobeshownlistener.cc:35
tbx::ScrollRequestListener
Scroll request listener.
Definition: scrollrequestlistener.h:104
tbx::EventInfo::id_block
const IdBlock & id_block() const
IdBlock for the current event.
Definition: eventinfo.h:71
tbx::EventInfo::_data
PollBlock & _data
raw data from the event
Definition: eventinfo.h:53
tbx::ScrollRequestEvent::DOWN
@ DOWN
Scroll down by one.
Definition: scrollrequestlistener.h:80
tbx::ScrollRequestEvent::ScrollRequestEvent
ScrollRequestEvent(IdBlock &id_block, PollBlock &poll_block)
Construct the event from Toolbox and WIMP event data.
Definition: scrollrequestlistener.h:54
tbx::ScrollRequestEvent::ScrollYDirection
ScrollYDirection
Enumeration of how the window should be scrolled in the y direction.
Definition: scrollrequestlistener.h:78
tbx::PollBlock
Structure holding the raw data from a call to Wimp_Poll.
Definition: pollinfo.h:72
tbx::ScrollRequestEvent::NONE_X
@ NONE_X
No scrolling in X direction.
Definition: scrollrequestlistener.h:70
tbx::ScrollRequestEvent::RIGHT
@ RIGHT
Scroll right by one.
Definition: scrollrequestlistener.h:71
tbx::IdBlock
Information passed back by the Toolbox with each toolbox event providing information on where the eve...
Definition: pollinfo.h:42
tbx::ScrollRequestEvent::x_scroll
ScrollXDirection x_scroll() const
Direction requested for scroll in x direction.
Definition: scrollrequestlistener.h:89
tbx::ScrollRequestEvent::ScrollXDirection
ScrollXDirection
Enumeration of how the window should be scrolled in the X direction.
Definition: scrollrequestlistener.h:67
tbx::Listener
Base class for all toolbox event listeners.
Definition: listener.h:34
tbx::WindowOpenInfo
Class with details of window location on screen.
Definition: window.h:328
tbx::ScrollRequestEvent::PAGE_RIGHT
@ PAGE_RIGHT
Scroll right be one page.
Definition: scrollrequestlistener.h:72
tbx::ScrollRequestEvent::UP
@ UP
Scroll up by one.
Definition: scrollrequestlistener.h:82
tbx::ScrollRequestEvent::PAGE_UP
@ PAGE_UP
Scroll up by one page.
Definition: scrollrequestlistener.h:83
tbx::ScrollRequestEvent::LEFT
@ LEFT
Scroll left by one.
Definition: scrollrequestlistener.h:69
tbx::PollBlock::word
int word[64]
Array containing information return from Wimp_Poll.
Definition: pollinfo.h:76
tbx::ScrollRequestEvent
Information for ScrollRequest listener.
Definition: scrollrequestlistener.h:46
tbx::ScrollRequestListener::scroll_request
virtual void scroll_request(const ScrollRequestEvent &event)=0
Called when a scroll request event is generated.
tbx::ScrollRequestEvent::y_scroll
ScrollYDirection y_scroll() const
Direction requested for scroll in y direction.
Definition: scrollrequestlistener.h:94
tbx::ScrollRequestEvent::PAGE_DOWN
@ PAGE_DOWN
Scroll down by one page.
Definition: scrollrequestlistener.h:79
tbx::ScrollRequestEvent::PAGE_LEFT
@ PAGE_LEFT
Scroll left by one page.
Definition: scrollrequestlistener.h:68
tbx::EventInfo
Class to provide information on a toolbox event.
Definition: eventinfo.h:49