summaryrefslogtreecommitdiff
path: root/desktop/core_window.h
diff options
context:
space:
mode:
authorMichael Drake <tlsa@netsurf-browser.org>2013-07-17 11:42:20 +0100
committerMichael Drake <tlsa@netsurf-browser.org>2013-07-17 11:42:20 +0100
commit5aed1425609557573346675bda9be7ed3c0d5362 (patch)
tree7915971f8af3e4d16b023e5799718ed721df4d0b /desktop/core_window.h
parent618ef549838363f337a2162f34c0fa60c6e1899f (diff)
downloadnetsurf-5aed1425609557573346675bda9be7ed3c0d5362.tar.gz
netsurf-5aed1425609557573346675bda9be7ed3c0d5362.tar.bz2
Document callbacks.
Diffstat (limited to 'desktop/core_window.h')
-rw-r--r--desktop/core_window.h22
1 files changed, 19 insertions, 3 deletions
diff --git a/desktop/core_window.h b/desktop/core_window.h
index b7f1ba32e..8f53d9600 100644
--- a/desktop/core_window.h
+++ b/desktop/core_window.h
@@ -34,7 +34,12 @@ typedef enum {
/** Callbacks to achieve various core window functionality. */
struct core_window_callback_table {
- /** Request a redraw of the window. */
+ /**
+ * Request a redraw of the window
+ *
+ * \param cw the core window object
+ * \param r rectangle to redraw
+ */
void (*redraw_request)(struct core_window *cw, struct rect r);
/**
@@ -46,10 +51,21 @@ struct core_window_callback_table {
*/
void (*update_size)(struct core_window *cw, int width, int height);
- /** Scroll the window to make area visible */
+ /**
+ * Scroll the window to make area visible
+ *
+ * \param cw the core window object
+ * \param r rectangle to make visible
+ */
void (*scroll_visible)(struct core_window *cw, struct rect r);
- /** Get window viewport dimensions */
+ /**
+ * Get window viewport dimensions
+ *
+ * \param cw the core window object
+ * \param width to be set to viewport width in px
+ * \param height to be set to viewport height in px
+ */
void (*get_window_dimensions)(struct core_window *cw,
int *width, int *height);