summaryrefslogtreecommitdiff
path: root/desktop/cookie_manager.h
blob: 11d03252eba009a8aa65ce0866ecbd243ca5b4f4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
/*
 * Copyright 2013 Michael Drake <tlsa@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
 * Cookie Manager (interface).
 */

#ifndef _NETSURF_DESKTOP_COOKIE_MANAGER_H_
#define _NETSURF_DESKTOP_COOKIE_MANAGER_H_

#include <stdbool.h>
#include <stdint.h>

#include "utils/errors.h"
#include "netsurf/mouse.h"

struct redraw_context;
struct cookie_data;
struct core_window_callback_table;
struct rect;

/**
 * Initialise the cookie manager.
 *
 * This iterates through the URL database, enumerating the cookies and
 * creates a treeview.
 *
 * This must be called before any other cookie_manager_* function.
 *
 * \param cw_t Callback table for core_window containing the treeview
 * \param core_window_handle The core_window in which the treeview is shown
 * \return NSERROR_OK on success, appropriate error otherwise
 */
nserror cookie_manager_init(struct core_window_callback_table *cw_t,
		void *core_window_handle);

/**
 * Finalise the cookie manager.
 *
 * This destroys the cookie manager treeview and the cookie manager module's
 * internal data.  After calling this if the cookie manager is required again,
 * cookie_manager_init must be called.
 *
 * \return NSERROR_OK on success, appropriate error otherwise
 */
nserror cookie_manager_fini(void);

/**
 * Add/update a cookie to the viewer. (Called by urldb.)
 *
 * \param data		Data of cookie being added/updated.
 * \return true (for urldb_iterate_entries)
 */
bool cookie_manager_add(const struct cookie_data *data);

/**
 * Remove a cookie from viewer. (Called by urldb.)
 *
 * \param data Data of cookie being removed.
 */
void cookie_manager_remove(const struct cookie_data *data);

/**
 * Set the cookie manager search string.
 *
 * \param string  Sering to set as search string.
 * \return NSERROR_OK on success, appropriate error otherwise
 */
nserror cookie_manager_set_search_string(
		const char *string);

/**
 * Redraw the cookies manager.
 *
 * \param x	X coordinate to render treeview at
 * \param y     Y coordinate to render treeview at
 * \param clip  Current clip rectangle (wrt tree origin)
 * \param ctx	Current redraw context
 */
void cookie_manager_redraw(int x, int y, struct rect *clip,
		const struct redraw_context *ctx);

/**
 * Handles all kinds of mouse action
 *
 * \param mouse		The current mouse state
 * \param x		X coordinate
 * \param y		Y coordinate
 */
void cookie_manager_mouse_action(enum browser_mouse_state mouse, int x, int y);

/**
 * Key press handling.
 *
 * \param key		The ucs4 character codepoint
 * \return true if the keypress is dealt with, false otherwise.
 */
bool cookie_manager_keypress(uint32_t key);

/**
 * Determine whether there is a selection
 *
 * \return true iff there is a selection
 */
bool cookie_manager_has_selection(void);

/**
 * Expand the treeview's nodes
 *
 * \param only_folders	Iff true, only folders are expanded.
 * \return NSERROR_OK on success, appropriate error otherwise
 */
nserror cookie_manager_expand(bool only_folders);

/**
 * Contract the treeview's nodes
 *
 * \param all		Iff false, only entries are contracted.
 * \return NSERROR_OK on success, appropriate error otherwise
 */
nserror cookie_manager_contract(bool all);

#endif