summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorAlbrecht Schlosser <albrechts.fltk@online.de>2008-12-07 16:16:11 +0000
committerAlbrecht Schlosser <albrechts.fltk@online.de>2008-12-07 16:16:11 +0000
commit357ad962336bfb4a1aee161b5b59071a8352c503 (patch)
treeec00f5b2df658450947688b71e4d26131678f68e /src
parentb856328f1f34b31b620fef264eac74570110246a (diff)
Fixed typos and amended doxygen docs.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6561 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'src')
-rw-r--r--src/fl_boxtype.cxx31
-rw-r--r--src/fl_cursor.cxx5
-rw-r--r--src/fl_curve.cxx8
3 files changed, 19 insertions, 25 deletions
diff --git a/src/fl_boxtype.cxx b/src/fl_boxtype.cxx
index 4a710badd..3cac9d21d 100644
--- a/src/fl_boxtype.cxx
+++ b/src/fl_boxtype.cxx
@@ -70,7 +70,7 @@ uchar *fl_gray_ramp() {return (draw_it_active?active_ramp:inactive_ramp)-'A';}
The string \a s must contain groups of 4 letters which specify one of 24
standard grayscale values, where 'A' is black and 'X' is white.
The order of each set of 4 characters is: top, left, bottom, right.
- The resuls of calling fl_frame() with a string that is not a multiple
+ The result of calling fl_frame() with a string that is not a multiple
of 4 characters in length is undefined.
The only difference between this function and fl_frame2() is the order
of the line segments.
@@ -104,7 +104,7 @@ void fl_frame(const char* s, int x, int y, int w, int h) {
The string \a s must contain groups of 4 letters which specify one of 24
standard grayscale values, where 'A' is black and 'X' is white.
The order of each set of 4 characters is: bottom, right, top, left.
- The resuls of calling fl_frame2() with a string that is not a multiple
+ The result of calling fl_frame2() with a string that is not a multiple
of 4 characters in length is undefined.
The only difference between this function and fl_frame() is the order
of the line segments.
@@ -227,7 +227,7 @@ void fl_embossed_box(int x, int y, int w, int h, Fl_Color c) {
}
/**
- Draws a bounded rectangle with a given position, size and color,
+ Draws a bounded rectangle with a given position, size and color.
Equivalent to drawing a box of type FL_BORDER_BOX.
*/
void fl_rectbound(int x, int y, int w, int h, Fl_Color bgcolor) {
@@ -320,23 +320,22 @@ int Fl::box_dx(Fl_Boxtype t) {return fl_box_table[t].dx;}
/**
Returns the Y offset for the given boxtype.
-
+
These functions return the offset values necessary for a given
boxtype, useful for computing the area inside a box's borders, to
prevent overdrawing the borders.
-
+
For instance, in the case of a boxtype like FL_DOWN_BOX
where the border width might be 2 pixels all around, the above
functions would return 2, 2, 4, and 4 for box_dx,
- box_dy, box_dw, and box_dh
- respectively.
-
+ box_dy, box_dw, and box_dh respectively.
+
An example to compute the area inside a widget's box():
\code
- int X = yourwidget-&gt;x() + Fl::box_dx(yourwidget-&gt;box());
- int Y = yourwidget-&gt;y() + Fl::box_dy(yourwidget-&gt;box());
- int W = yourwidget-&gt;w() - Fl::box_dw(yourwidget-&gt;box());
- int H = yourwidget-&gt;h() - Fl::box_dh(yourwidget-&gt;box());
+ int X = yourwidget->x() + Fl::box_dx(yourwidget->box());
+ int Y = yourwidget->y() + Fl::box_dy(yourwidget->box());
+ int W = yourwidget->w() - Fl::box_dw(yourwidget->box());
+ int H = yourwidget->h() - Fl::box_dh(yourwidget->box());
\endcode
These functions are mainly useful in the draw() code
for deriving custom widgets, where one wants to avoid drawing
@@ -357,7 +356,7 @@ int Fl::box_dw(Fl_Boxtype t) {return fl_box_table[t].dw;}
int Fl::box_dh(Fl_Boxtype t) {return fl_box_table[t].dh;}
/**
- Set the drawing function for a given box type.
+ Sets the drawing function for a given box type.
\param[in] t box type
\param[in] f box drawing function
*/
@@ -388,7 +387,7 @@ void Fl::set_boxtype(Fl_Boxtype to, Fl_Boxtype from) {
}
/**
- Draw box using given type, position, size and color
+ Draws a box using given type, position, size and color.
\param[in] t box type
\param[in] x, y, w, h position and size
\param[in] c color
@@ -409,11 +408,11 @@ void Fl_Widget::draw_box() const {
// }
draw_box((Fl_Boxtype)t, x_, y_, w_, h_, (Fl_Color)color_);
}
-/** Draws a box of type b, of color c at the widget position and size. */
+/** Draws a box of type b, of color c at the widget's position and size. */
void Fl_Widget::draw_box(Fl_Boxtype b, Fl_Color c) const {
draw_box(b, x_, y_, w_, h_, c);
}
-/** Draws a box of type b, of color c at the widget position X,Y and size W,H. */
+/** Draws a box of type b, of color c at the position X,Y and size W,H. */
void Fl_Widget::draw_box(Fl_Boxtype b, int X, int Y, int W, int H, Fl_Color c) const {
draw_it_active = active_r();
fl_box_table[b].f(X, Y, W, H, c);
diff --git a/src/fl_cursor.cxx b/src/fl_cursor.cxx
index 92e5e26f1..e806168ab 100644
--- a/src/fl_cursor.cxx
+++ b/src/fl_cursor.cxx
@@ -43,8 +43,9 @@ void fl_cursor(Fl_Cursor c, Fl_Color fg, Fl_Color bg) {
if (Fl::first_window()) Fl::first_window()->cursor(c,fg,bg);
}
/**
- Sets the default Window cursor as well as its color.
- <P> For back compatibility only.
+ Sets the default window cursor as well as its color.
+
+ For back compatibility only.
*/
void Fl_Window::default_cursor(Fl_Cursor c, Fl_Color fg, Fl_Color bg) {
// if (c == FL_CURSOR_DEFAULT) c = FL_CURSOR_ARROW;
diff --git a/src/fl_curve.cxx b/src/fl_curve.cxx
index 26750d89b..736339663 100644
--- a/src/fl_curve.cxx
+++ b/src/fl_curve.cxx
@@ -32,15 +32,9 @@
Incremental math implementation:
I very much doubt this is optimal! From Foley/vanDam page 511.
- If anybody has a better algorithim, please send it!
+ If anybody has a better algorithm, please send it!
*/
-// Utility for drawing Bezier curves, adding the points to
-// the current fl_begin/fl_vertex/fl_end path.
-// Incremental math implementation:
-// I very much doubt this is optimal! From Foley/vanDam page 511.
-// If anybody has a better algorithim, please send it!
-
#include <FL/fl_draw.H>
#include <math.h>