FL/Fl_Output.H

   1 //
   2 // "$Id: Fl_Output.H 8726 2011-05-23 18:32:47Z AlbrechtS $"
   3 //
   4 // Output 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_Output widget . */
  30
  31 #ifndef Fl_Output_H
  32 #define Fl_Output_H
  33
  34 #include "Fl_Input.H"
  35 /**
  36   This widget displays a piece of text.
  37
  38   When you set the value() , Fl_Output does a strcpy() to its own storage,
  39   which is useful for program-generated values.  The user may select
  40   portions of the text using the mouse and paste the contents into other
  41   fields or programs.
  42
  43   <P align=CENTER>\image html text.png</P>
  44   \image latex text.png "Fl_Output" width=8cm
  45
  46   There is a single subclass, Fl_Multiline_Output, which allows you to
  47   display multiple lines of text. Fl_Multiline_Output does not provide
  48   scroll bars. If a more complete text editing widget is needed, use
  49   Fl_Text_Display instead.
  50
  51   The text may contain any characters except \\0, and will correctly
  52   display anything, using ^X notation for unprintable control characters
  53   and \\nnn notation for unprintable characters with the high bit set. It
  54   assumes the font can draw any characters in the ISO-Latin1 character set.
  55 */
  56 class FL_EXPORT Fl_Output : public Fl_Input {
  57 public:
  58   /**
  59     Creates a new Fl_Output widget using the given position,
  60     size, and label string. The default boxtype is FL_DOWN_BOX.
  61
  62     Inherited destructor destroys the widget and any value associated with it.
  63   */
  64
  65 #if defined(FL_DLL)     // implementation in src/Fl_Input.cxx
  66     Fl_Output(int X,int Y,int W,int H, const char *l = 0);
  67 #else
  68     Fl_Output(int X,int Y,int W,int H, const char *l = 0)
  69     : Fl_Input(X, Y, W, H, l) {type(FL_NORMAL_OUTPUT);}
  70 #endif
  71 };
  72
  73 #endif
  74
  75 //
  76 // End of "$Id: Fl_Output.H 8726 2011-05-23 18:32:47Z AlbrechtS $".
  77 //