Author: AlbrechtS
Date: 2011-05-22 02:45:40 -0700 (Sun, 22 May 2011)
New Revision: 8712
Log:
Documentation updates.
Modified:
branches/branch-1.3/FL/Fl_File_Input.H
branches/branch-1.3/FL/Fl_Output.H
Modified: branches/branch-1.3/FL/Fl_File_Input.H
===================================================================
--- branches/branch-1.3/FL/Fl_File_Input.H 2011-05-22 07:51:13 UTC (rev
8711)
+++ branches/branch-1.3/FL/Fl_File_Input.H 2011-05-22 09:45:40 UTC (rev
8712)
@@ -42,12 +42,14 @@
navigate upward in the directory tree.
You may want to handle FL_WHEN_CHANGED events for tracking text changes
and also FL_WHEN_RELEASE for button release when changing to parent dir.
- FL_WHEN_RELEASE callback won't be called if the directory clicked
- is the same that the current one.
+ FL_WHEN_RELEASE callback won't be called if the directory clicked
+ is the same as the current one.
+
<P align=CENTER> \image html Fl_File_Input.png </P>
\image latex Fl_File_Input.png "Fl_File_Input" width=6cm
+
\note As all Fl_Input derived objects, Fl_File_Input may call its callback
- when loosing focus (see FL_UNFOCUS) to update its state like its cursor
shape.
+ when losing focus (see FL_UNFOCUS) to update its state like its cursor shape.
One resulting side effect is that you should call clear_changed() early in
your callback
to avoid reentrant calls if you plan to show another window or dialog box in
the callback.
*/
Modified: branches/branch-1.3/FL/Fl_Output.H
===================================================================
--- branches/branch-1.3/FL/Fl_Output.H 2011-05-22 07:51:13 UTC (rev 8711)
+++ branches/branch-1.3/FL/Fl_Output.H 2011-05-22 09:45:40 UTC (rev 8712)
@@ -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);}
_______________________________________________
fltk-commit mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-commit
