blob: eaf821b42af1898a916523839538b66e9d570bc1 [file] [log] [blame]
DRC2ff39b82011-07-28 08:38:59 +00001//
2// "$Id: Fl_Toggle_Button.H 8022 2010-12-12 23:21:03Z AlbrechtS $"
3//
4// Toggle 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_Toggle_Button widget . */
30
31#ifndef Fl_Toggle_Button_H
32#define Fl_Toggle_Button_H
33
34#include "Fl_Button.H"
35
36/**
37 The toggle button is a push button that needs to be clicked once
38 to toggle on, and one more time to toggle off.
39 The Fl_Toggle_Button subclass displays the "on" state by
40 drawing a pushed-in button.</P>
41 <P>Buttons generate callbacks when they are clicked by the user. You
42 control exactly when and how by changing the values for type()
43 and when().
44*/
45class FL_EXPORT Fl_Toggle_Button : public Fl_Button {
46public:
47 /**
48 Creates a new Fl_Toggle_Button widget using the given
49 position, size, and label string.
50 <P>The inherited destructor deletes the toggle button.
51 */
52 Fl_Toggle_Button(int X,int Y,int W,int H,const char *l=0)
53 : Fl_Button(X,Y,W,H,l) {type(FL_TOGGLE_BUTTON);}
54};
55
56#endif
57
58//
59// End of "$Id: Fl_Toggle_Button.H 8022 2010-12-12 23:21:03Z AlbrechtS $".
60//