interaction.h

Go to the documentation of this file.

/*
 * Copyright 2004 James Bursa <bursa@users.sourceforge.net>
 *
 * 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
 * HTML content user interaction handling
 */
 
#ifndef NETSURF_HTML_INTERACTION_H
#define NETSURF_HTML_INTERACTION_H
 
#include "desktop/search.h" /* search flags enum */
 
/**
 * Context for scrollbar
 */
struct html_scrollbar_data {
        struct content *c;
        struct box *box;
};
 
/**
 * Handle mouse tracking (including drags) in an HTML content window.
 *
 * \param  c      content of type html
 * \param  bw     browser window
 * \param  mouse  state of mouse buttons and modifier keys
 * \param  x      coordinate of mouse
 * \param  y      coordinate of mouse
 */
nserror html_mouse_track(struct content *c, struct browser_window *bw,
                        browser_mouse_state mouse, int x, int y);
 
 
/**
 * Handle mouse clicks and movements in an HTML content window.
 *
 * This function handles both hovering and clicking. It is important that the
 * code path is identical (except that hovering doesn't carry out the action),
 * so that the status bar reflects exactly what will happen. Having separate
 * code paths opens the possibility that an attacker will make the status bar
 * show some harmless action where clicking will be harmful.
 *
 * \param c content of type html
 * \param bw browser window
 * \param mouse state of mouse buttons and modifier keys
 * \param x x coordinate of mouse
 * \param y y coordinate of mouse
 * \return NSERROR_OK or appropriate error code.
 */
nserror html_mouse_action(struct content *c, struct browser_window *bw,
                        browser_mouse_state mouse, int x, int y);
 
 
bool html_keypress(struct content *c, uint32_t key);
 
 
void html_overflow_scroll_callback(void *client_data,
                struct scrollbar_msg_data *scrollbar_data);
 
 
void html_search(struct content *c, void *context,
                search_flags_t flags, const char *string);
 
 
void html_search_clear(struct content *c);
 
 
/**
 * Set our drag status, and inform whatever owns the content
 *
 * \param html          HTML content
 * \param drag_type     Type of drag
 * \param drag_owner    What owns the drag
 * \param rect          Pointer movement bounds
 */
void html_set_drag_type(html_content *html, html_drag_type drag_type,
                union html_drag_owner drag_owner, const struct rect *rect);
 
 
/**
 * Set our selection status, and inform whatever owns the content
 *
 * \param html                  HTML content
 * \param selection_type        Type of selection
 * \param selection_owner       What owns the selection
 * \param read_only             True iff selection is read only
 */
void html_set_selection(html_content *html, html_selection_type selection_type,
                union html_selection_owner selection_owner, bool read_only);
 
 
/**
 * Set our input focus, and inform whatever owns the content
 *
 * \param html                  HTML content
 * \param focus_type            Type of input focus
 * \param focus_owner           What owns the focus
 * \param hide_caret            True iff caret to be hidden
 * \param x                     Carret x-coord rel to owner
 * \param y                     Carret y-coord rel to owner
 * \param height                Carret height
 * \param clip                  Carret clip rect
 */
void html_set_focus(html_content *html, html_focus_type focus_type,
                union html_focus_owner focus_owner, bool hide_caret,
                int x, int y, int height, const struct rect *clip);
 
 
#endif