FL/Fl_Multiline_Input.H

   1 //
   2 // "$Id: Fl_Multiline_Input.H 8726 2011-05-23 18:32:47Z AlbrechtS $"
   3 //
   4 // Multiline 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_Multiline_Input widget . */
  30
  31
  32 #ifndef Fl_Multiline_Input_H
  33 #define Fl_Multiline_Input_H
  34
  35 #include "Fl_Input.H"
  36
  37 /**
  38   This input field displays '\n' characters as new lines rather than ^J,
  39   and accepts the Return, Tab, and up and down arrow keys.  This is for
  40   editing multiline text.
  41
  42   This is far from the nirvana of text editors, and is probably only
  43   good for small bits of text, 10 lines at most. Note that this widget
  44   does not support scrollbars or per-character color control.
  45
  46   If you are presenting large amounts of text and need scrollbars
  47   or full color control of characters, you probably want Fl_Text_Editor
  48   instead.
  49
  50   In FLTK 1.3.x, the default behavior of the 'Tab' key was changed
  51   to support consistent focus navigation. To get the older FLTK 1.1.x
  52   behavior, set Fl_Input_::tab_nav() to 0. Newer programs should consider using
  53   Fl_Text_Editor.
  54 */
  55 class FL_EXPORT Fl_Multiline_Input : public Fl_Input {
  56 public:
  57   /**
  58     Creates a new Fl_Multiline_Input widget using the given
  59     position, size, and label string. The default boxtype is FL_DOWN_BOX.
  60
  61     Inherited destructor destroys the widget and any value associated with it.
  62   */
  63 #if defined(FL_DLL)     // implementation in src/Fl_Input.cxx
  64   Fl_Multiline_Input(int X,int Y,int W,int H,const char *l = 0);
  65 #else
  66   Fl_Multiline_Input(int X,int Y,int W,int H,const char *l = 0)
  67     : Fl_Input(X,Y,W,H,l) {type(FL_MULTILINE_INPUT);}
  68 #endif
  69 };
  70
  71 #endif
  72
  73 //
  74 // End of "$Id: Fl_Multiline_Input.H 8726 2011-05-23 18:32:47Z AlbrechtS $".
  75 //