139 lines
4.0 KiB
C
139 lines
4.0 KiB
C
/*
|
|
* Copyright 2012 - 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_GLOBAL_HISTORY_H_
|
|
#define _NETSURF_DESKTOP_GLOBAL_HISTORY_H_
|
|
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
|
|
#include "utils/errors.h"
|
|
#include "netsurf/mouse.h"
|
|
|
|
struct core_window_callback_table;
|
|
struct redraw_context;
|
|
struct nsurl;
|
|
struct rect;
|
|
|
|
/**
|
|
* Initialise the global history.
|
|
*
|
|
* This iterates through the URL database, generating the global history data,
|
|
* and creates a treeview.
|
|
*
|
|
* This must be called before any other global_history_* 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 global_history_init(struct core_window_callback_table *cw_t,
|
|
void *core_window_handle);
|
|
|
|
/**
|
|
* Finalise the global history.
|
|
*
|
|
* This destroys the global history treeview and the global history module's
|
|
* internal data. After calling this if global history is required again,
|
|
* global_history_init must be called.
|
|
*
|
|
* \return NSERROR_OK on success, appropriate error otherwise
|
|
*/
|
|
nserror global_history_fini(void);
|
|
|
|
/**
|
|
* Add an entry to the global history.
|
|
*
|
|
* If the URL already exists in the global history, the old node is removed.
|
|
*
|
|
* \param url URL for node being added
|
|
* \return NSERROR_OK on success, appropriate error otherwise
|
|
*/
|
|
nserror global_history_add(struct nsurl *url);
|
|
|
|
/**
|
|
* Save global history to file (html)
|
|
*
|
|
* \param path The path to save history to
|
|
* \param title The title to give the document, or NULL for default
|
|
* \return NSERROR_OK on success, or appropriate error otherwise
|
|
*/
|
|
nserror global_history_export(const char *path, const char *title);
|
|
|
|
/**
|
|
* Redraw the global history.
|
|
*
|
|
* \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 global_history_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 global_history_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 global_history_keypress(uint32_t key);
|
|
|
|
/**
|
|
* Determine whether there is a selection
|
|
*
|
|
* \return true iff there is a selection
|
|
*/
|
|
bool global_history_has_selection(void);
|
|
|
|
/**
|
|
* Get the first selected node
|
|
*
|
|
* \param url Updated to the selected entry's address, or NULL
|
|
* \param title Updated to the selected entry's title, or NULL
|
|
* \return true iff global history has a selection
|
|
*/
|
|
bool global_history_get_selection(struct nsurl **url, const char **title);
|
|
|
|
/**
|
|
* Expand the treeview's nodes
|
|
*
|
|
* \param only_folders Iff true, only folders are expanded.
|
|
* \return NSERROR_OK on success, appropriate error otherwise
|
|
*/
|
|
nserror global_history_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 global_history_contract(bool all);
|
|
|
|
#endif
|