> > This is where our users come in. Please *please* submit documentation > changes and additions via STR. I am greateful even for single- > sentence additions if that makes it clearer for the next user.
Let me answer with a simple example. Here's the documentation for Fl_Widget::color ------------------------------------------------------------------- Fl_Color Fl_Widget::color() const void Fl_Widget::color(Fl_Color) void Fl_Widget::color(Fl_Color, Fl_Color) Gets or sets the background color of the widget. The color is passed to the box routine. The color is either an index into an internal table of RGB colors or an RGB color value generated using fl_rgb_color(). The default for most widgets is FL_BACKGROUND_COLOR. See the enumeration list for predefined colors. Use Fl::set_color() to redefine colors. -------------------------------------------------------------------- What does that tell me? If I call color(FL_RED) on a Fl_Widget, will it turn red? One can hope, so let's try it out: Fl_Double_Window win(300, 300); Fl_Widget* o = new Fl_Input(100, 120, 100, 20, "Input"); o->color(FL_RED); o = new Fl_Choice(100, 140, 100, 20, "Choice"); o->color(FL_RED); o = new Fl_Input_Choice(100, 160, 100, 20, "Input Choice"); o->color(FL_RED); win.end(); win.show(); return Fl::run(); Hmmm. The Fl_Input is red, the Fl_Choice has a red button, and the Fl_Input_Choice is unaffected. Who knew? Is there any further documentation for Fl_Input::color(), Fl_Choice::color(), or Fl_Input_Choice::color()? Nope. So maybe setting the background color of these widgets isn't supposed to change their appearance. I can keep digging, I suppose, or I can do as Erco suggested, just peek into the code to find out what's really going on, so that I can get some productive work done. (With all the risk that doing so implies). Should I submit an STR? What would it say? "The documentation is much too sparse to be helpful?" "The law of least surprise is violated?" Really, I wouldn't know where to start. Anyway, I hope nobody takes this personally. I realize that creating good documentation is difficult and not much fun to do. Best, Stan _______________________________________________ fltk mailing list [email protected] http://lists.easysw.com/mailman/listinfo/fltk
