NetSurf
cookies.h
Go to the documentation of this file.
1/*
2 * Copyright 2006 Richard Wilson <info@tinct.net>
3 * Copyright 2010 Stephen Fryatt <stevef@netsurf-browser.org>
4 *
5 * This file is part of NetSurf, http://www.netsurf-browser.org/
6 *
7 * NetSurf is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; version 2 of the License.
10 *
11 * NetSurf is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20/**
21 * \file
22 * Interface to riscos cookie viewing using riscos core window.
23 *
24 * The interface assumes there is only a single cookie window which is
25 * presented (shown) when asked for and hidden by usual toolkit
26 * mechanics.
27 *
28 * The destructor is called once during browser shutdown
29 */
30
31#ifndef NETSURF_RISCOS_COOKIES_H
32#define NETSURF_RISCOS_COOKIES_H
33
34/**
35 * initialise the cookies window template ready for subsequent use.
36 */
38
39/**
40 * make the cookie window visible.
41 *
42 * \return NSERROR_OK on success else appropriate error code on faliure.
43 */
44nserror ro_gui_cookies_present(const char *search_term);
45
46/**
47 * Free any resources allocated for the cookie window.
48 *
49 * \return NSERROR_OK on success else appropriate error code on faliure.
50 */
52
53/**
54 * check if window handle is for the cookies window
55 */
56bool ro_gui_cookies_check_window(wimp_w window);
57
58/**
59 * check if menu handle is for the cookies menu
60 */
61bool ro_gui_cookies_check_menu(wimp_menu *menu);
62
63#endif /* NETSURF_RISCOS_COOKIES_H */
nserror
Enumeration of error codes.
Definition: errors.h:29
nserror ro_gui_cookies_finalise(void)
Free any resources allocated for the cookie window.
Definition: cookies.c:478
bool ro_gui_cookies_check_window(wimp_w window)
check if window handle is for the cookies window
Definition: cookies.c:499
void ro_gui_cookies_initialise(void)
initialise the cookies window template ready for subsequent use.
Definition: cookies.c:471
bool ro_gui_cookies_check_menu(wimp_menu *menu)
check if menu handle is for the cookies menu
Definition: cookies.c:510
nserror ro_gui_cookies_present(const char *search_term)
make the cookie window visible.
Definition: cookies.c:449