summaryrefslogtreecommitdiff
path: root/src/Fl_Paged_Device.cxx
diff options
context:
space:
mode:
authorAlbrecht Schlosser <albrechts.fltk@online.de>2011-04-23 15:46:30 +0000
committerAlbrecht Schlosser <albrechts.fltk@online.de>2011-04-23 15:46:30 +0000
commit06e17886eda63d462b5a68b5b72e93b172b492ac (patch)
treeba85bf6e03279076aede5c7d466418ad9a85c600 /src/Fl_Paged_Device.cxx
parent5c6913fed91b6f03712dd7e6a6c6abd4e9ace0ab (diff)
Documentation fixes and a few indent corrections.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8621 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'src/Fl_Paged_Device.cxx')
-rw-r--r--src/Fl_Paged_Device.cxx27
1 files changed, 13 insertions, 14 deletions
diff --git a/src/Fl_Paged_Device.cxx b/src/Fl_Paged_Device.cxx
index ae7f7d832..d5f3ff8b7 100644
--- a/src/Fl_Paged_Device.cxx
+++ b/src/Fl_Paged_Device.cxx
@@ -3,7 +3,7 @@
//
// implementation of Fl_Paged_Device class for the Fast Light Tool Kit (FLTK).
//
-// Copyright 2010 by Bill Spitzak and others.
+// Copyright 2010-2011 by Bill Spitzak and others.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Library General Public
@@ -74,7 +74,7 @@ void Fl_Paged_Device::print_widget(Fl_Widget* widget, int delta_x, int delta_y)
int width, height;
this->printable_rect(&width, &height);
drawn_by_plugin = pi->print(widget, 0, 0, height);
- }
+ }
}
if (!drawn_by_plugin) {
widget->draw();
@@ -118,7 +118,7 @@ void Fl_Paged_Device::origin(int *x, int *y)
/**
@brief Prints a rectangular part of an on-screen window.
- *
+
@param win The window from where to capture.
@param x The rectangle left
@param y The rectangle top
@@ -150,7 +150,7 @@ void Fl_Paged_Device::print_window_part(Fl_Window *win, int x, int y, int w, int
/**
@brief Starts a print job.
- *
+
@param[in] pagecount the total number of pages of the job
@param[out] frompage if non-null, *frompage is set to the first page the user wants printed
@param[out] topage if non-null, *topage is set to the last page the user wants printed
@@ -160,7 +160,7 @@ int Fl_Paged_Device::start_job(int pagecount, int *frompage, int *topage) {retur
/**
@brief Starts a new printed page
- *
+
The page coordinates are initially in points, i.e., 1/72 inch,
and with origin at the top left of the printable page area.
@return 0 if OK, non-zero if any error
@@ -169,7 +169,7 @@ int Fl_Paged_Device::start_page (void) {return 1;}
/**
@brief Computes the width and height of the printable area of the page.
- *
+
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.
@@ -180,7 +180,7 @@ int Fl_Paged_Device::printable_rect(int *w, int *h) {return 1;}
/**
@brief Computes the dimensions of margins that lie between the printable page area and
the full page.
- *
+
Values are in the same unit as that used by FLTK drawing functions. They are changed
by scale() calls.
@param[out] left If non-null, *left is set to the left margin size.
@@ -192,7 +192,7 @@ void Fl_Paged_Device::margins(int *left, int *top, int *right, int *bottom) {}
/**
@brief Sets the position in page coordinates of the origin of graphics functions.
- *
+
Arguments should be expressed relatively to the result of a previous printable_rect() call.
That is, <tt>printable_rect(&w, &h); origin(w/2, 0);</tt> sets the graphics origin at the
top center of the page printable area.
@@ -205,7 +205,7 @@ void Fl_Paged_Device::origin(int x, int y) {}
/**
@brief Changes the scaling of page coordinates.
- *
+
This function also resets the origin of graphics functions at top left of printable page area.
After a scale() call, do a printable_rect() call to get the new dimensions of the printable page area.
Successive scale() calls don't combine their effects.
@@ -218,16 +218,16 @@ void Fl_Paged_Device::scale (float scale_x, float scale_y) {}
/**
@brief Rotates the graphics operations relatively to paper.
- *
+
The rotation is centered on the current graphics origin.
Successive rotate() calls don't combine their effects.
- @param angle Rotation angle in counterclockwise degrees.
+ @param angle Rotation angle in counter-clockwise degrees.
*/
void Fl_Paged_Device::rotate(float angle) {}
/**
@brief To be called at the end of each page.
- *
+
@return 0 if OK, non-zero if any error.
*/
int Fl_Paged_Device::end_page (void) {return 1;}
@@ -239,7 +239,7 @@ void Fl_Paged_Device::end_job (void) {}
/**
@brief Translates the current graphics origin accounting for the current rotation.
- *
+
This function is only useful after a rotate() call.
Each translate() call must be matched by an untranslate() call.
Successive translate() calls add up their effects.
@@ -295,4 +295,3 @@ const Fl_Paged_Device::page_format Fl_Paged_Device::page_formats[NO_PAGE_FORMATS
//
// End of "$Id$".
//
-