blob: 2c100362cd8e52d63abf4c2a6217a838065f97d3 [file] [log] [blame]
DRC2ff39b82011-07-28 08:38:59 +00001//
2// "$Id: Fl_Secret_Input.H 8726 2011-05-23 18:32:47Z AlbrechtS $"
3//
4// Secret input header file for the Fast Light Tool Kit (FLTK).
5//
6// Copyright 1998-2011 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_Secret_Input widget . */
30
31#ifndef Fl_Secret_Input_H
32#define Fl_Secret_Input_H
33
34#include "Fl_Input.H"
35
36/**
37 The Fl_Secret_Input class is a subclass of Fl_Input that displays its
38 input as a string of placeholders. Depending on the platform this
39 placeholder is either the asterisk ('*') or the Unicode bullet
40 character (U+2022).
41
42 This subclass is usually used to receive passwords and other "secret" information.
43*/
44class FL_EXPORT Fl_Secret_Input : public Fl_Input {
45public:
46 /**
47 Creates a new Fl_Secret_Input widget using the given
48 position, size, and label string. The default boxtype is FL_DOWN_BOX.
49
50 Inherited destructor destroys the widget and any value associated with it.
51 */
52#if defined(FL_DLL) // implementation in src/Fl_Input.cxx
53 Fl_Secret_Input(int X,int Y,int W,int H,const char *l = 0);
54#else
55 Fl_Secret_Input(int X,int Y,int W,int H,const char *l = 0)
56 : Fl_Input(X,Y,W,H,l) {type(FL_SECRET_INPUT);}
57#endif
58};
59
60#endif
61
62//
63// End of "$Id: Fl_Secret_Input.H 8726 2011-05-23 18:32:47Z AlbrechtS $".
64//