diff options
author | Vincent Sanders <vince@kyllikki.org> | 2016-05-05 22:28:51 +0100 |
---|---|---|
committer | Vincent Sanders <vince@kyllikki.org> | 2016-05-15 13:44:34 +0100 |
commit | d21447d096a320a08b3efb2b8768fad0dcdcfd64 (patch) | |
tree | 1a83814b7c9e94b2f13c473261f23dd3a17dee64 /frontends/riscos/mouse.h | |
parent | 2cbb337756d9af5bda4d594964d446439f602551 (diff) | |
download | netsurf-d21447d096a320a08b3efb2b8768fad0dcdcfd64.tar.gz netsurf-d21447d096a320a08b3efb2b8768fad0dcdcfd64.tar.bz2 |
move frontends into sub directory
Diffstat (limited to 'frontends/riscos/mouse.h')
-rw-r--r-- | frontends/riscos/mouse.h | 110 |
1 files changed, 110 insertions, 0 deletions
diff --git a/frontends/riscos/mouse.h b/frontends/riscos/mouse.h new file mode 100644 index 000000000..6bc5c13e1 --- /dev/null +++ b/frontends/riscos/mouse.h @@ -0,0 +1,110 @@ +/* + * Copyright 2013 Stephen Fryatt <stevef@netsurf-browser.org> + * + * This file is part of NetSurf, http://www.netsurf-browser.org/ + * + * NetSurf is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; version 2 of the License. + * + * NetSurf is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + */ + + +/** \file + * Mouse dragging and tracking support interface for RISC OS. + */ + +#ifndef _NETSURF_RISCOS_MOUSE_H_ +#define _NETSURF_RISCOS_MOUSE_H_ + + +/** + * Process Null polls for any drags and mouse trackers that are currently + * active. + */ + +void ro_mouse_poll(void); + + +/** + * Start a drag, providing a function to be called when the Wimp_DragEnd event + * is received and optionally a tracking function to be called on null polls + * in between times. + * + * \param *drag_end Callback for when the drag terminates, or NULL for none. + * \param *drag_track Callback for mouse tracking during the drag, or NULL for + * none. + * \param *drag_cancel Callback for cancelling the drag, or NULL if the drag + * can't be cancelled. + * \param *data Data to be passed to the callback functions, or NULL. + */ + +void ro_mouse_drag_start(void (*drag_end)(wimp_dragged *dragged, void *data), + void (*drag_track)(wimp_pointer *pointer, void *data), + void (*drag_cancel)(void *data), void *data); + + +/** + * Process Wimp_DragEnd events by passing the details on to any registered + * event handler. + * + * \param *dragged The Wimp_DragEnd data block. + */ + +void ro_mouse_drag_end(wimp_dragged *dragged); + + +/** + * Start tracking the mouse in a window, providing a function to be called on + * null polls and optionally one to be called when it leaves the window. + * + * \param *poll_end Callback for when the pointer leaves the window, or + * NULL for none. Claimants can receive *leaving==NULL if + * a new tracker is started before a PointerLeaving event + * is received. + * \param *poll_track Callback for mouse tracking while the pointer remains + * in the window, or NULL for none. + * \param *data Data to be passed to the callback functions, or NULL. + */ + +void ro_mouse_track_start(void (*poll_end)(wimp_leaving *leaving, void *data), + void (*poll_track)(wimp_pointer *pointer, void *data), + void *data); + +/** + * Process Wimp_PointerLeaving events by terminating an active mouse track and + * passing the details on to any registered event handler. + * + * \param *leaving The Wimp_PointerLeaving data block. + */ + +void ro_mouse_pointer_leaving_window(wimp_leaving *leaving); + + +/** + * Kill any tracking events if the data pointers match the supplied pointer. + * + * \param *data The data of the client to be killed. + */ + +void ro_mouse_kill(void *data); + + +/** + * Return the desired polling interval to allow the mouse tracking to be + * carried out. + * + * \return Desired poll interval (0 for none required). + */ + +os_t ro_mouse_poll_interval(void); + +#endif + |