summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorManolo Gouy <Manolo>2018-05-04 15:44:23 +0000
committerManolo Gouy <Manolo>2018-05-04 15:44:23 +0000
commita8054a719f27ea2a9d5fcfbdf636cedbd1862565 (patch)
tree5a9d8371b34235b2326f0e15e0786aa0e4f5e85e /src
parent20ccb6b7f2b0b2b742211c31a32c3ac612c43489 (diff)
Documentation: improve doc of Fl_Widget_Surface::print_window_part() and Fl_Widget_Surface::printable_rect().
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12895 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'src')
-rw-r--r--src/Fl_Widget_Surface.cxx12
1 files changed, 6 insertions, 6 deletions
diff --git a/src/Fl_Widget_Surface.cxx b/src/Fl_Widget_Surface.cxx
index 8e377bfec..595e71cb5 100644
--- a/src/Fl_Widget_Surface.cxx
+++ b/src/Fl_Widget_Surface.cxx
@@ -140,9 +140,9 @@ void Fl_Widget_Surface::origin(int x, int y) {
}
/**
- @brief Prints a rectangular part of an on-screen window.
+ Draws a rectangular part of an on-screen window.
- @param win The window from where to capture.
+ @param win The window from where to capture. Can be an Fl_Gl_Window. Sub-windows that intersect the rectangle are also captured.
@param x The rectangle left
@param y The rectangle top
@param w The rectangle width
@@ -166,11 +166,11 @@ void Fl_Widget_Surface::print_window_part(Fl_Window *win, int x, int y, int w, i
}
/**
- @brief Computes the width and height of the printable area of the page.
+ Computes the width and height of the drawable area of the drawing surface.
- Values are in the same unit as that used by FLTK drawing functions,
- are unchanged by calls to origin(), but are changed by scale() calls.
- Values account for the user-selected paper type and print orientation.
+ Values are in the same unit as that used by FLTK drawing functions and are unchanged by calls to origin().
+ If the object is derived from class Fl_Paged_Device, values account for the user-selected paper type and print orientation
+ and are changed by scale() calls.
@return 0 if OK, non-zero if any error
*/
int Fl_Widget_Surface::printable_rect(int *w, int *h) {return 1;}