diff options
| author | engelsman <engelsman> | 2009-03-15 20:52:46 +0000 |
|---|---|---|
| committer | engelsman <engelsman> | 2009-03-15 20:52:46 +0000 |
| commit | 4bcf3e531183b0533baa114b8456d89cdb8ebcd6 (patch) | |
| tree | 37897b3cfed5961e11cd5c75e419002142809498 /src/fl_scroll_area.cxx | |
| parent | 3c56a23ba19a6df6e15bdfd290465a4478d63985 (diff) | |
added doxygen comments for more functions in fl_draw.H
FL/fl_draw.H: see below
src/fl_cursor.cxx: fl_cursor()
src/fl_scroll_area.cxx: fl_scroll()
src/fl_overlay.cxx: fl_overlay_clear(), fl_overlay_rect()
documentation/src/drawing.dox: updated paragraph tag links
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6690 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'src/fl_scroll_area.cxx')
| -rw-r--r-- | src/fl_scroll_area.cxx | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/src/fl_scroll_area.cxx b/src/fl_scroll_area.cxx index 9dad3e7d4..4a361c37a 100644 --- a/src/fl_scroll_area.cxx +++ b/src/fl_scroll_area.cxx @@ -35,8 +35,19 @@ #include <FL/fl_draw.H> // scroll a rectangle and redraw the newly exposed portions: +/** + Scroll a rectangle and draw the newly exposed portions. + \param[in] X,Y position of top-left of rectangle + \param[in] W,H size of rectangle + \param[in] dx,dy pixel offsets for shifting rectangle + \param[in] draw_area callback function to draw rectangular areas + \param[in] data pointer to user data for callback + The contents of the rectangular area is first shifted by \a dx + and \a dy pixels. The \a draw_area callback is then called for + every newly exposed rectangular area. + */ void fl_scroll(int X, int Y, int W, int H, int dx, int dy, - void (*draw_area)(void*, int,int,int,int), void* data) + void (*draw_area)(void*, int,int,int,int), void* data) { if (!dx && !dy) return; if (dx <= -W || dx >= W || dy <= -H || dy >= H) { |