From a73c7f58e6a0bb4b4eab922396500c25c118a18b Mon Sep 17 00:00:00 2001
From: Michael R Sweet
Date: Wed, 15 Mar 2000 18:57:07 +0000
Subject: Documentation updates for 1.0.8.
FLUID GUI tweeks (OK and Cancel use now consistent, spacing now consistent,
Courier font for code, etc.)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.0@1039 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
---
documentation/Fl_Tile.html | 4 +--
documentation/Fl_Window.html | 7 ++---
documentation/basics.html | 4 +--
documentation/drawing.html | 2 ++
documentation/fluid.html | 16 +++++-----
documentation/glut.html | 67 +++++++++++++++++++++++++++++++++++++++++-
documentation/index.html | 8 ++---
documentation/intro.html | 2 --
documentation/opengl.html | 4 +--
documentation/osissues.html | 19 ++++++++++--
documentation/preface.html | 6 ++--
documentation/subclassing.html | 2 +-
12 files changed, 109 insertions(+), 32 deletions(-)
(limited to 'documentation')
diff --git a/documentation/Fl_Tile.html b/documentation/Fl_Tile.html
index e906105a0..8c281da97 100644
--- a/documentation/Fl_Tile.html
+++ b/documentation/Fl_Tile.html
@@ -5,11 +5,9 @@
Class Hierarchy
-Fl_Widget
+Fl_Group
|
+----Fl_Tile
- |
- +----Fl_Pack, Fl_Scroll, Fl_Tabs, Fl_Tile, Fl_Window
Include Files
diff --git a/documentation/Fl_Window.html b/documentation/Fl_Window.html
index 9ed982880..350a28c7c 100644
--- a/documentation/Fl_Window.html
+++ b/documentation/Fl_Window.html
@@ -145,12 +145,11 @@ also the maximum size (so the window cannot resize in that direction).
It is undefined what happens if the current size does not fit in the
constraints passed to size_range().
- Put the window on the screen. Usually this has the side effect of
-opening the display. The second two forms are used for top-level
+Put the window on the screen. Usually this has the side effect of
+opening the display. The second form is used for top-level
windows and allow standard arguments to be parsed from the
-command-line.
+command-line.
If the window is already shown then it is restored and raised to the
top. This is really convenient because your program can call show()
at any time, even if the window is already up. It also means that
diff --git a/documentation/basics.html b/documentation/basics.html
index 959e67641..b31186dc7 100644
--- a/documentation/basics.html
+++ b/documentation/basics.html
@@ -50,8 +50,8 @@ gcc ... -L/usr/local/lib -lfltk -lXext -lX11 -lm
In Visual C++ you will need to tell the compiler where to find the
FLTK header files. This can be done by selecting "Settings" from the
"Project" menu and then changing the "Preprocessor" settings under the
-"C/C++" tab. Similarly, you will need to add the FLTK library to the
-"Link" settings.
+"C/C++" tab. You will also need to add the FLTK and WinSock (WSOCK32.LIB)
+libraries to the "Link" settings.
You can build your Microsoft Windows applications as Console or
WIN32 applications. If you want to use the standard C main()
function as the entry point, FLTK includes a WinMain()
diff --git a/documentation/drawing.html b/documentation/drawing.html
index 49c973a6e..7549576be 100644
--- a/documentation/drawing.html
+++ b/documentation/drawing.html
@@ -89,6 +89,8 @@ will be duplicated exactly on any platform FLTK is ported to. It is
undefined whether these are affected by the
transformation matrix, so you should only call these while it is
the identity.
+
void fl_point(int x, int y)
+Draw a single pixel at the given coordinates.
void fl_rectf(int x, int y, int w, int h)
Color a rectangle that exactly fills the given bounding box.
void fl_rectf(int x, int y, int w, int h, uchar r, uchar g, uchar b)
diff --git a/documentation/fluid.html b/documentation/fluid.html
index 670a981fb..d336309d3 100644
--- a/documentation/fluid.html
+++ b/documentation/fluid.html
@@ -538,10 +538,11 @@ grid that all widgets snap to when you move and resize them, and for the
"snap" which is how far a widget has to be dragged from its original position
to actually change.
- |
+ |
-The output filenames control the extensions or names of the files the are
+
+The output filenames control the extensions or names of the files the are
generated by FLUID. If you check the "Include .h from .cxx" button the code
file will include the header file automatically.
@@ -580,8 +581,7 @@ which is described later in this chapter.
Help/About FLUID
Pops up a panel showing the version of FLUID.
The Widget Panel
-
-| When you double-click on a widget or a set of widgets you will get
+When you double-click on a widget or a set of widgets you will get
the "widget attribute panel".
When you change attributes using this panel, the changes are
reflected immediately in the window. It is useful to hit the "no
@@ -591,7 +591,9 @@ the widgets more accurately, especially when setting the box type.
for the fields. In this case the value for one of the widgets
is shown. But if you change this value, all of the selected
widgets are changed to the new value.
- Hitting "OK" makes the changes permanent. Selecting a different
+
+
+| Hitting "OK" makes the changes permanent. Selecting a different
widget also makes the changes permanent. FLUID checks for simple
syntax errors such as mismatched parenthesis in any code before
saving any text.
@@ -600,8 +602,6 @@ the panel or hit OK. However in the current version of FLUID, changes
to "visible" attributes (such as the color, label, box) are not undone
by revert or cancel. Changes to code like the callbacks are undone,
however.
- |  |
-
Name (text field)
Name of a variable to declare, and to store a pointer to this
@@ -611,6 +611,8 @@ blank then no variable is created.
etc. This will cause FLUID to declare an array of pointers. The array
is big enough that the highest number found can be stored. All widgets
that in the array must be the same type.
+ |  |
+
Type (upper-right pulldown menu)
Some classes have subtypes that modify their appearance or behavior.
You pick the subtype off of this menu.
diff --git a/documentation/glut.html b/documentation/glut.html
index 80fc12be3..0fdb92417 100644
--- a/documentation/glut.html
+++ b/documentation/glut.html
@@ -126,10 +126,70 @@ not work. If you do show() the window, call make_current()
again to set the context.
~Fl_Glut_Window() is the same as glutDestroyWindow()
.
+Members
+The Fl_Glut_Window class contains several public members that can
+be altered directly:
+
+
+ | member |
+ description |
+
+
+ | display |
+ A pointer to the function to call to draw the normal planes. |
+
+
+ | entry |
+ A pointer to the function to call when the mouse moves into
+ or out of the window. |
+
+
+ | keyboard |
+ A pointer to the function to call when a regular key is pressed. |
+
+
+ | menu[3] |
+ The menu to post when one of the mouse buttons is pressed. |
+
+
+ | mouse |
+ A pointer to the function to call when a button is pressed or
+ released. |
+
+
+ | motion |
+ A pointer to the function to call when the mouse is moved with
+ a button down. |
+
+
+ | overlaydisplay |
+ A pointer to the function to call to draw the overlay planes. |
+
+
+ | passivemotion |
+ A pointer to the function to call when the mouse is moved with
+ no buttons down. |
+
+
+ | reshape |
+ A pointer to the function to call when the window is resized. |
+
+
+ | special |
+ A pointer to the function to call when a special key is pressed. |
+
+
+ | visibility |
+ A pointer to the function to call when the window is iconified
+ or restored (made visible.) |
+
+
+
Methods