From 92ff2e30bc595fb470d3d78bed9578a7376550a3 Mon Sep 17 00:00:00 2001 From: Albrecht Schlosser Date: Sun, 19 Oct 2014 20:17:17 +0000 Subject: Update docs related to buttons and update Fl_Check_Button.png. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10386 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- src/Fl_Round_Button.cxx | 39 ++++++++++++++++++++++++++++++++------- 1 file changed, 32 insertions(+), 7 deletions(-) (limited to 'src/Fl_Round_Button.cxx') diff --git a/src/Fl_Round_Button.cxx b/src/Fl_Round_Button.cxx index d3ba77e22..0f66396cd 100644 --- a/src/Fl_Round_Button.cxx +++ b/src/Fl_Round_Button.cxx @@ -3,10 +3,10 @@ // // Round button for the Fast Light Tool Kit (FLTK). // -// Copyright 1998-2010 by Bill Spitzak and others. +// Copyright 1998-2014 by Bill Spitzak and others. // // This library is free software. Distribution and use rights are outlined in -// the file "COPYING" which should have been included with this file. If this +// the file "COPYING" which should have been included with this file. If this // file is missing or damaged, see the license at: // // http://www.fltk.org/COPYING.php @@ -25,19 +25,44 @@ #include /** - Creates a new Fl_Round_Button widget using the given - position, size, and label string. + Creates a new Fl_Round_Button widget using the given position, size, and label string. + + \image html Fl_Round_Button.png + \image latex Fl_Round_Button.png " Fl_Round_Button" width=4cm + + The Fl_Round_Button subclass displays the "ON" state by + turning on a light, rather than drawing pushed in. + + The default box type is FL_NO_BOX, which draws the label w/o a box + right of the checkmark. + + The shape of the "light" is set with down_box() and its default + value is FL_ROUND_DOWN_BOX. + + The color of the light when on is controlled with selection_color(), + which defaults to FL_FOREGROUND_COLOR (usually black). + + \param[in] X, Y, W, H position and size of the widget + \param[in] L widget label, default is no label */ -Fl_Round_Button::Fl_Round_Button(int X,int Y,int W,int H, const char *l) -: Fl_Light_Button(X,Y,W,H,l) { +Fl_Round_Button::Fl_Round_Button(int X,int Y,int W,int H, const char *L) +: Fl_Light_Button(X,Y,W,H,L) { box(FL_NO_BOX); down_box(FL_ROUND_DOWN_BOX); selection_color(FL_FOREGROUND_COLOR); } +/** + Creates a new Fl_Radio_Button widget using the given position, size, and label string. + + The button type() is set to FL_RADIO_BUTTON. + + \param[in] X, Y, W, H position and size of the widget + \param[in] L widget label, default is no label +*/ Fl_Radio_Round_Button::Fl_Radio_Round_Button(int X,int Y,int W,int H,const char *L) -: Fl_Round_Button(X,Y,W,H,L) +: Fl_Round_Button(X,Y,W,H,L) { type(FL_RADIO_BUTTON); } -- cgit v1.2.3