summaryrefslogtreecommitdiff
path: root/desktop
diff options
context:
space:
mode:
authorMichael Drake <tlsa@netsurf-browser.org>2011-05-09 22:49:17 +0000
committerMichael Drake <tlsa@netsurf-browser.org>2011-05-09 22:49:17 +0000
commitac447fc293d791bf3155903d7755768f7a2b48ee (patch)
tree8d09d0e6228e9fbc1a834769e4553e816c643bb4 /desktop
parent5c95b32756affc5ce3ef88f919da4e3f801d776e (diff)
downloadnetsurf-ac447fc293d791bf3155903d7755768f7a2b48ee.tar.gz
netsurf-ac447fc293d791bf3155903d7755768f7a2b48ee.tar.bz2
s/scroll/scrollbar/ and improve scrollbar widget comments.
svn path=/trunk/netsurf/; revision=12363
Diffstat (limited to 'desktop')
-rw-r--r--desktop/browser.c8
-rw-r--r--desktop/browser.h4
-rw-r--r--desktop/scroll.c805
-rw-r--r--desktop/scroll.h89
-rw-r--r--desktop/scrollbar.c826
-rw-r--r--desktop/scrollbar.h95
-rw-r--r--desktop/textinput.c67
7 files changed, 961 insertions, 933 deletions
diff --git a/desktop/browser.c b/desktop/browser.c
index e538e87f3..a7126a64b 100644
--- a/desktop/browser.c
+++ b/desktop/browser.c
@@ -539,7 +539,7 @@ nserror browser_window_callback(hlcache_handle *c,
browser_window_remove_caret(bw);
- bw->scroll = NULL;
+ bw->scrollbar = NULL;
gui_window_new_content(bw->window);
@@ -618,7 +618,7 @@ nserror browser_window_callback(hlcache_handle *c,
else if (c == bw->current_content) {
bw->current_content = NULL;
browser_window_remove_caret(bw);
- bw->scroll = NULL;
+ bw->scrollbar = NULL;
selection_init(bw->sel, NULL);
}
@@ -1509,8 +1509,8 @@ void browser_window_mouse_drag_end(struct browser_window *bw,
return;
}
- if (bw->scroll != NULL) {
- html_overflow_scroll_drag_end(bw->scroll, mouse, x, y);
+ if (bw->scrollbar != NULL) {
+ html_overflow_scroll_drag_end(bw->scrollbar, mouse, x, y);
return;
}
diff --git a/desktop/browser.h b/desktop/browser.h
index a9cba2ee7..b8961447e 100644
--- a/desktop/browser.h
+++ b/desktop/browser.h
@@ -111,7 +111,7 @@ struct browser_window {
/** Scroll capturing all mouse events, updated to any active HTML
* scrollbar, or NULL when no scrollbar drags active */
- struct scroll *scroll;
+ struct scrollbar *scrollbar;
/** Current fetch is download */
bool download;
@@ -184,7 +184,7 @@ struct browser_window {
int status_miss; /**< Number of times status was really updated. */
};
-struct browser_scroll_data {
+struct browser_scrollbar_data {
struct browser_window *bw;
struct box *box;
};
diff --git a/desktop/scroll.c b/desktop/scroll.c
deleted file mode 100644
index a5d9b24f4..000000000
--- a/desktop/scroll.c
+++ /dev/null
@@ -1,805 +0,0 @@
-/*
- * Copyright 2004-2008 James Bursa <bursa@users.sourceforge.net>
- * Copyright 2008 Michael Drake <tlsa@netsurf-browser.org>
- * Copyright 2009 Paul Blokus <paul_pl@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
- * Scroll widget (implementation).
- */
-
-#include <stdbool.h>
-#include <stdlib.h>
-
-#include "desktop/mouse.h"
-#include "desktop/scroll.h"
-#include "desktop/plotters.h"
-#include "desktop/plot_style.h"
-#include "utils/log.h"
-#include "utils/messages.h"
-#include "utils/utils.h"
-
-
-struct scroll {
- bool horizontal; /* Horizontal scroll if true, vertical if false
- */
- int length; /* Length of the scroll widget */
-
- int scrolled_d; /* The dimension of the scrolled area */
- int scrolled_vis; /* The visible part of the scrolled area */
-
- int area_scroll; /* Scroll value of the scrolled area */
- int bar_off; /* Offset of the scrollbar */
- int bar_len; /* Length of the scrollbar */
-
- scroll_client_callback client_callback; /* Callback receiving scroll
- events */
- void *client_data; /* User data passed to the callback */
-
- bool dragging; /* Flag indicating drag at progess */
- int drag_start_coord; /* Coordinate value at drag start */
- int drag_start_bar_off; /* Scrollbar offset at drag start */
- bool reverse; /* Flag indicating that the scroll should move
- * in the opposite direction than the mouse does
- */
-
- struct scroll *pair; /* Parpendicular scroll */
- bool pair_drag; /* Flag indicating that the current drag affects
- also the pair scroll */
-};
-
-
-/** Overflow scrollbar colours
- *
- * Overflow scrollbar colours can be set by front end code to try to match
- * scrollbar colours used on the desktop.
- *
- * If a front end doesn't set scrollbar colours, these defaults are used.
- */
-colour scroll_widget_fg_colour = 0x00d9d9d9; /* light grey */
-colour scroll_widget_bg_colour = 0x006b6b6b; /* mid grey */
-colour scroll_widget_arrow_colour = 0x00444444; /* dark grey */
-
-
-/**
- * Create a scroll.
- *
- * \param horizontal true for a horizontal scrollbar false for a
- * vertical one
- * \param length full length of the scroll widget
- * \param scrolled_dimension full length of the scrolled area
- * \param scrolled_visible length of the visible part of the scrolled area
- * \param client_data data for the client callback
- * \param client_callback client callback for scroll events
- * \param scroll_pt gets updated to point at the newly created
- * scroll
- * \return true if the scroll has been created succesfully
- * or false on memory exhaustion
- */
-
-bool scroll_create(bool horizontal, int length,
- int scrolled_dimension, int scrolled_visible,
- void *client_data, scroll_client_callback client_callback,
- struct scroll **scroll_pt)
-{
- struct scroll *scroll;
- int well_length;
-
- scroll = malloc(sizeof(struct scroll));
- if (scroll == NULL) {
- LOG(("malloc failed"));
- warn_user("NoMemory", 0);
- *scroll_pt = NULL;
- return false;
- }
-
- scroll->horizontal = horizontal;
- scroll->length = length;
- scroll->scrolled_d = scrolled_dimension;
- scroll->scrolled_vis = scrolled_visible;
- scroll->area_scroll = 0;
- scroll->bar_off = 0;
- scroll->reverse = false;
- scroll->pair = NULL;
- scroll->pair_drag = false;
-
- well_length = length - 2 * SCROLLBAR_WIDTH;
- scroll->bar_len = (well_length * scrolled_visible) / scrolled_dimension;
-
- scroll->client_callback = client_callback;
- scroll->client_data = client_data;
-
- scroll->dragging = false;
-
- *scroll_pt = scroll;
-
- return true;
-}
-
-
-/**
- * Destroy a scroll.
- *
- * \param scroll the scroll to be destroyed
- */
-
-void scroll_destroy(struct scroll *scroll)
-{
- if (scroll->pair != NULL)
- scroll->pair->pair = NULL;
- free(scroll);
-}
-
-
-/**
- * Draw an outline rectangle common to a few of scroll elements.
- *
- * \param x0 left border of the outline
- * \param y0 top border of the outline
- * \param x1 right border of the outline
- * \param y1 bottom border of the outline
- * \param c base colour of the outline, the other colours are created by
- * lightening or darkening this one
- * \param inset true for inset outline, false for an outset one
- * \return
- */
-
-static inline bool scroll_redraw_scrollbar_rectangle(
- int x0, int y0, int x1, int y1, colour c, bool inset)
-{
- static plot_style_t c0 = {
- .stroke_type = PLOT_OP_TYPE_SOLID,
- .stroke_width = 1,
- };
-
- static plot_style_t c1 = {
- .stroke_type = PLOT_OP_TYPE_SOLID,
- .stroke_width = 1,
- };
-
- static plot_style_t c2 = {
- .stroke_type = PLOT_OP_TYPE_SOLID,
- .stroke_width = 1,
- };
-
- if (inset) {
- c0.stroke_colour = darken_colour(c);
- c1.stroke_colour = lighten_colour(c);
- } else {
- c0.stroke_colour = lighten_colour(c);
- c1.stroke_colour = darken_colour(c);
- }
- c2.stroke_colour = blend_colour(c0.stroke_colour, c1.stroke_colour);
-
- if (!plot.line(x0, y0, x1, y0, &c0)) return false;
- if (!plot.line(x1, y0, x1, y1 + 1, &c1)) return false;
- if (!plot.line(x1, y0, x1, y0 + 1, &c2)) return false;
- if (!plot.line(x1, y1, x0, y1, &c1)) return false;
- if (!plot.line(x0, y1, x0, y0, &c0)) return false;
- if (!plot.line(x0, y1, x0, y1 + 1, &c2)) return false;
- return true;
-}
-
-
-/**
- * Redraw a part of the scroll.
- *
- * \param scroll the scroll to be redrawn
- * \param x the X coordinate to draw the scroll at
- * \param y the Y coordinate to draw the scroll at
- * \param clip the clipping rectangle
- * \param scale scale for the redraw
- * \return true on succes false otherwise
- */
-
-bool scroll_redraw(struct scroll *scroll, int x, int y,
- const struct rect *clip, float scale)
-{
- int w = SCROLLBAR_WIDTH;
- int well_length, bar_off, bar_c0, bar_c1;
- int v[6]; /* array of triangle vertices */
- int x0, y0, x1, y1;
- plot_style_t pstyle_scroll_widget_bg_colour = {
- .fill_type = PLOT_OP_TYPE_SOLID,
- .fill_colour = scroll_widget_bg_colour,
- };
- plot_style_t pstyle_scroll_widget_fg_colour = {
- .fill_type = PLOT_OP_TYPE_SOLID,
- .fill_colour = scroll_widget_fg_colour,
- };
- plot_style_t pstyle_scroll_widget_arrow_colour = {
- .fill_type = PLOT_OP_TYPE_SOLID,
- .fill_colour = scroll_widget_arrow_colour,
- };
-
- well_length = scroll->length - 2 * SCROLLBAR_WIDTH;
- x0 = x;
- y0 = y;
- x1 = x + (scroll->horizontal ?
- scroll->length : SCROLLBAR_WIDTH) - 1;
- y1 = y + (scroll->horizontal ? SCROLLBAR_WIDTH : scroll->length) - 1;
- bar_off = scroll->bar_off;
- bar_c1 = (scroll->horizontal ? x0 : y0) + SCROLLBAR_WIDTH +
- scroll->bar_off + scroll->bar_len - 1;
-
- if (scale != 1.0) {
- w *= scale;
- well_length *= scale;
- x0 *= scale;
- y0 *= scale;
- x1 *= scale;
- y1 *= scale;
- bar_off *= scale;
- bar_c1 *= scale;
- }
-
- bar_c0 = (scroll->horizontal ? x0 : y0) + w + bar_off;
-
- if (x1 < clip->x0 || y1 < clip->y0 || clip->x1 < x0 || clip->y1 < y0)
- /* scrollbar is outside the clipping rectangle, nothing to
- * render */
- return true;
-
-
- if (scroll->horizontal) {
- /* scroll is horizontal */
-
- /* scrollbar outline */
- if (!scroll_redraw_scrollbar_rectangle(x0, y0, x1, y1,
- scroll_widget_bg_colour, true))
- return false;
- /* left arrow icon border */
- if (!scroll_redraw_scrollbar_rectangle(x0 + 1,
- y0 + 1,
- x0 + w - 2,
- y1 - 1,
- scroll_widget_fg_colour, false))
- return false;
- /* left arrow icon background */
- if (!plot.rectangle(x0 + 2,
- y0 + 2,
- x0 + w - 2,
- y1 - 1,
- &pstyle_scroll_widget_fg_colour))
- return false;
- /* left arrow */
- v[0] = x0 + w / 4;
- v[1] = y0 + w / 2;
- v[2] = x0 + w * 3 / 4;
- v[3] = y0 + w / 4;
- v[4] = x0 + w * 3 / 4;
- v[5] = y0 + w * 3 / 4;
- if (!plot.polygon(v, 3, &pstyle_scroll_widget_arrow_colour))
- return false;
- /* scroll well background */
- if (!plot.rectangle(x0 + w - 1,
- y0 + 1,
- x1 - w + 2,
- y1,
- &pstyle_scroll_widget_bg_colour))
- return false;
- /* scroll position indicator bar */
- if (!scroll_redraw_scrollbar_rectangle(bar_c0,
- y0 + 1,
- bar_c1,
- y1 - 1,
- scroll_widget_fg_colour, false))
- return false;
- if (!plot.rectangle(bar_c0 + 1,
- y0 + 2,
- bar_c1,
- y1 - 1,
- &pstyle_scroll_widget_fg_colour))
- return false;
- /* right arrow icon border */
- if (!scroll_redraw_scrollbar_rectangle(x1 - w + 2,
- y0 + 1,
- x1 - 1,
- y1 - 1,
- scroll_widget_fg_colour, false))
- return false;
- /* right arrow icon background */
- if (!plot.rectangle(x1 - w + 3,
- y0 + 2,
- x1 - 1,
- y1 - 1,
- &pstyle_scroll_widget_fg_colour))
- return false;
- /* right arrow */
- v[0] = x1 - w / 4 + 1;
- v[1] = y0 + w / 2;
- v[2] = x1 - w * 3 / 4 + 1;
- v[3] = y0 + w / 4;
- v[4] = x1 - w * 3 / 4 + 1;
- v[5] = y0 + w * 3 / 4;
- if (!plot.polygon(v, 3, &pstyle_scroll_widget_arrow_colour))
- return false;
- } else {
- /* scroll is vertical */
-
- /* outline */
- if (!scroll_redraw_scrollbar_rectangle(x0, y0, x1, y1,
- scroll_widget_bg_colour,
- true))
- return false;
- /* top arrow background */
- if (!scroll_redraw_scrollbar_rectangle(x0 + 1,
- y0 + 1,
- x1 - 1,
- y0 + w - 2,
- scroll_widget_fg_colour,
- false))
- return false;
- if (!plot.rectangle(x0 + 2,
- y0 + 2,
- x1 - 1,
- y0 + w - 2,
- &pstyle_scroll_widget_fg_colour))
- return false;
- /* up arrow */
- v[0] = x0 + w / 2;
- v[1] = y0 + w / 4;
- v[2] = x0 + w / 4;
- v[3] = y0 + w * 3 / 4;
- v[4] = x0 + w * 3 / 4;
- v[5] = y0 + w * 3 / 4;
- if (!plot.polygon(v, 3, &pstyle_scroll_widget_arrow_colour))
- return false;
- /* scroll well background */
- if (!plot.rectangle(x0 + 1,
- y0 + w - 1,
- x1,
- y1 - w + 2,
- &pstyle_scroll_widget_bg_colour))
- return false;
- /* scroll position indicator bar */
- if (!scroll_redraw_scrollbar_rectangle(x0 + 1,
- bar_c0,
- x1 - 1,
- bar_c1,
- scroll_widget_fg_colour, false))
- return false;
- if (!plot.rectangle(x0 + 2,
- bar_c0 + 1,
- x1 - 1,
- bar_c1,
- &pstyle_scroll_widget_fg_colour))
- return false;
- /* bottom arrow background */
- if (!scroll_redraw_scrollbar_rectangle(x0 + 1,
- y1 - w + 2,
- x1 - 1,
- y1 - 1,
- scroll_widget_fg_colour, false))
- return false;
- if (!plot.rectangle(x0 + 2,
- y1 - w + 3,
- x1 - 1,
- y1 - 1,
- &pstyle_scroll_widget_fg_colour))
- return false;
- /* down arrow */
- v[0] = x0 + w / 2;
- v[1] = y1 - w / 4 + 1;
- v[2] = x0 + w / 4;
- v[3] = y1 - w * 3 / 4 + 1;
- v[4] = x0 + w * 3 / 4;
- v[5] = y1 - w * 3 / 4 + 1;
- if (!plot.polygon(v, 3, &pstyle_scroll_widget_arrow_colour))
- return false;
- }
-
- return true;
-}
-
-
-/**
- * Set the value of the scroll.
- *
- * \param scroll the scroll to have the value set
- * \param scroll_val the new value to be set
- * \param bar true if the value is for the scroll indication bar
- * offset, false if it is for the scrolled area one
- */
-
-void scroll_set(struct scroll *scroll, int scroll_val, bool bar)
-{
- int well_length;
- struct scroll_msg_data msg;
-
- if (scroll_val < 0)
- scroll_val = 0;
-
- if (scroll->scrolled_d == scroll->scrolled_vis)
- return;
-
- well_length = scroll->length - 2 * SCROLLBAR_WIDTH;
- if (bar) {
- if (scroll_val > well_length - scroll->bar_len)
- scroll->bar_off = well_length - scroll->bar_len;
- else
- scroll->bar_off = scroll_val;
-
- scroll->area_scroll = ((scroll->scrolled_d -
- scroll->scrolled_vis) * (scroll->bar_off)) /
- (well_length - scroll->bar_len);
-
- } else {
- if (scroll_val > scroll->scrolled_d - scroll->scrolled_vis)
- scroll->area_scroll = scroll->scrolled_d -
- scroll->scrolled_vis;
- else
- scroll->area_scroll = scroll_val;
-
- scroll->bar_off = (well_length * scroll->area_scroll) /
- scroll->scrolled_d;
- }
-
- msg.scroll = scroll;
- msg.msg = SCROLL_MSG_MOVED;
- msg.new_scroll = scroll->area_scroll;
- scroll->client_callback(scroll->client_data, &msg);
-
- msg.msg = SCROLL_MSG_REDRAW;
- msg.x0 = scroll->horizontal ? SCROLLBAR_WIDTH - 1: 0;
- msg.y0 = scroll->horizontal ? 0 : SCROLLBAR_WIDTH - 1;
- msg.x1 = (scroll->horizontal ?
- scroll->length - SCROLLBAR_WIDTH + 1: SCROLLBAR_WIDTH);
- msg.y1 = (scroll->horizontal ?
- SCROLLBAR_WIDTH : scroll->length - SCROLLBAR_WIDTH + 1);
- scroll->client_callback(scroll->client_data, &msg);
-}
-
-
-/**
- * Get the scroll offset for the visible part of the scrolled area.
- *
- * \param scroll the scroll to get the value from
- * \return scroll offset for the scrolled area
- */
-
-int scroll_get_offset(struct scroll *scroll)
-{
- if (scroll == NULL)
- return 0;
- return scroll->area_scroll;
-}
-
-
-/**
- * Set the length of the scroll and the visible or scrolled part of the scrolled
- * area.
- *
- * \param scroll the scroll to set the values for
- * \param length -1 or the new scroll length to be set
- * \param scrolled_visible -1 or the new value of the visible part of the
- * scrolled area to be set
- * \param scrolled_dimension -1 or the new dimension of the scrolled content
- */
-
-void scroll_set_extents(struct scroll *scroll, int length,
- int scrolled_visible, int scrolled_dimension)
-{
- int well_length;
-
- if (length != -1)
- scroll->length = length;
- if (scrolled_visible != -1)
- scroll->scrolled_vis = scrolled_visible;
- if (scrolled_dimension != -1)
- scroll->scrolled_d = scrolled_dimension;
-
- well_length = length - 2 * SCROLLBAR_WIDTH;
-
- scroll->bar_len = (well_length * scrolled_visible) /
- scroll->scrolled_d;
- scroll->bar_off = (well_length * scroll->area_scroll) /
- scroll->scrolled_d;
-}
-
-
-/**
- * Check the orientation of the scroll.
- *
- * \param scroll the scroll to check the orientation of
- * \return true for a horizontal scroll, false for a vertical one
- */
-
-bool scroll_is_horizontal(struct scroll *scroll)
-{
- return scroll->horizontal;
-}
-
-
-/**
- * Internal procedure used for staring a drag scroll for a scrollbar.
- *
- * \param scroll the scroll to start the drag for
- * \param x the X coordinate of the drag start
- * \param y the Y coordinate of the drag start
- * \param reverse whether this should be a reverse drag(used when the user
- * drags the content and the scrolls have to adjust)
- * \param pair whether the drag should start for the pair scroll too
- */
-
-static void scroll_drag_start_internal(struct scroll *scroll, int x, int y,
- bool reverse, bool pair)
-{
- struct scroll_msg_data msg;
-
- scroll->drag_start_coord = scroll->horizontal ? x : y;
- scroll->drag_start_bar_off = scroll->bar_off;
-
- scroll->dragging = true;
- scroll->reverse = reverse;
-
- msg.scroll = scroll;
-
- /* \todo - some proper numbers please! */
- if (scroll->horizontal) {
- msg.x0 = -1024;
- msg.x1 = 1024;
- msg.y0 = 0;
- msg.y1 = 0;
- } else {
- msg.x0 = 0;
- msg.x1 = 0;
- msg.y0 = -1024;
- msg.y1 = 1024;
- }
-
- if (pair && scroll->pair != NULL) {
- scroll->pair_drag = true;
-
- scroll->pair->drag_start_coord =
- scroll->pair->horizontal ? x : y;
-
- scroll->pair->drag_start_bar_off = scroll->pair->bar_off;
-
- scroll->pair->dragging = true;
- scroll->pair->reverse = reverse;
-
- if (scroll->pair->horizontal) {
- msg.x0 = -1024;
- msg.x1 = 1024;
- } else {
- msg.y0 = -1024;
- msg.y1 = 1024;
- }
- }
- msg.msg = SCROLL_MSG_SCROLL_START;
- scroll->client_callback(scroll->client_data, &msg);
-}
-
-
-/**
- * Handle mouse actions other then drag ends.
- *
- * \param scroll the scroll which gets the mouse action
- * \param mouse mouse state
- * \param x X coordinate of the mouse
- * \param y Y coordinate of the mouse
- * \return message for the status bar or NULL on failure
- */
-
-const char *scroll_mouse_action(struct scroll *scroll,
- browser_mouse_state mouse, int x, int y)
-{
- int x0, y0, x1, y1;
- int val;
- const char *status;
- bool h;
- /* we want mouse presses and mouse drags that were not started at
- * the scroll indication bar to be launching actions on the scroll area
- */
- bool but1 = ((mouse & BROWSER_MOUSE_PRESS_1) ||
- ((mouse & BROWSER_MOUSE_HOLDING_1) &&
- (mouse & BROWSER_MOUSE_DRAG_ON) &&
- !scroll->dragging));
- bool but2 = ((mouse & BROWSER_MOUSE_PRESS_2) ||
- ((mouse & BROWSER_MOUSE_HOLDING_2) &&
- (mouse & BROWSER_MOUSE_DRAG_ON) &&
- !scroll->dragging));
-
- h = scroll->horizontal;
-
- x0 = 0;
- y0 = 0;
- x1 = h ? scroll->length : SCROLLBAR_WIDTH;
- y1 = h ? SCROLLBAR_WIDTH : scroll->length;
-
- if (!scroll->dragging && !(x >= x0 && x <= x1 && y >= y0 && y <= y1)) {
- /* Not a drag and mouse outside scroll widget */
- return NULL;
- }
-
-
- if (h)
- val = x;
- else
- val = y;
-
- if (scroll->dragging) {
- val -= scroll->drag_start_coord;
- if (scroll->reverse)
- val = -val;
- if (val != 0)
- scroll_set(scroll, scroll->drag_start_bar_off + val,
- true);
- if (scroll->pair_drag) {
- scroll_mouse_action(scroll->pair, mouse, x, y);
- status = messages_get("ScrollBoth");
- } else
- status = messages_get(h ? "ScrollH" : "ScrollV");
-
- return status;
- }
-
- if (val < SCROLLBAR_WIDTH) {
- /* left/up arrow */
-
- status = messages_get(h ? "ScrollLeft" : "ScrollUp");
- if (but1)
- scroll_set(scroll, scroll->bar_off - SCROLLBAR_WIDTH,
- true);
- else if (but2)
- scroll_set(scroll, scroll->bar_off + SCROLLBAR_WIDTH,
- true);
-
- } else if (val < SCROLLBAR_WIDTH + scroll->bar_off) {
- /* well between left/up arrow and bar */
-
- status = messages_get(h ? "ScrollPLeft" : "ScrollPUp");
-
- if (but1)
- scroll_set(scroll, scroll->area_scroll - scroll->length,
- false);
- else if (but2)
- scroll_set(scroll, scroll->area_scroll + scroll->length,
- false);
-
- } else if (val > scroll->length - SCROLLBAR_WIDTH) {
- /* right/down arrow */
-
- status = messages_get(h ? "ScrollRight" : "ScrollDown");
-
- if (but1)
- scroll_set(scroll, scroll->bar_off + SCROLLBAR_WIDTH,
- true);
- else if (but2)
- scroll_set(scroll, scroll->bar_off - SCROLLBAR_WIDTH,
- true);
-
- } else if (val > SCROLLBAR_WIDTH + scroll->bar_off + scroll->bar_len) {
- /* well between right/down arrow and bar */
-
- status = messages_get(h ? "ScrollPRight" : "ScrollPDown");
- if (but1)
- scroll_set(scroll, scroll->area_scroll + scroll->length,
- false);
- else if (but2)
- scroll_set(scroll, scroll->area_scroll - scroll->length,
- false);
- }
- else {
- /* scroll indication bar */
-
- status = messages_get(h ? "ScrollH" : "ScrollV");
- }
-
-
- if (mouse & (BROWSER_MOUSE_DRAG_1 | BROWSER_MOUSE_DRAG_2) &&
- (val >= SCROLLBAR_WIDTH + scroll->bar_off
- && val < SCROLLBAR_WIDTH + scroll->bar_off +
- scroll->bar_len))
- /* The mouse event is a drag start and takes place at the scroll
- * indication bar.
- */
- scroll_drag_start_internal(scroll, x, y, false,
- (mouse & BROWSER_MOUSE_DRAG_2) ?
- true : false);
-
- return status;
-}
-
-
-/**
- * Handle end of mouse drags.
- *
- * \param scroll the scroll for which the drag ends
- * \param mouse mouse state
- * \param x X coordinate of the mouse
- * \param y Y coordinate of the mouse
- */
-
-void scroll_mouse_drag_end(struct scroll *scroll, browser_mouse_state mouse,
- int x, int y)
-{
- struct scroll_msg_data msg;
- int val;
-
- assert(scroll->dragging);
-
- val = (scroll->horizontal ? x : y) - scroll->drag_start_coord;
- if (scroll->reverse)
- val = -val;
- if (val != 0)
- scroll_set(scroll, scroll->drag_start_bar_off + val, true);
-
- scroll->dragging = false;
- scroll->reverse = false;
- if (scroll->pair_drag) {
- scroll->pair_drag = false;
-
- val = (scroll->pair->horizontal ? x : y) -
- scroll->pair->drag_start_coord;
- if (scroll->pair->reverse)
- val = -val;
- if (val != 0)
- scroll_set(scroll->pair,
- scroll->pair->drag_start_bar_off + val,
- true);
-
- scroll->pair->dragging = false;
- scroll->pair->reverse = false;
- }
- msg.scroll = scroll;
- msg.msg = SCROLL_MSG_SCROLL_FINISHED;
- scroll->client_callback(scroll->client_data, &msg);
-}
-
-
-/**
- * Called when the content, which is scrolled with some scrolls, is being
- * dragged so the scrolls have to adjust properly. If the content has both
- * scrolls and scroll_make_pair has beed called before only the one scroll which
- * will receive further mouse events has to be passed.
- *
- * \param scroll one of the the scrolls owned by the dragged content
- * \param x X coordinate of mouse during drag start
- * \param y Y coordinate of mouse during drag start
- */
-
-void scroll_start_content_drag(struct scroll *scroll, int x, int y)
-{
- scroll_drag_start_internal(scroll, x, y, true, true);
-}
-
-
-/**
- * Connect a horizontal and a vertical scroll into a pair so that they
- * co-operate during 2D drags.
- *
- * \param horizontal_scroll the scroll used for horizontal scrolling
- * \param vertical_scroll the scroll used for vertical scrolling
- */
-
-void scroll_make_pair(struct scroll *horizontal_scroll,
- struct scroll *vertical_scroll)
-{
- assert(horizontal_scroll->horizontal && !vertical_scroll->horizontal);
-
- horizontal_scroll->pair = vertical_scroll;
- vertical_scroll->pair = horizontal_scroll;
-}
-
-
-void *scroll_get_data(struct scroll *scroll)
-{
- return scroll->client_data;
-}
-
diff --git a/desktop/scroll.h b/desktop/scroll.h
deleted file mode 100644
index e34ebba6b..000000000
--- a/desktop/scroll.h
+++ /dev/null
@@ -1,89 +0,0 @@
-/*
- * Copyright 2009 Paul Blokus <paul_pl@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
- * Scroll widget (interface).
- */
-
-#ifndef _NETSURF_DESKTOP_SCROLL_H_
-#define _NETSURF_DESKTOP_SCROLL_H_
-
-#include <stdbool.h>
-
-#include "desktop/browser.h"
-
-#define SCROLLBAR_WIDTH 16
-
-struct scroll;
-
-typedef enum {
- SCROLL_MSG_REDRAW, /* the scrollbar requests a redraw */
- SCROLL_MSG_MOVED, /* the scroll value has changed */
- SCROLL_MSG_SCROLL_START, /* a scroll drag has started, all mouse
- * events should be passed to
- * the scrollbar regardless of the
- * coordinates
- */
- SCROLL_MSG_SCROLL_FINISHED, /* cancel the above */
-
-} scroll_msg;
-
-struct scroll_msg_data {
- struct scroll *scroll;
- scroll_msg msg;
- int new_scroll;
- int x0, y0, x1, y1;
-};
-
-/**
- * Client callback for the scroll.
- *
- * \param client_data user data passed at scroll creation
- * \param scroll_data struct all necessary message data
- */
-typedef void(*scroll_client_callback)(void *client_data,
- struct scroll_msg_data *scroll_data);
-
-bool scroll_create(bool horizontal, int length,
- int scrolled_dimension, int scrolled_visible,
- void *client_data, scroll_client_callback client_callback,
- struct scroll **scroll_pt);
-void scroll_destroy(struct scroll *scroll);
-bool scroll_redraw(struct scroll *scroll, int x, int y,
- const struct rect *clip, float scale);
-
-void scroll_set(struct scroll *scroll, int scroll_val, bool bar);
-int scroll_get_offset(struct scroll *scroll);
-
-void scroll_set_extents(struct scroll *scroll, int length,
- int scrolled_visible, int scrolled_dimension);
-
-bool scroll_is_horizontal(struct scroll *scroll);
-
-const char *scroll_mouse_action(struct scroll *scroll,
- browser_mouse_state mouse, int x, int y);
-void scroll_mouse_drag_end(struct scroll *scroll, browser_mouse_state mouse,
- int x, int y);
-void scroll_start_content_drag(struct scroll *scroll, int x, int y);
-
-void scroll_make_pair(struct scroll *horizontal_scroll,
- struct scroll *vertical_scroll);
-
-void *scroll_get_data(struct scroll *scroll);
-
-#endif
diff --git a/desktop/scrollbar.c b/desktop/scrollbar.c
new file mode 100644
index 000000000..2dfe0c9ef
--- /dev/null
+++ b/desktop/scrollbar.c
@@ -0,0 +1,826 @@
+/*
+ * Copyright 2004-2008 James Bursa <bursa@users.sourceforge.net>
+ * Copyright 2008 Michael Drake <tlsa@netsurf-browser.org>
+ * Copyright 2009 Paul Blokus <paul_pl@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
+ * Scrollbar widget (implementation).
+ */
+
+#include <stdbool.h>
+#include <stdlib.h>
+
+#include "desktop/mouse.h"
+#include "desktop/scrollbar.h"
+#include "desktop/plotters.h"
+#include "desktop/plot_style.h"
+#include "utils/log.h"
+#include "utils/messages.h"
+#include "utils/utils.h"
+
+
+struct scrollbar {
+ bool horizontal; /* Horizontal scrollbar if true, else vertical
+ */
+ int length; /* Length of the scrollbar widget */
+
+ int scrolled_d; /* The dimension of the scrolled area */
+ int scrolled_vis; /* The visible part of the scrolled area */
+
+ int area_scroll; /* Scroll value of the scrolled area */
+ int bar_off; /* Offset of the scrollbar */
+ int bar_len; /* Length of the scrollbar */
+
+ scrollbar_client_callback client_callback; /* Callback receiving
+ * scrollbar events */
+ void *client_data; /* User data passed to the callback */
+
+ bool dragging; /* Flag indicating drag at progess */
+ int drag_start_coord; /* Coordinate value at drag start */
+ int drag_start_bar_off; /* Scrollbar offset at drag start */
+ bool reverse; /* Flag indicating that the scrollbar moves
+ * in the opposite direction to the mouse
+ */
+
+ struct scrollbar *pair; /* Parpendicular scrollbar, or NULL */
+ bool pair_drag; /* Flag indicating that the current drag affects
+ the perpendicular scrollbar too */
+};
+
+
+/** Overflow scrollbar colours
+ *
+ * Overflow scrollbar colours can be set by front end code to try to match
+ * scrollbar colours used on the desktop.
+ *
+ * If a front end doesn't set scrollbar colours, these defaults are used.
+ */
+colour scrollbar_widget_fg_colour = 0x00d9d9d9; /* light grey */
+colour scrollbar_widget_bg_colour = 0x006b6b6b; /* mid grey */
+colour scrollbar_widget_arrow_colour = 0x00444444; /* dark grey */
+
+
+/**
+ * Create a scrollbar.
+ *
+ * \param horizontal true for a horizontal scrollbar false for a
+ * vertical one
+ * \param length full length of the scrollbar widget
+ * \param scrolled_dimension full length of the scrolled area
+ * \param scrolled_visible length of the visible part of the scrolled area
+ * \param client_data data for the client callback
+ * \param client_callback client callback for scrollbar events
+ * \param scrollbar gets updated to point at the newly created
+ * scrollbar
+ * \return true if scrollbar has been created succesfully
+ * or false on memory exhaustion
+ */
+
+bool scrollbar_create(bool horizontal, int length,
+ int scrolled_dimension, int scrolled_visible,
+ void *client_data, scrollbar_client_callback client_callback,
+ struct scrollbar **scrollbar_pt)
+{
+ struct scrollbar *scrollbar;
+ int well_length;
+
+ scrollbar = malloc(sizeof(struct scrollbar));
+ if (scrollbar == NULL) {
+ LOG(("malloc failed"));
+ warn_user("NoMemory", 0);
+ *scrollbar_pt = NULL;
+ return false;
+ }
+
+ scrollbar->horizontal = horizontal;
+ scrollbar->length = length;
+ scrollbar->scrolled_d = scrolled_dimension;
+ scrollbar->scrolled_vis = scrolled_visible;
+ scrollbar->area_scroll = 0;
+ scrollbar->bar_off = 0;
+ scrollbar->reverse = false;
+ scrollbar->pair = NULL;
+ scrollbar->pair_drag = false;
+
+ well_length = length - 2 * SCROLLBAR_WIDTH;
+ scrollbar->bar_len = (well_length * scrolled_visible) /
+ scrolled_dimension;
+
+ scrollbar->client_callback = client_callback;
+ scrollbar->client_data = client_data;
+
+ scrollbar->dragging = false;
+
+ *scrollbar_pt = scrollbar;
+
+ return true;
+}
+
+
+/**
+ * Destroy a scrollbar.
+ *
+ * \param scrollbar the scrollbar to be destroyed
+ */
+
+void scrollbar_destroy(struct scrollbar *scrollbar)
+{
+ if (scrollbar->pair != NULL)
+ scrollbar->pair->pair = NULL;
+ free(scrollbar);
+}
+
+
+/**
+ * Draw an outline rectangle common to a several scrollbar elements.
+ *
+ * \param x0 left border of the outline
+ * \param y0 top border of the outline
+ * \param x1 right border of the outline
+ * \param y1 bottom border of the outline
+ * \param c base colour of the outline, the other colours are created by
+ * lightening or darkening this one
+ * \param inset true for inset outline, false for an outset one
+ * \return
+ */
+
+static inline bool scrollbar_redraw_scrollbar_rectangle(int x0, int y0,
+ int x1, int y1, colour c, bool inset)
+{
+ static plot_style_t c0 = {
+ .stroke_type = PLOT_OP_TYPE_SOLID,
+ .stroke_width = 1,
+ };
+
+ static plot_style_t c1 = {
+ .stroke_type = PLOT_OP_TYPE_SOLID,
+ .stroke_width = 1,
+ };
+
+ static plot_style_t c2 = {
+ .stroke_type = PLOT_OP_TYPE_SOLID,
+ .stroke_width = 1,
+ };
+
+ if (inset) {
+ c0.stroke_colour = darken_colour(c);
+ c1.stroke_colour = lighten_colour(c);
+ } else {
+ c0.stroke_colour = lighten_colour(c);
+ c1.stroke_colour = darken_colour(c);
+ }
+ c2.stroke_colour = blend_colour(c0.stroke_colour, c1.stroke_colour);
+
+ /* Plot the outline */
+ if (!plot.line(x0, y0, x1, y0, &c0)) return false;
+ if (!plot.line(x1, y0, x1, y1 + 1, &c1)) return false;
+ if (!plot.line(x1, y0, x1, y0 + 1, &c2)) return false;
+ if (!plot.line(x1, y1, x0, y1, &c1)) return false;
+ if (!plot.line(x0, y1, x0, y0, &c0)) return false;
+ if (!plot.line(x0, y1, x0, y1 + 1, &c2)) return false;
+
+ return true;
+}
+
+
+/**
+ * Redraw a part of the scrollbar.
+ *
+ * \param scrollbar the scrollbar to be redrawn
+ * \param x the X coordinate to draw the scrollbar at
+ * \param y the Y coordinate to draw the scrollbar at
+ * \param clip the clipping rectangle
+ * \param scale scale for the redraw
+ * \return true on succes false otherwise
+ */
+
+bool scrollbar_redraw(struct scrollbar *scrollbar, int x, int y,
+ const struct rect *clip, float scale)
+{
+ int w = SCROLLBAR_WIDTH;
+ int well_length, bar_off, bar_c0, bar_c1;
+ int v[6]; /* array of triangle vertices */
+ int x0, y0, x1, y1;
+
+ plot_style_t pstyle_scrollbar_widget_bg_colour = {
+ .fill_type = PLOT_OP_TYPE_SOLID,
+ .fill_colour = scrollbar_widget_bg_colour,
+ };
+ plot_style_t pstyle_scrollbar_widget_fg_colour = {
+ .fill_type = PLOT_OP_TYPE_SOLID,
+ .fill_colour = scrollbar_widget_fg_colour,
+ };
+ plot_style_t pstyle_scrollbar_widget_arrow_colour = {
+ .fill_type = PLOT_OP_TYPE_SOLID,
+ .fill_colour = scrollbar_widget_arrow_colour,
+ };
+
+ well_length = scrollbar->length - 2 * SCROLLBAR_WIDTH;
+ x0 = x;
+ y0 = y;
+ x1 = x + (scrollbar->horizontal ?
+ scrollbar->length : SCROLLBAR_WIDTH) - 1;
+ y1 = y + (scrollbar->horizontal ?
+ SCROLLBAR_WIDTH : scrollbar->length) - 1;
+ bar_off = scrollbar->bar_off;
+ bar_c1 = (scrollbar->horizontal ? x0 : y0) + SCROLLBAR_WIDTH +
+ scrollbar->bar_off + scrollbar->bar_len - 1;
+
+ if (scale != 1.0) {
+ w *= scale;
+ well_length *= scale;
+ x0 *= scale;
+ y0 *= scale;
+ x1 *= scale;
+ y1 *= scale;
+ bar_off *= scale;
+ bar_c1 *= scale;
+ }
+
+ bar_c0 = (scrollbar->horizontal ? x0 : y0) + w + bar_off;
+
+ if (x1 < clip->x0 || y1 < clip->y0 || clip->x1 < x0 || clip->y1 < y0)
+ /* scrollbar is outside the clipping rectangle, nothing to
+ * render */
+ return true;
+
+
+ if (scrollbar->horizontal) {
+ /* scrollbar is horizontal */
+
+ /* scrollbar outline */
+ if (!scrollbar_redraw_scrollbar_rectangle(x0, y0, x1, y1,
+ scrollbar_widget_bg_colour, true))
+ return false;
+ /* left arrow icon border */
+ if (!scrollbar_redraw_scrollbar_rectangle(x0 + 1,
+ y0 + 1,
+ x0 + w - 2,
+ y1 - 1,
+ scrollbar_widget_fg_colour, false))
+ return false;
+ /* left arrow icon background */
+ if (!plot.rectangle(x0 + 2,
+ y0 + 2,
+ x0 + w - 2,
+ y1 - 1,
+ &pstyle_scrollbar_widget_fg_colour))
+ return false;
+ /* left arrow */
+ v[0] = x0 + w / 4;
+ v[1] = y0 + w / 2;
+ v[2] = x0 + w * 3 / 4;
+ v[3] = y0 + w / 4;
+ v[4] = x0 + w * 3 / 4;
+ v[5] = y0 + w * 3 / 4;
+ if (!plot.polygon(v, 3, &pstyle_scrollbar_widget_arrow_colour))
+ return false;
+ /* scrollbar well background */
+ if (!plot.rectangle(x0 + w - 1,
+ y0 + 1,
+ x1 - w + 2,
+ y1,
+ &pstyle_scrollbar_widget_bg_colour))
+ return false;
+ /* scrollbar position indicator bar */
+ if (!scrollbar_redraw_scrollbar_rectangle(bar_c0,
+ y0 + 1,
+ bar_c1,
+ y1 - 1,
+ scrollbar_widget_fg_colour, false))
+ return false;
+ if (!plot.rectangle(bar_c0 + 1,
+ y0 + 2,
+ bar_c1,
+ y1 - 1,
+ &pstyle_scrollbar_widget_fg_colour))
+ return false;
+ /* right arrow icon border */
+ if (!scrollbar_redraw_scrollbar_rectangle(x1 - w + 2,
+ y0 + 1,
+ x1 - 1,
+ y1 - 1,
+ scrollbar_widget_fg_colour, false))
+ return false;
+ /* right arrow icon background */
+ if (!plot.rectangle(x1 - w + 3,
+ y0 + 2,
+ x1 - 1,
+ y1 - 1,
+ &pstyle_scrollbar_widget_fg_colour))
+ return false;
+ /* right arrow */
+ v[0] = x1 - w / 4 + 1;
+ v[1] = y0 + w / 2;
+ v[2] = x1 - w * 3 / 4 + 1;
+ v[3] = y0 + w / 4;
+ v[4] = x1 - w * 3 / 4 + 1;
+ v[5] = y0 + w * 3 / 4;
+ if (!plot.polygon(v, 3, &pstyle_scrollbar_widget_arrow_colour))
+ return false;
+ } else {
+ /* scrollbar is vertical */
+
+ /* outline */
+ if (!scrollbar_redraw_scrollbar_rectangle(x0, y0, x1, y1,
+ scrollbar_widget_bg_colour,
+ true))
+ return false;
+ /* top arrow background */
+ if (!scrollbar_redraw_scrollbar_rectangle(x0 + 1,
+ y0 + 1,
+ x1 - 1,
+ y0 + w - 2,
+ scrollbar_widget_fg_colour,
+ false))
+ return false;
+ if (!plot.rectangle(x0 + 2,
+ y0 + 2,
+ x1 - 1,
+ y0 + w - 2,
+ &pstyle_scrollbar_widget_fg_colour))
+ return false;
+ /* up arrow */
+ v[0] = x0 + w / 2;
+ v[1] = y0 + w / 4;
+ v[2] = x0 + w / 4;
+ v[3] = y0 + w * 3 / 4;
+ v[4] = x0 + w * 3 / 4;
+ v[5] = y0 + w * 3 / 4;
+ if (!plot.polygon(v, 3, &pstyle_scrollbar_widget_arrow_colour))
+ return false;
+ /* scrollbar well background */
+ if (!plot.rectangle(x0 + 1,
+ y0 + w - 1,
+ x1,
+ y1 - w + 2,
+ &pstyle_scrollbar_widget_bg_colour))
+ return false;
+ /* scrollbar position indicator bar */
+ if (!scrollbar_redraw_scrollbar_rectangle(x0 + 1,
+ bar_c0,
+ x1 - 1,
+ bar_c1,
+ scrollbar_widget_fg_colour, false))
+ return false;
+ if (!plot.rectangle(x0 + 2,
+ bar_c0 + 1,
+ x1 - 1,
+ bar_c1,
+ &pstyle_scrollbar_widget_fg_colour))
+ return false;
+ /* bottom arrow background */
+ if (!scrollbar_redraw_scrollbar_rectangle(x0 + 1,
+ y1 - w + 2,
+ x1 - 1,
+ y1 - 1,
+ scrollbar_widget_fg_colour, false))
+ return false;
+ if (!plot.rectangle(x0 + 2,
+ y1 - w + 3,
+ x1 - 1,
+ y1 - 1,
+ &pstyle_scrollbar_widget_fg_colour))
+ return false;
+ /* down arrow */
+ v[0] = x0 + w / 2;
+ v[1] = y1 - w / 4 + 1;
+ v[2] = x0 + w / 4;
+ v[3] = y1 - w * 3 / 4 + 1;
+ v[4] = x0 + w * 3 / 4;
+ v[5] = y1 - w * 3 / 4 + 1;
+ if (!plot.polygon(v, 3, &pstyle_scrollbar_widget_arrow_colour))
+ return false;
+ }
+
+ return true;
+}
+
+
+/**
+ * Set the value of the scrollbar.
+ *
+ * \param scrollbar the scrollbar to have the value set
+ * \param scroll_val the new value to be set
+ * \param bar_pos true if the value is for the scrollbar indication bar
+ * offset, false if it is for the scrolled area one
+ */
+
+void scrollbar_set(struct scrollbar *scrollbar, int scroll_val, bool bar_pos)
+{
+ int well_length;
+ struct scrollbar_msg_data msg;
+
+ if (scroll_val < 0)
+ scroll_val = 0;
+
+ if (scrollbar->scrolled_d == scrollbar->scrolled_vis)
+ return;
+
+ well_length = scrollbar->length - 2 * SCROLLBAR_WIDTH;
+ if (bar_pos) {
+ if (scroll_val > well_length - scrollbar->bar_len)
+ scrollbar->bar_off = well_length - scrollbar->bar_len;
+ else
+ scrollbar->bar_off = scroll_val;
+
+ scrollbar->area_scroll = ((scrollbar->scrolled_d -
+ scrollbar->scrolled_vis) *
+ (scrollbar->bar_off)) /
+ (well_length - scrollbar->bar_len);
+
+ } else {
+ if (scroll_val > scrollbar->scrolled_d -
+ scrollbar->scrolled_vis)
+ scrollbar->area_scroll = scrollbar->scrolled_d -
+ scrollbar->scrolled_vis;
+ else
+ scrollbar->area_scroll = scroll_val;
+
+ scrollbar->bar_off = (well_length * scrollbar->area_scroll) /
+ scrollbar->scrolled_d;
+ }
+
+ msg.scrollbar = scrollbar;
+ msg.msg = SCROLLBAR_MSG_MOVED;
+ msg.new_scroll = scrollbar->area_scroll;
+ scrollbar->client_callback(scrollbar->client_data, &msg);
+
+ msg.msg = SCROLLBAR_MSG_REDRAW;
+ msg.x0 = scrollbar->horizontal ? SCROLLBAR_WIDTH - 1 : 0;
+ msg.y0 = scrollbar->horizontal ? 0 : SCROLLBAR_WIDTH - 1;
+ msg.x1 = (scrollbar->horizontal ?
+ scrollbar->length - SCROLLBAR_WIDTH + 1 :
+ SCROLLBAR_WIDTH);
+ msg.y1 = (scrollbar->horizontal ?
+ SCROLLBAR_WIDTH :
+ scrollbar->length - SCROLLBAR_WIDTH + 1);
+
+ scrollbar->client_callback(scrollbar->client_data, &msg);
+}
+
+
+/**
+ * Get the scroll offset for the visible part of the scrolled area.
+ *
+ * \param scrollbar the scrollbar to get the scroll offset value from
+ * \return scroll offset for the scrolled area
+ */
+
+int scrollbar_get_offset(struct scrollbar *scrollbar)
+{
+ if (scrollbar == NULL)
+ return 0;
+ return scrollbar->area_scroll;
+}
+
+
+/**
+ * Set the length of the scrollbar and the visible or scrolled part of the
+ * scrolled area.
+ *
+ * \param scrollbar the scrollbar to set the values for
+ * \param length -1 or the new scrollbar length to be set
+ * \param scrolled_visible -1 or the new value of the visible part of the
+ * scrolled area to be set
+ * \param scrolled_dimension -1 or the new dimension of the scrolled content
+ */
+
+void scrollbar_set_extents(struct scrollbar *scrollbar, int length,
+ int scrolled_visible, int scrolled_dimension)
+{
+ int well_length;
+
+ if (length != -1)
+ scrollbar->length = length;
+ if (scrolled_visible != -1)
+ scrollbar->scrolled_vis = scrolled_visible;
+ if (scrolled_dimension != -1)
+ scrollbar->scrolled_d = scrolled_dimension;
+
+ well_length = length - 2 * SCROLLBAR_WIDTH;
+
+ scrollbar->bar_len = (well_length * scrolled_visible) /
+ scrollbar->scrolled_d;
+ scrollbar->bar_off = (well_length * scrollbar->area_scroll) /
+ scrollbar->scrolled_d;
+}
+
+
+/**
+ * Check the orientation of the scrollbar.
+ *
+ * \param scrollbar the scrollbar to check the orientation of
+ * \return true for a horizontal scrollbar, else false (vertical
+ */
+
+bool scrollbar_is_horizontal(struct scrollbar *scrollbar)
+{
+ return scrollbar->horizontal;
+}
+
+
+/**
+ * Internal procedure used for starting a drag scroll for a scrollbar.
+ *
+ * \param scrollbar the scrollbar to start the drag for
+ * \param x the X coordinate of the drag start
+ * \param y the Y coordinate of the drag start
+ * \param reverse whether this should be a reverse drag (used when the
+ * user drags the content area, rather than the scrollbar)
+ * \param pair whether the drag is a '2D' scroll
+ */
+
+static void scrollbar_drag_start_internal(struct scrollbar *scrollbar,
+ int x, int y, bool reverse, bool pair)
+{
+ struct scrollbar_msg_data msg;
+
+ scrollbar->drag_start_coord = scrollbar->horizontal ? x : y;
+ scrollbar->drag_start_bar_off = scrollbar->bar_off;
+
+ scrollbar->dragging = true;
+ scrollbar->reverse = reverse;
+
+ msg.scrollbar = scrollbar;
+
+ /* \todo - some proper numbers please! */
+ if (scrollbar->horizontal) {
+ msg.x0 = -1024;
+ msg.x1 = 1024;
+ msg.y0 = 0;
+ msg.y1 = 0;
+ } else {
+ msg.x0 = 0;
+ msg.x1 = 0;
+ msg.y0 = -1024;
+ msg.y1 = 1024;
+ }
+
+ if (pair && scrollbar->pair != NULL) {
+ scrollbar->pair_drag = true;
+
+ scrollbar->pair->drag_start_coord =
+ scrollbar->pair->horizontal ? x : y;
+
+ scrollbar->pair->drag_start_bar_off = scrollbar->pair->bar_off;
+
+ scrollbar->pair->dragging = true;
+ scrollbar->pair->reverse = reverse;
+
+ if (scrollbar->pair->horizontal) {
+ msg.x0 = -1024;
+ msg.x1 = 1024;
+ } else {
+ msg.y0 = -1024;
+ msg.y1 = 1024;
+ }
+ }
+ msg.msg = SCROLLBAR_MSG_SCROLL_START;
+ scrollbar->client_callback(scrollbar->client_data, &msg);
+}
+
+
+/**
+ * Handle mouse actions other then drag ends.
+ *
+ * \param scrollbar the scrollbar which gets the mouse action
+ * \param mouse mouse state
+ * \param x X coordinate of the mouse
+ * \param y Y coordinate of the mouse
+ * \return message for the status bar or NULL on failure
+ */
+
+const char *scrollbar_mouse_action(struct scrollbar *scrollbar,
+ browser_mouse_state mouse, int x, int y)
+{
+ int x0, y0, x1, y1;
+ int val;
+ const char *status;
+ bool h;
+
+ /* we want mouse presses and mouse drags that were not started at the
+ * scrollbar indication bar to be launching actions on the scroll area
+ */
+ bool but1 = ((mouse & BROWSER_MOUSE_PRESS_1) ||
+ ((mouse & BROWSER_MOUSE_HOLDING_1) &&
+ (mouse & BROWSER_MOUSE_DRAG_ON) &&
+ !scrollbar->dragging));
+ bool but2 = ((mouse & BROWSER_MOUSE_PRESS_2) ||
+ ((mouse & BROWSER_MOUSE_HOLDING_2) &&
+ (mouse & BROWSER_MOUSE_DRAG_ON) &&
+ !scrollbar->dragging));
+
+ h = scrollbar->horizontal;
+
+ x0 = 0;
+ y0 = 0;
+ x1 = h ? scrollbar->length : SCROLLBAR_WIDTH;
+ y1 = h ? SCROLLBAR_WIDTH : scrollbar->length;
+
+ if (!scrollbar->dragging &&
+ !(x >= x0 && x <= x1 && y >= y0 && y <= y1)) {
+ /* Not a drag and mouse outside scrollbar widget */
+ return NULL;
+ }
+
+
+ if (h)
+ val = x;
+ else
+ val = y;
+
+ if (scrollbar->dragging) {
+ val -= scrollbar->drag_start_coord;
+ if (scrollbar->reverse)
+ val = -val;
+ if (val != 0)
+ scrollbar_set(scrollbar,
+ scrollbar->drag_start_bar_off + val,
+ true);
+ if (scrollbar->pair_drag) {
+ scrollbar_mouse_action(scrollbar->pair, mouse, x, y);
+ status = messages_get("ScrollBoth");
+ } else
+ status = messages_get(h ? "ScrollH" : "ScrollV");
+
+ return status;
+ }
+
+ if (val < SCROLLBAR_WIDTH) {
+ /* left/up arrow */
+
+ status = messages_get(h ? "ScrollLeft" : "ScrollUp");
+ if (but1)
+ scrollbar_set(scrollbar,
+ scrollbar->bar_off - SCROLLBAR_WIDTH,
+ true);
+ else if (but2)
+ scrollbar_set(scrollbar,
+ scrollbar->bar_off + SCROLLBAR_WIDTH,
+ true);
+
+ } else if (val < SCROLLBAR_WIDTH + scrollbar->bar_off) {
+ /* well between left/up arrow and bar */
+
+ status = messages_get(h ? "ScrollPLeft" : "ScrollPUp");
+
+ if (but1)
+ scrollbar_set(scrollbar,
+ scrollbar->area_scroll - scrollbar->length,
+ false);
+ else if (but2)
+ scrollbar_set(scrollbar,
+ scrollbar->area_scroll + scrollbar->length,
+ false);
+
+ } else if (val > scrollbar->length - SCROLLBAR_WIDTH) {
+ /* right/down arrow */
+
+ status = messages_get(h ? "ScrollRight" : "ScrollDown");
+
+ if (but1)
+ scrollbar_set(scrollbar,
+ scrollbar->bar_off + SCROLLBAR_WIDTH,
+ true);
+ else if (but2)
+ scrollbar_set(scrollbar,
+ scrollbar->bar_off - SCROLLBAR_WIDTH,
+ true);
+
+ } else if (val > SCROLLBAR_WIDTH + scrollbar->bar_off + scrollbar->bar_len) {
+ /* well between right/down arrow and bar */
+
+ status = messages_get(h ? "ScrollPRight" : "ScrollPDown");
+ if (but1)
+ scrollbar_set(scrollbar,
+ scrollbar->area_scroll + scrollbar->length,
+ false);
+ else if (but2)
+ scrollbar_set(scrollbar,
+ scrollbar->area_scroll - scrollbar->length,
+ false);
+ }
+ else {
+ /* scrollbar position indication bar */
+
+ status = messages_get(h ? "ScrollH" : "ScrollV");
+ }
+
+
+ if (mouse & (BROWSER_MOUSE_DRAG_1 | BROWSER_MOUSE_DRAG_2) &&
+ (val >= SCROLLBAR_WIDTH + scrollbar->bar_off
+ && val < SCROLLBAR_WIDTH + scrollbar->bar_off +
+ scrollbar->bar_len))
+ /* The mouse event is a drag start on the scrollbar position
+ * indication bar. */
+ scrollbar_drag_start_internal(scrollbar, x, y, false,
+ (mouse & BROWSER_MOUSE_DRAG_2) ? true : false);
+
+ return status;
+}
+
+
+/**
+ * Handle end of mouse drags.
+ *
+ * \param scrollbar the scrollbar for which the drag ends
+ * \param mouse mouse state
+ * \param x X coordinate of the mouse
+ * \param y Y coordinate of the mouse
+ */
+
+void scrollbar_mouse_drag_end(struct scrollbar *scrollbar,
+ browser_mouse_state mouse, int x, int y)
+{
+ struct scrollbar_msg_data msg;
+ int val;
+
+ assert(scrollbar->dragging);
+
+ val = (scrollbar->horizontal ? x : y) - scrollbar->drag_start_coord;
+ if (scrollbar->reverse)
+ val = -val;
+ if (val != 0)
+ scrollbar_set(scrollbar, scrollbar->drag_start_bar_off + val,
+ true);
+
+ scrollbar->dragging = false;
+ scrollbar->reverse = false;
+ if (scrollbar->pair_drag) {
+ scrollbar->pair_drag = false;
+
+ val = (scrollbar->pair->horizontal ? x : y) -
+ scrollbar->pair->drag_start_coord;
+ if (scrollbar->pair->reverse)
+ val = -val;
+ if (val != 0)
+ scrollbar_set(scrollbar->pair,
+ scrollbar->pair->drag_start_bar_off + val,
+ true);
+
+ scrollbar->pair->dragging = false;
+ scrollbar->pair->reverse = false;
+ }
+ msg.scrollbar = scrollbar;
+ msg.msg = SCROLLBAR_MSG_SCROLL_FINISHED;
+ scrollbar->client_callback(scrollbar->client_data, &msg);
+}
+
+
+/**
+ * Called when the content is being dragged to the scrollbars have to adjust.
+ * If the content has both scrollbars, and scrollbar_make_pair has beed called
+ * before, only the one scroll which will receive further mouse events has to be
+ * passed.
+ *
+ * \param scrollbar one of the the scrollbars owned by the dragged content
+ * \param x X coordinate of mouse during drag start
+ * \param y Y coordinate of mouse during drag start
+ */
+
+void scrollbar_start_content_drag(struct scrollbar *scrollbar, int x, int y)
+{
+ scrollbar_drag_start_internal(scrollbar, x, y, true, true);
+}
+
+
+/**
+ * Connect a horizontal and a vertical scrollbar into a pair so that they
+ * co-operate during 2D drags.
+ *
+ * \param horizontal_scrollbar the scrollbar used for horizontal scrolling
+ * \param vertical_scrollbar the scrollbar used for vertical scrolling
+ */
+
+void scrollbar_make_pair(struct scrollbar *horizontal_scrollbar,
+ struct scrollbar *vertical_scrollbar)
+{
+ assert(horizontal_scrollbar->horizontal &&
+ !vertical_scrollbar->horizontal);
+
+ horizontal_scrollbar->pair = vertical_scrollbar;
+ vertical_scrollbar->pair = horizontal_scrollbar;
+}
+
+
+void *scrollbar_get_data(struct scrollbar *scrollbar)
+{
+ return scrollbar->client_data;
+}
+
diff --git a/desktop/scrollbar.h b/desktop/scrollbar.h
new file mode 100644
index 000000000..d211339b8
--- /dev/null
+++ b/desktop/scrollbar.h
@@ -0,0 +1,95 @@
+/*
+ * Copyright 2009 Paul Blokus <paul_pl@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
+ * Scrollbar widget (interface).
+ */
+
+#ifndef _NETSURF_DESKTOP_SCROLLBAR_H_
+#define _NETSURF_DESKTOP_SCROLLBAR_H_
+
+#include <stdbool.h>
+
+#include "desktop/browser.h"
+
+#define SCROLLBAR_WIDTH 16
+
+struct scrollbar;
+
+typedef enum {
+ SCROLLBAR_MSG_REDRAW, /* the scrollbar requests a redraw */
+ SCROLLBAR_MSG_MOVED, /* the scroll value has changed */
+ SCROLLBAR_MSG_SCROLL_START, /* a scrollbar drag has started, all
+ * mouse events should be passed to
+ * the scrollbar regardless of the
+ * coordinates
+ */
+ SCROLLBAR_MSG_SCROLL_FINISHED, /* cancel the above */
+
+} scrollbar_msg;
+
+struct scrollbar_msg_data {
+ struct scrollbar *scrollbar;
+ scrollbar_msg msg;
+ int new_scroll;
+ int x0, y0, x1, y1;
+};
+
+/**
+ * Client callback for the scrollbar.
+ *
+ * \param client_data user data passed at scroll creation
+ * \param scrollbar_data struct all necessary message data
+ */
+typedef void(*scrollbar_client_callback)(void *client_data,
+ struct scrollbar_msg_data *scrollbar_data);
+
+
+bool scrollbar_create(bool horizontal, int length,
+ int scrolled_dimension, int scrolled_visible,
+ void *client_data, scrollbar_client_callback client_callback,
+ struct scrollbar **scrollbar);
+
+void scrollbar_destroy(struct scrollbar *scrollbar);
+
+bool scrollbar_redraw(struct scrollbar *scrollbar, int x, int y,
+ const struct rect *clip, float scale);
+
+void scrollbar_set(struct scrollbar *scrollbar, int scrollbar_val, bool bar);
+
+int scrollbar_get_offset(struct scrollbar *scrollbar);
+
+void scrollbar_set_extents(struct scrollbar *scrollbar, int length,
+ int scrolled_visible, int scrolled_dimension);
+
+bool scrollbar_is_horizontal(struct scrollbar *scrollbar);
+
+const char *scrollbar_mouse_action(struct scrollbar *scrollbar,
+ browser_mouse_state mouse, int x, int y);
+
+void scrollbar_mouse_drag_end(struct scrollbar *scrollbar,
+ browser_mouse_state mouse, int x, int y);
+
+void scrollbar_start_content_drag(struct scrollbar *scrollbar, int x, int y);
+
+void scrollbar_make_pair(struct scrollbar *horizontal_scrollbar,
+ struct scrollbar *vertical_scrollbar);
+
+void *scrollbar_get_data(struct scrollbar *scrollbar);
+
+#endif
diff --git a/desktop/textinput.c b/desktop/textinput.c
index 708038d9a..0a33e545c 100644
--- a/desktop/textinput.c
+++ b/desktop/textinput.c
@@ -31,7 +31,7 @@
#include "desktop/browser.h"
#include "desktop/gui.h"
#include "desktop/mouse.h"
-#include "desktop/scroll.h"
+#include "desktop/scrollbar.h"
#include "desktop/selection.h"
#include "desktop/textinput.h"
#include "render/box.h"
@@ -287,11 +287,11 @@ void browser_window_textarea_click(struct browser_window *bw,
textarea->gadget->caret_box_offset = char_offset;
textarea->gadget->caret_pixel_offset = pixel_offset;
- box_x += scroll_get_offset(textarea->scroll_x);
- box_y += scroll_get_offset(textarea->scroll_y);
+ box_x += scrollbar_get_offset(textarea->scroll_x);
+ box_y += scrollbar_get_offset(textarea->scroll_y);
scrolled = ensure_caret_visible(bw, textarea);
- box_x -= scroll_get_offset(textarea->scroll_x);
- box_y -= scroll_get_offset(textarea->scroll_y);
+ box_x -= scrollbar_get_offset(textarea->scroll_x);
+ box_y -= scrollbar_get_offset(textarea->scroll_y);
browser_window_place_caret(bw,
box_x + inline_container->x + text_box->x +
@@ -342,8 +342,8 @@ bool browser_window_textarea_callback(struct browser_window *bw,
#endif
box_coords(textarea, &box_x, &box_y);
- box_x -= scroll_get_offset(textarea->scroll_x);
- box_y -= scroll_get_offset(textarea->scroll_y);
+ box_x -= scrollbar_get_offset(textarea->scroll_x);
+ box_y -= scrollbar_get_offset(textarea->scroll_y);
if (!(key <= 0x001F || (0x007F <= key && key <= 0x009F))) {
/* normal character insertion */
@@ -767,8 +767,9 @@ bool browser_window_textarea_callback(struct browser_window *bw,
assert(char_offset <= text_box->length);
/* Scroll back to the left */
if (textarea->scroll_x != NULL) {
- box_x += scroll_get_offset(textarea->scroll_x);
- scroll_set(textarea->scroll_x, 0, false);
+ box_x += scrollbar_get_offset(
+ textarea->scroll_x);
+ scrollbar_set(textarea->scroll_x, 0, false);
}
} else {
assert(!text_box->next ||
@@ -790,11 +791,11 @@ bool browser_window_textarea_callback(struct browser_window *bw,
textarea->gadget->caret_box_offset = char_offset;
textarea->gadget->caret_pixel_offset = pixel_offset;
- box_x += scroll_get_offset(textarea->scroll_x);
- box_y += scroll_get_offset(textarea->scroll_y);
+ box_x += scrollbar_get_offset(textarea->scroll_x);
+ box_y += scrollbar_get_offset(textarea->scroll_y);
scrolled = ensure_caret_visible(bw, textarea);
- box_x -= scroll_get_offset(textarea->scroll_x);
- box_y -= scroll_get_offset(textarea->scroll_y);
+ box_x -= scrollbar_get_offset(textarea->scroll_x);
+ box_y -= scrollbar_get_offset(textarea->scroll_y);
browser_window_place_caret(bw,
box_x + inline_container->x + text_box->x +
@@ -1414,11 +1415,11 @@ bool browser_window_textarea_paste_text(struct browser_window *bw,
textarea->gadget->caret_pixel_offset = pixel_offset;
box_coords(textarea, &box_x, &box_y);
- box_x += scroll_get_offset(textarea->scroll_x);
- box_y += scroll_get_offset(textarea->scroll_y);
+ box_x += scrollbar_get_offset(textarea->scroll_x);
+ box_y += scrollbar_get_offset(textarea->scroll_y);
ensure_caret_visible(bw, textarea);
- box_x -= scroll_get_offset(textarea->scroll_x);
- box_y -= scroll_get_offset(textarea->scroll_y);
+ box_x -= scrollbar_get_offset(textarea->scroll_x);
+ box_y -= scrollbar_get_offset(textarea->scroll_y);
browser_window_place_caret(bw,
box_x + inline_container->x + text_box->x +
@@ -1534,8 +1535,8 @@ void browser_window_textarea_move_caret(struct browser_window *bw, void *p)
font_plot_style_from_css(text_box->style, &fstyle);
box_coords(textarea, &box_x, &box_y);
- box_x -= scroll_get_offset(textarea->scroll_x);
- box_y -= scroll_get_offset(textarea->scroll_y);
+ box_x -= scrollbar_get_offset(textarea->scroll_x);
+ box_y -= scrollbar_get_offset(textarea->scroll_y);
nsfont.font_width(&fstyle, text_box->text,
char_offset, &pixel_offset);
@@ -2233,8 +2234,8 @@ bool ensure_caret_visible(struct browser_window *bw, struct box *textarea)
assert(textarea->gadget);
- scrollx = scroll_get_offset(textarea->scroll_x);
- scrolly = scroll_get_offset(textarea->scroll_y);
+ scrollx = scrollbar_get_offset(textarea->scroll_x);
+ scrolly = scrollbar_get_offset(textarea->scroll_y);
/* Calculate the caret coordinates */
cx = textarea->gadget->caret_pixel_offset +
@@ -2244,37 +2245,37 @@ bool ensure_caret_visible(struct browser_window *bw, struct box *textarea)
/* Ensure they are visible */
if (textarea->scroll_x == NULL) {
scrollx = 0;
- } else if (cx - scroll_get_offset(textarea->scroll_x) < 0) {
+ } else if (cx - scrollbar_get_offset(textarea->scroll_x) < 0) {
scrollx = cx;
- } else if (cx > scroll_get_offset(textarea->scroll_x) +
+ } else if (cx > scrollbar_get_offset(textarea->scroll_x) +
textarea->width) {
scrollx = cx - textarea->width;
}
if (textarea->scroll_y == NULL) {
scrolly = 0;
- } else if (cy - scroll_get_offset(textarea->scroll_y) < 0) {
+ } else if (cy - scrollbar_get_offset(textarea->scroll_y) < 0) {
scrolly = cy;
} else if (cy + textarea->gadget->caret_text_box->height >
- scroll_get_offset(textarea->scroll_y) +
+ scrollbar_get_offset(textarea->scroll_y) +
textarea->height) {
scrolly = (cy + textarea->gadget->caret_text_box->height) -
textarea->height;
}
- if ((scrollx == scroll_get_offset(textarea->scroll_x)) &&
- (scrolly == scroll_get_offset(textarea->scroll_y)))
+ if ((scrollx == scrollbar_get_offset(textarea->scroll_x)) &&
+ (scrolly == scrollbar_get_offset(textarea->scroll_y)))
return false;
if (textarea->scroll_x != NULL) {
- bw->scroll = textarea->scroll_x;
- scroll_set(textarea->scroll_x, scrollx, false);
- bw->scroll = NULL;
+ bw->scrollbar = textarea->scroll_x;
+ scrollbar_set(textarea->scroll_x, scrollx, false);
+ bw->scrollbar = NULL;
}
if (textarea->scroll_y != NULL) {
- bw->scroll = textarea->scroll_x;
- scroll_set(textarea->scroll_y, scrolly, false);
- bw->scroll = NULL;
+ bw->scrollbar = textarea->scroll_x;
+ scrollbar_set(textarea->scroll_y, scrolly, false);
+ bw->scrollbar = NULL;
}
return true;