From b0509c65451f527676c94580f0f9ee54d3a59ce1 Mon Sep 17 00:00:00 2001 From: Michael Drake Date: Sat, 25 Oct 2014 13:01:43 +0100 Subject: Fix and improve comment for browser_window_get_scrollbar_type(). --- desktop/browser.h | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) (limited to 'desktop/browser.h') diff --git a/desktop/browser.h b/desktop/browser.h index 8dff6dd6f..29a8736d2 100644 --- a/desktop/browser.h +++ b/desktop/browser.h @@ -609,9 +609,16 @@ bool browser_window_can_search(struct browser_window *bw); bool browser_window_is_frameset(struct browser_window *bw); /** - * Find out if a browser window contains a frameset + * Get the browser window's scrollbar details. + * + * Vertical and horizontal scrollbars may be {YES|NO|AUTO}, although + * it is entirely up to the front end whether this is implemented. + * e.g. if the gui toolkit style-guide says all windows must have + * scrollbars then this API can be ignored. * * \param bw browser window to look at + * \param h Updated to indicate horizontal scrollbar type + * \param h Updated to indicate vertical scrollbar type * \return NSERROR_OK, or appropriate error otherwise */ nserror browser_window_get_scrollbar_type(struct browser_window *bw, -- cgit v1.2.3