NetSurf
frames.h
Go to the documentation of this file.
1/*
2 * Copyright 2006 Richard Wilson <info@tinct.net>
3 *
4 * This file is part of NetSurf, http://www.netsurf-browser.org/
5 *
6 * NetSurf is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; version 2 of the License.
9 *
10 * NetSurf is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 */
18
19/**
20 * \file
21 * Frame and frameset creation and manipulation (interface).
22 */
23
24#ifndef NETSURF_DESKTOP_FRAMES_H_
25#define NETSURF_DESKTOP_FRAMES_H_
26
30
31/**
32 * Create and open iframes for a browser window.
33 *
34 * \param bw The browser window to create iframes for.
35 * \return NSERROR_OK or error code on faliure.
36 */
38
39/**
40 * Recalculate iframe positions following a resize.
41 *
42 * \param bw The browser window to reposition iframes for
43 */
45
46/**
47 * Invalidate an iframe causing a redraw.
48 *
49 * \param bw The browser window to invalidate
50 */
52
53/**
54 * Destroy iframes opened in browser_window_create_iframes()
55 *
56 * \param bw The browser window to destroy iframes for.
57 * \return NSERROR_OK
58 */
60
61/**
62 * Create and open a frameset for a browser window.
63 *
64 * \param[in,out] bw The browser window to create the frameset for
65 * \return NSERROR_OK or error code on faliure
66 */
68
71 browser_mouse_state mouse, int x, int y,
72 browser_pointer_shape *pointer);
73void browser_window_resize_frame(struct browser_window *bw, int x, int y);
74
75void browser_window_scroll_callback(void *client_data,
76 struct scrollbar_msg_data *scrollbar_data);
77
78
79/**
80 * Create, remove, and update browser window scrollbars
81 *
82 * \param bw The browser window
83 */
85
86#endif
nserror
Enumeration of error codes.
Definition: errors.h:29
nserror browser_window_destroy_iframes(struct browser_window *bw)
Destroy iframes opened in browser_window_create_iframes()
Definition: frames.c:307
void browser_window_recalculate_frameset(struct browser_window *bw)
Recalculate frameset positions following a resize.
Definition: frames.c:718
void browser_window_scroll_callback(void *client_data, struct scrollbar_msg_data *scrollbar_data)
Callback for (i)frame scrollbars.
Definition: frames.c:55
void browser_window_recalculate_iframes(struct browser_window *bw)
Recalculate iframe positions following a resize.
Definition: frames.c:291
bool browser_window_frame_resize_start(struct browser_window *bw, browser_mouse_state mouse, int x, int y, browser_pointer_shape *pointer)
Definition: frames.c:1039
void browser_window_handle_scrollbars(struct browser_window *bw)
Create, remove, and update browser window scrollbars.
Definition: frames.c:99
nserror browser_window_create_iframes(struct browser_window *bw)
Create and open iframes for a browser window.
Definition: frames.c:192
nserror browser_window_invalidate_iframe(struct browser_window *bw)
Invalidate an iframe causing a redraw.
Definition: frames.c:185
void browser_window_resize_frame(struct browser_window *bw, int x, int y)
Resize a browser window that is a frame.
Definition: frames.c:740
nserror browser_window_create_frameset(struct browser_window *bw)
Create and open a frameset for a browser window.
Definition: frames.c:693
browser_pointer_shape
Mouse pointer type.
Definition: mouse.h:135
browser_mouse_state
Mouse state: 1 is primary mouse button.
Definition: mouse.h:52
Browser window data.
Frame tree (frameset or frame tag)
Definition: html.h:108
Inline frame list (iframe tag)
Definition: html.h:131
scrollbar message context data
Definition: scrollbar.h:59