FL/Fl_Check_Button.H

   1 //
   2 // "$Id: Fl_Check_Button.H 7981 2010-12-08 23:53:04Z greg.ercolano $"
   3 //
   4 // Check button header file for the Fast Light Tool Kit (FLTK).
   5 //
   6 // Copyright 1998-2010 by Bill Spitzak and others.
   7 //
   8 // This library is free software; you can redistribute it and/or
   9 // modify it under the terms of the GNU Library General Public
  10 // License as published by the Free Software Foundation; either
  11 // version 2 of the License, or (at your option) any later version.
  12 //
  13 // This library is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 // Library General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU Library General Public
  19 // License along with this library; if not, write to the Free Software
  20 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  21 // USA.
  22 //
  23 // Please report all bugs and problems on the following page:
  24 //
  25 //     http://www.fltk.org/str.php
  26 //
  27
  28 /* \file
  29    Fl_Check_Button widget . */
  30
  31 #ifndef Fl_Check_Button_H
  32 #define Fl_Check_Button_H
  33
  34 #include "Fl_Light_Button.H"
  35
  36 /**
  37   \class Fl_Check_Button
  38   \brief A button with an "checkmark" to show its status.
  39
  40   \image html Fl_Check_Button.png
  41   \image latex Fl_Check_Button.png  "Fl_Check_Button" width=4cm
  42   Buttons generate callbacks when they are clicked by the user. You control
  43   exactly when and how by changing the values for type() and when().
  44
  45   The Fl_Check_Button subclass displays its "ON" state by showing a "checkmark"
  46   rather than drawing itself pushed in.
  47
  48   \todo Refactor Fl_Check_Button doxygen comments (add color() info etc?)
  49   \todo Generate Fl_Check_Button.gif with visible checkmark.
  50  */
  51 class FL_EXPORT Fl_Check_Button : public Fl_Light_Button {
  52 public:
  53   Fl_Check_Button(int X, int Y, int W, int H, const char *L = 0);
  54 };
  55
  56 #endif
  57
  58 //
  59 // End of "$Id: Fl_Check_Button.H 7981 2010-12-08 23:53:04Z greg.ercolano $".
  60 //