Browse Source

Fixed typos and amended doxygen docs.

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6561 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
pull/49/head
Albrecht Schlosser 17 years ago
parent
commit
357ad96233
  1. 31
      src/fl_boxtype.cxx
  2. 5
      src/fl_cursor.cxx
  3. 8
      src/fl_curve.cxx

31
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 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. 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 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. of 4 characters in length is undefined.
The only difference between this function and fl_frame2() is the order The only difference between this function and fl_frame2() is the order
of the line segments. 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 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. 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 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. of 4 characters in length is undefined.
The only difference between this function and fl_frame() is the order The only difference between this function and fl_frame() is the order
of the line segments. 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. Equivalent to drawing a box of type FL_BORDER_BOX.
*/ */
void fl_rectbound(int x, int y, int w, int h, Fl_Color bgcolor) { 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. Returns the Y offset for the given boxtype.
These functions return the offset values necessary for a given These functions return the offset values necessary for a given
boxtype, useful for computing the area inside a box's borders, to boxtype, useful for computing the area inside a box's borders, to
prevent overdrawing the borders. prevent overdrawing the borders.
For instance, in the case of a boxtype like FL_DOWN_BOX For instance, in the case of a boxtype like FL_DOWN_BOX
where the border width might be 2 pixels all around, the above where the border width might be 2 pixels all around, the above
functions would return 2, 2, 4, and 4 for box_dx, functions would return 2, 2, 4, and 4 for box_dx,
box_dy, box_dw, and box_dh box_dy, box_dw, and box_dh respectively.
respectively.
An example to compute the area inside a widget's box(): An example to compute the area inside a widget's box():
\code \code
int X = yourwidget->x() + Fl::box_dx(yourwidget->box()); int X = yourwidget->x() + Fl::box_dx(yourwidget->box());
int Y = yourwidget->y() + Fl::box_dy(yourwidget->box()); int Y = yourwidget->y() + Fl::box_dy(yourwidget->box());
int W = yourwidget->w() - Fl::box_dw(yourwidget->box()); int W = yourwidget->w() - Fl::box_dw(yourwidget->box());
int H = yourwidget->h() - Fl::box_dh(yourwidget->box()); int H = yourwidget->h() - Fl::box_dh(yourwidget->box());
\endcode \endcode
These functions are mainly useful in the draw() code These functions are mainly useful in the draw() code
for deriving custom widgets, where one wants to avoid drawing 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;} 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] t box type
\param[in] f box drawing function \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] t box type
\param[in] x, y, w, h position and size \param[in] x, y, w, h position and size
\param[in] c color \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_); 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 { void Fl_Widget::draw_box(Fl_Boxtype b, Fl_Color c) const {
draw_box(b, x_, y_, w_, h_, c); 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 { 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(); draw_it_active = active_r();
fl_box_table[b].f(X, Y, W, H, c); fl_box_table[b].f(X, Y, W, H, c);

5
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); if (Fl::first_window()) Fl::first_window()->cursor(c,fg,bg);
} }
/** /**
Sets the default Window cursor as well as its color. Sets the default window cursor as well as its color.
<P> For back compatibility only.
For back compatibility only.
*/ */
void Fl_Window::default_cursor(Fl_Cursor c, Fl_Color fg, Fl_Color bg) { void Fl_Window::default_cursor(Fl_Cursor c, Fl_Color fg, Fl_Color bg) {
// if (c == FL_CURSOR_DEFAULT) c = FL_CURSOR_ARROW; // if (c == FL_CURSOR_DEFAULT) c = FL_CURSOR_ARROW;

8
src/fl_curve.cxx

@ -32,15 +32,9 @@
Incremental math implementation: Incremental math implementation:
I very much doubt this is optimal! From Foley/vanDam page 511. 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 <FL/fl_draw.H>
#include <math.h> #include <math.h>

Loading…
Cancel
Save