fltk/FL/Fl_Output.H
Albrecht Schlosser 8a03632e25 Documentation updates.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8712 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2011-05-22 09:45:40 +00:00

73 lines
2.4 KiB
C++

//
// "$Id$"
//
// Output header file for the Fast Light Tool Kit (FLTK).
//
// Copyright 1998-2011 by Bill Spitzak and others.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Library General Public
// License as published by the Free Software Foundation; either
// version 2 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Library General Public License for more details.
//
// You should have received a copy of the GNU Library General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA.
//
// Please report all bugs and problems on the following page:
//
// http://www.fltk.org/str.php
//
/* \file
Fl_Output widget . */
#ifndef Fl_Output_H
#define Fl_Output_H
#include "Fl_Input.H"
/**
This widget displays a piece of text.
When you set the value() , Fl_Output does a strcpy() to its own storage,
which is useful for program-generated values. The user may select
portions of the text using the mouse and paste the contents into other
fields or programs.
<P align=CENTER>\image html text.png</P>
\image latex text.png "Fl_Output" width=8cm
There is a single subclass, Fl_Multiline_Output, which allows you to
display multiple lines of text. Fl_Multiline_Output does not provide
scroll bars. If a more complete text editing widget is needed, use
Fl_Text_Display instead.
The text may contain any characters except \\0, and will correctly
display anything, using ^X notation for unprintable control characters
and \\nnn notation for unprintable characters with the high bit set. It
assumes the font can draw any characters in the ISO-Latin1 character set.
*/
class Fl_Output : public Fl_Input { // don't use FL_EXPORT here !
public:
/**
Creates a new Fl_Output widget using the given position,
size, and label string. The default boxtype is FL_DOWN_BOX.
Inherited destrucor destroys the widget and any value associated with it.
*/
Fl_Output(int X,int Y,int W,int H, const char *l = 0)
: Fl_Input(X, Y, W, H, l) {type(FL_NORMAL_OUTPUT);}
};
#endif
//
// End of "$Id$".
//