summaryrefslogtreecommitdiff
path: root/FL/Fl_Output.H
diff options
context:
space:
mode:
authorAlbrecht Schlosser <albrechts.fltk@online.de>2011-05-22 09:45:40 +0000
committerAlbrecht Schlosser <albrechts.fltk@online.de>2011-05-22 09:45:40 +0000
commit8a03632e2531e16d1a064ea0af08484c459fbf4d (patch)
tree7c00deae9affa3e27c5dd40f497b6b769b47f761 /FL/Fl_Output.H
parent2a9d1e7becb161f53f445d7e18f9ea8165fb31a9 (diff)
Documentation updates.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8712 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'FL/Fl_Output.H')
-rw-r--r--FL/Fl_Output.H28
1 files changed, 16 insertions, 12 deletions
diff --git a/FL/Fl_Output.H b/FL/Fl_Output.H
index cb8f88807..64ee5e34a 100644
--- a/FL/Fl_Output.H
+++ b/FL/Fl_Output.H
@@ -3,7 +3,7 @@
//
// Output header file for the Fast Light Tool Kit (FLTK).
//
-// Copyright 1998-2010 by Bill Spitzak and others.
+// 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
@@ -33,29 +33,33 @@
#include "Fl_Input.H"
/**
- This widget displays a piece of text. When you set the value()
- , Fl_Output does a strcpy() to it's own storage,
+ 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>
+
+ <P align=CENTER>\image html text.png</P>
\image latex text.png "Fl_Output" width=8cm
- <P>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.</P>
- <P>The text may contain any characters except \\0, and will correctly
+
+ 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.
+ 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.
- <P>Inherited destrucor destroys the widget and any value associated with it.
+
+ 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);}