NetSurf
url_complete.h
Go to the documentation of this file.
1/*
2 * Copyright 2005 Richard Wilson <info@tinct.net>
3 *
4 * This file is part of NetSurf, http://www.netsurf-browser.org/
5 *
6 * NetSurf is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; version 2 of the License.
9 *
10 * NetSurf is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 */
18
19/** \file
20 * Central repository for URL data (interface).
21 */
22
23#ifndef _NETSURF_RISCOS_URLCOMPLETE_H_
24#define _NETSURF_RISCOS_URLCOMPLETE_H_
25
26#include <stdbool.h>
27#include <oslib/wimp.h>
28
29struct gui_window;
30
31/**
32 * Should be called when the caret is placed into a URL completion icon.
33 *
34 * \param *toolbar The toolbar to initialise URL completion for.
35 */
36
38
39
40/**
41 * Handles a keypress for URL completion
42 *
43 * \param *toolbar The toolbar to be updated.
44 * \param key the key pressed (as UTF32 code or
45 * wimp key + bit31 set)
46 * \return true to indicate keypress handled; else false.
47 */
48
49bool ro_gui_url_complete_keypress(struct toolbar *toolbar, uint32_t key);
50
51
52/**
53 * Move and resize the url completion window to match the toolbar.
54 *
55 * \param *toolbar The toolbar to update
56 * \param *open the wimp_open request (updated on exit)
57 */
58
59void ro_gui_url_complete_resize(struct toolbar *toolbar, wimp_open *open);
60
61
62/**
63 * Try to close the current url completion window
64 *
65 * \return whether the window was closed
66 */
67
69
70
71/**
72 * Redraws a section of the URL completion window
73 *
74 * \param redraw the area to redraw
75 */
76
77void ro_gui_url_complete_redraw(wimp_draw *redraw);
78
79
80/**
81 * Handle the pointer entering the URL completion window.
82 *
83 * \param *entering The pointer entering data block.
84 */
85
86void ro_gui_url_complete_entering(wimp_entering *entering);
87
88
89/**
90 * Handle mouse clicks in the URL completion window.
91 *
92 * \param pointer the pointer state
93 * \return whether the click was handled
94 */
95
96bool ro_gui_url_complete_click(wimp_pointer *pointer);
97
98#endif
99
first entry in window list
Definition: gui.c:297
RECT redraw
Area needing redraw.
Definition: window.h:70
void ro_gui_url_complete_start(struct toolbar *toolbar)
Should be called when the caret is placed into a URL completion icon.
Definition: url_complete.c:76
bool ro_gui_url_complete_keypress(struct toolbar *toolbar, uint32_t key)
Handles a keypress for URL completion.
Definition: url_complete.c:100
void ro_gui_url_complete_resize(struct toolbar *toolbar, wimp_open *open)
Move and resize the url completion window to match the toolbar.
Definition: url_complete.c:398
void ro_gui_url_complete_entering(wimp_entering *entering)
Handle the pointer entering the URL completion window.
Definition: url_complete.c:641
bool ro_gui_url_complete_click(wimp_pointer *pointer)
Handle mouse clicks in the URL completion window.
Definition: url_complete.c:667
bool ro_gui_url_complete_close(void)
Try to close the current url completion window.
Definition: url_complete.c:497
void ro_gui_url_complete_redraw(wimp_draw *redraw)
Redraws a section of the URL completion window.
Definition: url_complete.c:537