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
|
/*
* 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/>.
*/
#ifndef _NETSURF_DESKTOP_HOTLIST_H_
#define _NETSURF_DESKTOP_HOTLIST_H_
#include <stdbool.h>
#include "desktop/core_window.h"
#include "utils/nsurl.h"
/**
* Initialise the hotlist.
*
* This opens the hotlist file, generating the hotlist data, and creates a
* treeview. If there's no hotlist file, it generates a default hotlist.
*
* This must be called before any other hotlist_* function.
*
* \param cw_t Callback table for core_window containing the treeview
* \param cw The core_window in which the treeview is shown
* \param path The path to hotlist file to load
* \return NSERROR_OK on success, appropriate error otherwise
*/
nserror hotlist_init(struct core_window_callback_table *cw_t,
void *core_window_handle, const char *path);
/**
* Finalise the hotlist.
*
* This destroys the hotlist treeview and the hotlist module's
* internal data. After calling this if hotlist is required again,
* hotlist_init must be called.
*
* \param path The path to save hotlist to
* \return NSERROR_OK on success, appropriate error otherwise
*/
nserror hotlist_fini(const char *path);
/**
* Add an entry to the hotlist for given URL.
*
* \param url URL for node being added
* \return NSERROR_OK on success, appropriate error otherwise
*/
nserror hotlist_add_url(nsurl *url);
/**
* Check whether given URL is present in hotlist
*
* \param url Address to look for in hotlist
* \return true iff url is present in hotlist, false otherwise
*/
bool hotlist_has_url(nsurl *url);
/**
* Remove any entries matching the given URL from the hotlist
*
* \param url Address to look for in hotlist
*/
void hotlist_remove_url(nsurl *url);
/**
* Update given URL, e.g. new visited data
*
* \param url Address to update entries for
*/
void hotlist_update_url(nsurl *url);
/**
* Add an entry to the hotlist for given Title/URL.
*
* \param url URL for entry to be added, or NULL
* \param title Title for entry being added, or NULL
* \param at_y Iff true, insert at y-offest
* \param y Y-offset in px from top of hotlist. Ignored if (!at_y).
* \return NSERROR_OK on success, appropriate error otherwise
*/
nserror hotlist_add_entry(nsurl *url, const char *title, bool at_y, int y);
/**
* Add a folder to the hotlist.
*
* \param url Title for folder being added, or NULL
* \param at_y Iff true, insert at y-offest
* \param y Y-offset in px from top of hotlist. Ignored if (!at_y).
* \return NSERROR_OK on success, appropriate error otherwise
*/
nserror hotlist_add_folder(const char *title, bool at_y, int y);
/**
* Redraw the hotlist.
*
* \param x X coordinate to render treeview at
* \param x Y coordinate to render treeview at
* \param clip Current clip rectangle (wrt tree origin)
* \param ctx Current redraw context
*/
void hotlist_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 hotlist_mouse_action(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.
*/
void hotlist_keypress(uint32_t key);
#endif
|
