summaryrefslogtreecommitdiff log msg author committer range
path: root/include/netsurf/window.h
blob: e396f782061c99a3dce25c96b9f8453e169515ee (plain)
 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 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373  /* * Copyright 2014 Vincent Sanders * * 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 . */ /** * \file * * Interface to platform-specific graphical user interface window * operations. */ #ifndef NETSURF_WINDOW_H #define NETSURF_WINDOW_H #include "netsurf/console.h" struct browser_window; struct form_control; struct rect; struct hlcache_handle; struct nsurl; enum gui_pointer_shape; typedef enum gui_save_type { GUI_SAVE_SOURCE, GUI_SAVE_DRAW, GUI_SAVE_PDF, GUI_SAVE_TEXT, GUI_SAVE_COMPLETE, GUI_SAVE_OBJECT_ORIG, GUI_SAVE_OBJECT_NATIVE, GUI_SAVE_LINK_URI, GUI_SAVE_LINK_URL, GUI_SAVE_LINK_TEXT, GUI_SAVE_HOTLIST_EXPORT_HTML, GUI_SAVE_HISTORY_EXPORT_HTML, GUI_SAVE_TEXT_SELECTION, GUI_SAVE_CLIPBOARD_CONTENTS } gui_save_type; typedef enum { GDRAGGING_NONE, GDRAGGING_SCROLLBAR, GDRAGGING_SELECTION, GDRAGGING_OTHER } gui_drag_type; /** * Window creation control flags. */ typedef enum { GW_CREATE_NONE = 0, /**< New window */ GW_CREATE_CLONE = (1 << 0), /**< Clone existing window */ GW_CREATE_TAB = (1 << 1) /**< Create tab in same window as existing */ } gui_window_create_flags; /** * Window events * * these are events delivered to a gui window which have no additional * parameters and hence do not require separate callbacks. */ enum gui_window_event { /** * An empty event should never occour */ GW_EVENT_NONE = 0, /** * Update the extent of the inside of a browser window to that of the * current content. * * @todo this is used to update scroll bars does it need * renaming? some frontends (windows) do not even implement it. */ GW_EVENT_UPDATE_EXTENT, /** * Remove the caret, if present. */ GW_EVENT_REMOVE_CARET, /** * start the navigation throbber. */ GW_EVENT_START_THROBBER, /** * stop the navigation throbber. */ GW_EVENT_STOP_THROBBER, /** * Starts drag scrolling of a browser window */ GW_EVENT_SCROLL_START, /** * Called when the gui_window has new content. */ GW_EVENT_NEW_CONTENT, /** * selection started */ GW_EVENT_START_SELECTION, }; /** * Graphical user interface window function table. * * function table implementing window operations */ struct gui_window_table { /* Mandatory entries */ /** * Create and open a gui window for a browsing context. * * The implementing front end must create a context suitable * for it to display a window referred to as the "gui window". * * The frontend will be expected to request the core redraw * areas of the gui window which have become invalidated * either from toolkit expose events or as a result of a * invalidate() call. * * Most core operations used by the frontend concerning browser * windows require passing the browser window context therefor * the gui window must include a reference to the browser * window passed here. * * If GW_CREATE_CLONE flag is set existing is non-NULL. * * \param bw The core browsing context associated with the gui window * \param existing An existing gui_window, may be NULL. * \param flags flags to control the gui window creation. * \return gui window, or NULL on error. */ struct gui_window *(*create)(struct browser_window *bw, struct gui_window *existing, gui_window_create_flags flags); /** * Destroy previously created gui window * * \param gw The gui window to destroy. */ void (*destroy)(struct gui_window *gw); /** * Invalidate an area of a window. * * The specified area of the window should now be considered * out of date. If the area is NULL the entire window must be * invalidated. It is expected that the windowing system will * then subsequently cause redraw/expose operations as * necessary. * * \note the frontend should not attempt to actually start the * redraw operations as a result of this callback because the * core redraw functions may already be threaded. * * \param gw The gui window to invalidate. * \param rect area to redraw or NULL for the entire window area * \return NSERROR_OK on success or appropriate error code */ nserror (*invalidate)(struct gui_window *gw, const struct rect *rect); /** * Get the scroll position of a browser window. * * \param gw The gui window to obtain the scroll position from. * \param sx receives x ordinate of point at top-left of window * \param sy receives y ordinate of point at top-left of window * \return true iff successful */ bool (*get_scroll)(struct gui_window *gw, int *sx, int *sy); /** * Set the scroll position of a browser window. * * scrolls the viewport to ensure the specified rectangle of * the content is shown. * If the rectangle is of zero size i.e. x0 == x1 and y0 == y1 * the contents will be scrolled so the specified point in the * content is at the top of the viewport. * If the size of the rectangle is non zero the frontend may * add padding or centre the defined area or it may simply * align as in the zero size rectangle * * \param gw The gui window to scroll. * \param rect The rectangle to ensure is shown. * \return NSERROR_OK on success or appropriate error code. */ nserror (*set_scroll)(struct gui_window *gw, const struct rect *rect); /** * Find the current dimensions of a browser window's content area. * * This is used to determine the actual available drawing size * in pixels. This allows contents that can be dynamically * reformatted, such as HTML, to better use the available * space. * * \param gw The gui window to measure content area of. * \param width receives width of window * \param height receives height of window * \return NSERROR_OK on success and width and height updated * else error code. */ nserror (*get_dimensions)(struct gui_window *gw, int *width, int *height); /** * Miscelaneous event occoured for a window * * This is used to inform the frontend of window events which * require no additional parameters. * * \param gw The gui window the event occoured for * \param event Which event has occoured. * \return NSERROR_OK if teh event was processed else error code. */ nserror (*event)(struct gui_window *gw, enum gui_window_event event); /* Optional entries */ /** * Set the title of a window. * * \param gw The gui window to set title of. * \param title new window title */ void (*set_title)(struct gui_window *gw, const char *title); /** * Set the navigation url. * * \param gw window to update. * \param url The url to use as icon. */ nserror (*set_url)(struct gui_window *gw, struct nsurl *url); /** * Set a favicon for a gui window. * * \param gw window to update. * \param icon handle to object to use as icon. */ void (*set_icon)(struct gui_window *gw, struct hlcache_handle *icon); /** * Set the status bar message of a browser window. * * \param g gui_window to update * \param text new status text */ void (*set_status)(struct gui_window *g, const char *text); /** * Change mouse pointer shape * * \param g The gui window to change pointer shape in. * \param shape The new shape to change to. */ void (*set_pointer)(struct gui_window *g, enum gui_pointer_shape shape); /** * Place the caret in a browser window. * * \param g window with caret * \param x coordinates of caret * \param y coordinates of caret * \param height height of caret * \param clip clip rectangle, or NULL if none */ void (*place_caret)(struct gui_window *g, int x, int y, int height, const struct rect *clip); /** * start a drag operation within a window * * \param g window to start drag from. * \param type Type of drag to start * \param rect Confining rectangle of drag operation. * \return true if drag started else false. */ bool (*drag_start)(struct gui_window *g, gui_drag_type type, const struct rect *rect); /** * save link operation * * \param g window to save link from. * \param url The link url. * \param title The title of the link. * \return NSERROR_OK on success else appropriate error code. */ nserror (*save_link)(struct gui_window *g, struct nsurl *url, const char *title); /** * create a form select menu * * \param gw The gui window to open select menu form gadget in. * \param control The form control gadget handle. */ void (*create_form_select_menu)(struct gui_window *gw, struct form_control *control); /** * Called when file chooser gadget is activated * * \param gw The gui window to open file chooser in. * \param hl The content of the object. * \param gadget The form control gadget handle. */ void (*file_gadget_open)(struct gui_window *gw, struct hlcache_handle *hl, struct form_control *gadget); /** * object dragged to window * * \param gw The gui window to save dragged object of. * \param c The content of the object. * \param type the type of save. */ void (*drag_save_object)(struct gui_window *gw, struct hlcache_handle *c, gui_save_type type); /** * drag selection save * * \param gw The gui window to save dragged selection of. * \param selection The selection to save. */ void (*drag_save_selection)(struct gui_window *gw, const char *selection); /** * console logging happening. * * See \ref browser_window_console_log * * \param gw The gui window receiving the logging. * \param src The source of the logging message * \param msg The text of the logging message * \param msglen The length of the text of the logging message * \param flags Flags associated with the logging. */ void (*console_log)(struct gui_window *gw, browser_window_console_source src, const char *msg, size_t msglen, browser_window_console_flags flags); }; #endif