diff options
| author | Michael Drake <tlsa@netsurf-browser.org> | 2014-10-25 13:01:43 +0100 |
|---|---|---|
| committer | Michael Drake <tlsa@netsurf-browser.org> | 2014-10-25 13:01:43 +0100 |
| commit | b0509c65451f527676c94580f0f9ee54d3a59ce1 (patch) | |
| tree | 12a3895dddf94dbc7c24889c114b217649cba9c8 /desktop/browser.h | |
| parent | 94ab63319f5ce6eb8fb081d8f38f9fe53808970e (diff) | |
| download | netsurf-b0509c65451f527676c94580f0f9ee54d3a59ce1.tar.gz netsurf-b0509c65451f527676c94580f0f9ee54d3a59ce1.tar.bz2 | |
Fix and improve comment for browser_window_get_scrollbar_type().
Diffstat (limited to 'desktop/browser.h')
| -rw-r--r-- | desktop/browser.h | 9 |
1 files changed, 8 insertions, 1 deletions
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, |