summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorVincent Sanders <vince@kyllikki.org>2016-05-30 11:23:32 +0100
committerVincent Sanders <vince@kyllikki.org>2016-05-30 11:23:32 +0100
commitfe7eb85614244d5e0659c88431fbd9726fa33051 (patch)
treea206d3f52ccd7814cc4e010da1360454ae6e4675 /include
parentaa5090c85b6890f79d340ad2de6219237f2d6c4c (diff)
downloadnetsurf-fe7eb85614244d5e0659c88431fbd9726fa33051.tar.gz
netsurf-fe7eb85614244d5e0659c88431fbd9726fa33051.tar.bz2
move misc header into public API
Diffstat (limited to 'include')
-rw-r--r--include/netsurf/misc.h108
1 files changed, 108 insertions, 0 deletions
diff --git a/include/netsurf/misc.h b/include/netsurf/misc.h
new file mode 100644
index 000000000..399d93895
--- /dev/null
+++ b/include/netsurf/misc.h
@@ -0,0 +1,108 @@
+/*
+ * Copyright 2014 Vincent Sanders <vince@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
+ *
+ * Interface to platform-specific miscellaneous browser operation table.
+ */
+
+#ifndef _NETSURF_DESKTOP_GUI_MISC_H_
+#define _NETSURF_DESKTOP_GUI_MISC_H_
+
+struct form_control;
+struct gui_window;
+struct ssl_cert_info;
+struct nsurl;
+
+/**
+ * Graphical user interface browser misc function table.
+ *
+ * function table implementing GUI interface to miscelaneous browser
+ * functionality
+ */
+struct gui_misc_table {
+ /* Mandantory entries */
+
+ /**
+ * Schedule a callback.
+ *
+ * \param t interval before the callback should be made in ms or
+ * negative value to remove any existing callback.
+ * \param callback callback function
+ * \param p user parameter passed to callback function
+ * \return NSERROR_OK on sucess or appropriate error on faliure
+ *
+ * The callback function will be called as soon as possible
+ * after the timeout has elapsed.
+ *
+ * Additional calls with the same callback and user parameter will
+ * reset the callback time to the newly specified value.
+ *
+ */
+ nserror (*schedule)(int t, void (*callback)(void *p), void *p);
+
+ /**
+ * Warn the user of an event.
+ *
+ * \param[in] message A warning looked up in the message
+ * translation table
+ * \param[in] detail Additional text to be displayed or NULL.
+ * \return NSERROR_OK on success or error code if there was a
+ * faliure displaying the message to the user.
+ */
+ nserror (*warning)(const char *message, const char *detail);
+
+
+ /* Optional entries */
+
+ /**
+ * called to allow the gui to cleanup.
+ */
+ void (*quit)(void);
+
+ /**
+ * core has no fetcher for url
+ */
+ nserror (*launch_url)(struct nsurl *url);
+
+ /**
+ * Prompt the user to verify a certificate with issuse.
+ *
+ * \param url The URL being verified.
+ * \param certs The certificate to be verified
+ * \param num The number of certificates to be verified.
+ * \param cb Callback upon user decision.
+ * \param cbpw Context pointer passed to cb
+ */
+ void (*cert_verify)(struct nsurl *url, const struct ssl_cert_info *certs, unsigned long num, nserror (*cb)(bool proceed, void *pw), void *cbpw);
+
+ /**
+ * Prompt user for login
+ */
+ void (*login)(struct nsurl *url, const char *realm,
+ nserror (*cb)(bool proceed, void *pw), void *cbpw);
+
+ /**
+ * Prompt the user for a password for a PDF.
+ */
+ void (*pdf_password)(char **owner_pass, char **user_pass, char *path);
+
+};
+
+#endif