Beginnings of new hotlist module, implemented with new treeview.

Currently it can only open, display and launch entries in an existing hotlist file.

TODO:
  - Generate defualt hotlist when file not found.
  - Add hotlist saving.
  - Allow adding to hotlist.
  - Allow hotlist editing.
  - Allow hotlist nodes to be moved by dragging.
  - Allow hotlist visit data to be updated.

1 files changed, 93 insertions, 0 deletions

diff --git a/desktop/hotlist.h b/desktop/hotlist.h
new file mode 100644
index 000000000..1fc37eada
--- /dev/null
+++ b/desktop/hotlist.h
@@ -0,0 +1,93 @@
+/*
+ * 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.
+ *
+ * \param url		URL for node being added
+ * \return NSERROR_OK on success, appropriate error otherwise
+ */
+nserror hotlist_add(nsurl *url);
+
+/**
+ * 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