/usr/include/gnucash/gnc-html.h is in gnucash-common 1:2.6.15-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 | /********************************************************************
* gnc-html.h -- display html with gnc special tags *
* Copyright (C) 2000 Bill Gribble <grib@billgribble.com> *
* *
* This program 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; either version 2 of *
* the License, or (at your option) any later version. *
* *
* This program 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, contact: *
* *
* Free Software Foundation Voice: +1-617-542-5942 *
* 51 Franklin Street, Fifth Floor Fax: +1-617-542-2652 *
* Boston, MA 02110-1301, USA gnu@gnu.org *
\********************************************************************/
#ifndef GNC_HTML_H
#define GNC_HTML_H
/**
* A GncHtml object is an abstract base for an html engine used to display reports and
* charts in gnucash. It must be overridden to create specific objects using specific
* html engines (e.g. webkit).
*/
#include <glib-object.h>
G_BEGIN_DECLS
#define GNC_TYPE_HTML (gnc_html_get_type())
#define GNC_HTML(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), GNC_TYPE_HTML, GncHtml))
#define GNC_HTML_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), GNC_TYPE_HTML, GncHtmlClass))
#define GNC_IS_HTML(o) (G_TYPE_CHECK_INSTANCE_TYPE((o), GNC_TYPE_HTML))
#define GNC_IS_HTML_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE((o), GNC_TYPE_HTML))
#define GNC_HTML_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS((o), GNC_TYPE_HTML, GncHtmlClass))
GType gnc_html_get_type(void);
typedef struct _GncHtml GncHtml;
typedef struct _GncHtmlClass GncHtmlClass;
typedef struct _GncHtmlPrivate GncHtmlPrivate;
#include "gnc-html-extras.h"
/* The result structure of url handlers. Strings should be g_malloc'd
* by the handler and will be freed by gnc_html. */
typedef struct
{
/* The following members are used if the handler succeeds (returns TRUE). */
gboolean load_to_stream; /* If TRUE, the url should be loaded from
* a stream using the rest of the data in
* the struct into the original gnc_html
* object. If FALSE, the handler will
* perform all needed actions itself. */
URLType url_type; /* Defaults to original */
gchar* location; /* If NULL, use original (NULL is default) */
gchar* label; /* If NULL, use original (NULL is default) */
URLType base_type;
gchar* base_location;
/* The following members are used if the handler fails (returns FALSE). */
gchar* error_message;
} GNCURLResult;
typedef gboolean (* GncHTMLObjectCB)(GncHtml* html, gpointer eb,
gpointer data);
typedef gboolean (* GncHTMLStreamCB)(const gchar* location, gchar** data, int* datalen);
typedef gboolean (* GncHTMLUrlCB)(const gchar* location, const gchar* label,
gboolean new_window, GNCURLResult* result);
/**
* Registers a new URLType.
* returns TRUE if succesful, FALSE if type already exists.
*
* @param type New URL type
* @param prococol Protocol - should be an empty string if there is no corresponding protocol.
* @return TRUE if successful, FALSE if type already exists or protocol is NULL.
*/
gboolean gnc_html_register_urltype( URLType type, const gchar* protocol );
/**
* Initializes the html subsystem
*/
void gnc_html_initialize( void );
gchar* gnc_html_encode_string( const gchar* in );
gchar* gnc_html_decode_string( const gchar* in );
gchar* gnc_html_escape_newlines( const gchar* in );
gchar* gnc_html_unescape_newlines( const gchar* in );
/* object handlers deal with <object classid="foo"> objects in HTML.
* the handlers are looked up at object load time. */
void gnc_html_register_object_handler( const gchar* classid, GncHTMLObjectCB hand );
void gnc_html_unregister_object_handler( const gchar* classid );
/* stream handlers load data for particular URLTypes. */
void gnc_html_register_stream_handler( URLType url_type, GncHTMLStreamCB hand );
void gnc_html_unregister_stream_handler( URLType url_type );
/* handlers for particular URLTypes. */
void gnc_html_register_url_handler( URLType url_type, GncHTMLUrlCB hand );
void gnc_html_unregister_url_handler( URLType url_type );
#include "gnc-html-history.h"
typedef int (* GncHTMLUrltypeCB)(URLType ut);
typedef void (* GncHTMLFlyoverCB)(GncHtml* html, const gchar* url,
gpointer data);
typedef void (* GncHTMLLoadCB)(GncHtml* html, URLType type,
const gchar* location, const gchar* label,
gpointer data);
typedef int (* GncHTMLButtonCB)(GncHtml* html, GdkEventButton* event,
gpointer data);
struct _GncHtmlClass
{
GtkBinClass parent_class;
/* Methods */
void (*show_url)( GncHtml* html,
URLType type,
const gchar* location,
const gchar* label,
gboolean new_window_hint );
void (*show_data)( GncHtml* html, const gchar* data, int datalen );
void (*reload)( GncHtml* html, gboolean force_rebuild );
void (*copy_to_clipboard)( GncHtml* html );
gboolean (*export_to_file)( GncHtml* html, const gchar* file );
void (*print)( GncHtml* html, const gchar* jobname, gboolean export_pdf );
void (*cancel)( GncHtml* html );
URLType (*parse_url)( GncHtml* html, const gchar* url,
gchar** url_location, gchar** url_label );
void (*set_parent)( GncHtml* html, GtkWindow* parent );
};
struct _GncHtml
{
GtkBin parent_instance;
/*< private >*/
GncHtmlPrivate* priv;
};
/**
* Destroys a GncHtml object.
*
* @param html GncHtml object to destroy
*/
void gnc_html_destroy( GncHtml* html );
/**
* Displays a URL in a GncHtml object.
*
* @param html GncHtml object
*/
void gnc_html_show_url( GncHtml* html, URLType type, const gchar* location,
const gchar* label, gboolean new_window_hint );
/**
* Displays an HTML string in a GncHtml object.
*
* @param html GncHtml object
*/
void gnc_html_show_data( GncHtml* html, const gchar* data, int datalen );
/**
* Reloads the current GncHtml object.
*
* @param html GncHtml object
* @param view if TRUE, view is reloaded, if FALSE, report is recreated
*/
void gnc_html_reload( GncHtml* html, gboolean view );
/**
* Copies the html to the clipboard
*
* @param html GncHtml object
*/
void gnc_html_copy_to_clipboard( GncHtml* html );
/**
* Exports the html to an external file.
*
* @param html GncHtml object
* @param filename External file name
* @param TRUE if successful, FALSE if unsuccessful
*/
gboolean gnc_html_export_to_file( GncHtml* html, const gchar* filename );
/**
* Prints the report.
*
* @param html GncHtml object
* \param jobname A jobname for identifying this job, or to be used as an output file
* \param export_pdf If TRUE, only run a "print to PDF" operation in order to
* export this to pdf. If FALSE, run a normal printing dialog.
*/
void gnc_html_print( GncHtml* html, const gchar* jobname, gboolean export_pdf );
/**
* Cancels the current operation
*
* @param html GncHtml object
*/
void gnc_html_cancel( GncHtml* html );
/**
* Parses a URL into URI and label
*
* @param html GncHtml object
* @param url URL
* @param url_location Pointer where to store address of string containing main URI
* @param url_label Pointer where to store address of string containing label
*/
URLType gnc_html_parse_url( GncHtml* html, const gchar* url,
gchar** url_location, gchar** url_label );
/**
* Returns the history for this html engine
*
* @param html GncHtml object
* @return History
*/
gnc_html_history* gnc_html_get_history( GncHtml* html );
/**
* Returns the main widget for this html engine
*
* @param html GncHtml object
* @return Main widget
*/
GtkWidget* gnc_html_get_widget( GncHtml* html );
/**
* Sets the parent window for this html engine. The engine will be embedded in this parent.
*
* @param html GncHtml object
* @param parent Parent window
*/
void gnc_html_set_parent( GncHtml* html, GtkWindow* parent );
/* setting callbacks */
void gnc_html_set_urltype_cb( GncHtml* html, GncHTMLUrltypeCB urltype_cb );
void gnc_html_set_load_cb( GncHtml* html, GncHTMLLoadCB load_cb, gpointer data );
void gnc_html_set_flyover_cb( GncHtml* html, GncHTMLFlyoverCB newwin_cb, gpointer data );
void gnc_html_set_button_cb( GncHtml* html, GncHTMLButtonCB button_cb, gpointer data );
/* object handlers deal with <object classid="foo"> objects in HTML.
* the handlers are looked up at object load time. */
void gnc_html_register_object_handler( const gchar* classid, GncHTMLObjectCB hand );
void gnc_html_unregister_object_handler( const gchar* classid );
/* stream handlers load data for particular URLTypes. */
void gnc_html_register_stream_handler( URLType url_type, GncHTMLStreamCB hand );
void gnc_html_unregister_stream_handler( URLType url_type );
/* handlers for particular URLTypes. */
void gnc_html_register_url_handler( URLType url_type, GncHTMLUrlCB hand );
void gnc_html_unregister_url_handler( URLType url_type );
const gchar* gnc_html_get_embedded_param( gpointer eb, const gchar* param_name );
#endif
|