summaryrefslogtreecommitdiff
path: root/documentation
diff options
context:
space:
mode:
authorMichael R Sweet <michael.r.sweet@gmail.com>2000-03-15 18:57:07 +0000
committerMichael R Sweet <michael.r.sweet@gmail.com>2000-03-15 18:57:07 +0000
commita73c7f58e6a0bb4b4eab922396500c25c118a18b (patch)
tree7b846ad94ede2aa3e46c1401dd6758562add7e00 /documentation
parentaf5190b95f6b4eb16c028aeb9620f5ebcfe4a0ec (diff)
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
Diffstat (limited to 'documentation')
-rw-r--r--documentation/Fl_Tile.html4
-rw-r--r--documentation/Fl_Window.html7
-rw-r--r--documentation/basics.html4
-rw-r--r--documentation/drawing.html2
-rw-r--r--documentation/fluid.html16
-rw-r--r--documentation/glut.html67
-rw-r--r--documentation/index.html8
-rw-r--r--documentation/intro.html2
-rw-r--r--documentation/opengl.html4
-rw-r--r--documentation/osissues.html19
-rw-r--r--documentation/preface.html6
-rw-r--r--documentation/subclassing.html2
12 files changed, 109 insertions, 32 deletions
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 @@
<H3>Class Hierarchy</H3>
<UL>
<PRE>
-<A href=Fl_Widget.html#Fl_Widget>Fl_Widget</A>
+<A href=Fl_Group.html#Fl_Group>Fl_Group</A>
|
+----<B>Fl_Tile</B>
- |
- +----<A href=Fl_Pack.html#Fl_Pack>Fl_Pack</A>, <A href=Fl_Scroll.html#Fl_Scroll>Fl_Scroll</A>, <A href=Fl_Tabs.html#Fl_Tabs>Fl_Tabs</A>, <A href=#Fl_Tile>Fl_Tile</A>, <A href=Fl_Window.html#Fl_Window>Fl_Window</A>
</PRE>
</UL>
<H3>Include Files</H3>
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). </LI>
It is undefined what happens if the current size does not fit in the
constraints passed to <TT>size_range()</TT>.
<H4><A name=Fl_Window.show>virtual void Fl_Window::show()
-<BR> int Fl_Window::show(int argc, char **argv, int i)
<BR> void Fl_Window::show(int argc, char **argv)</A></H4>
- 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.
<P>If the window is already shown then it is restored and raised to the
top. This is really convenient because your program can call <TT>show()</TT>
at any time, even if the window is already up. It also means that <TT>
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 &quot;Settings&quot; from the
&quot;Project&quot; menu and then changing the &quot;Preprocessor&quot; settings under the
-&quot;C/C++&quot; tab. Similarly, you will need to add the FLTK library to the
-&quot;Link&quot; settings.
+&quot;C/C++&quot; tab. You will also need to add the FLTK and WinSock (WSOCK32.LIB)
+libraries to the &quot;Link&quot; settings.
<P>You can build your Microsoft Windows applications as Console or
WIN32 applications. If you want to use the standard C <TT>main()</TT>
function as the entry point, FLTK includes a <TT>WinMain()</TT>
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 <A href=#complex_shapes>
transformation matrix</A>, so you should only call these while it is
the identity.
+<H4>void fl_point(int x, int y)</H4>
+Draw a single pixel at the given coordinates.
<H4>void fl_rectf(int x, int y, int w, int h)</H4>
Color a rectangle that exactly fills the given bounding box.
<H4>void fl_rectf(int x, int y, int w, int h, uchar r, uchar g, uchar b)</H4>
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.
</TD>
-<TD VALIGN=TOP><IMG SRC="fluid_prefs.gif"></TD>
+<TD VALIGN=TOP WIDTH=226><IMG SRC="fluid_prefs.gif"></TD>
</TR>
</TABLE>
-The output filenames control the extensions or names of the files the are
+
+<P>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. </P>
<H4>Help/About FLUID</H4>
Pops up a panel showing the version of FLUID.
<H3>The Widget Panel</H3>
-<TABLE cellpadding=0 cellspacing=0 width=100%>
-<TR><TD>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 &quot;widget attribute panel&quot;.
<P>When you change attributes using this panel, the changes are
reflected immediately in the window. It is useful to hit the &quot;no
@@ -591,7 +591,9 @@ the widgets more accurately, especially when setting the box type.
for the fields. In this case the value for <I>one</I> of the widgets
is shown. But if you change this value, <I>all</I> of the selected
widgets are changed to the new value.
-<P>Hitting &quot;OK&quot; makes the changes permanent. Selecting a different
+<TABLE cellpadding=0 cellspacing=0 width=100%>
+<TR>
+<TD VALIGN=TOP>Hitting &quot;OK&quot; 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 &quot;visible&quot; attributes (such as the color, label, box) are not undone
by revert or cancel. Changes to code like the callbacks are undone,
however.
-</TD><TD><IMG src="fluid_widget.gif"></TD></TR>
-</TABLE>
<H3><A name=widget_attributes>Widget Attributes</A></H3>
<H4>Name (text field)</H4>
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. </P>
+</TD><TD VALIGN=TOP WIDTH=378><IMG src="fluid_widget.gif"></TD></TR>
+</TABLE>
<H4>Type (upper-right pulldown menu)</H4>
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 <TT>show()</TT> the window, call <TT>make_current()</TT>
again to set the context. </P>
<P><TT>~Fl_Glut_Window()</TT> is the same as <TT>glutDestroyWindow()</TT>
. </P>
+<H3>Members</H3>
+The <TT>Fl_Glut_Window</TT> class contains several public members that can
+be altered directly:
+<CENTER><TABLE WIDTH="80%" BORDER">
+<TR>
+ <TH>member</TH>
+ <TH>description</TH>
+</TR>
+<TR>
+ <TD>display</TD>
+ <TD>A pointer to the function to call to draw the normal planes.</TD>
+</TR>
+<TR>
+ <TD>entry</TD>
+ <TD>A pointer to the function to call when the mouse moves into
+ or out of the window.</TD>
+</TR>
+<TR>
+ <TD>keyboard</TD>
+ <TD>A pointer to the function to call when a regular key is pressed.</TD>
+</TR>
+<TR>
+ <TD>menu[3]</TD>
+ <TD>The menu to post when one of the mouse buttons is pressed.</TD>
+</TR>
+<TR>
+ <TD>mouse</TD>
+ <TD>A pointer to the function to call when a button is pressed or
+ released.</TD>
+</TR>
+<TR>
+ <TD>motion</TD>
+ <TD>A pointer to the function to call when the mouse is moved with
+ a button down.</TD>
+</TR>
+<TR>
+ <TD>overlaydisplay</TD>
+ <TD>A pointer to the function to call to draw the overlay planes.</TD>
+</TR>
+<TR>
+ <TD>passivemotion</TD>
+ <TD>A pointer to the function to call when the mouse is moved with
+ no buttons down.</TD>
+</TR>
+<TR>
+ <TD>reshape</TD>
+ <TD>A pointer to the function to call when the window is resized.</TD>
+</TR>
+<TR>
+ <TD>special</TD>
+ <TD>A pointer to the function to call when a special key is pressed.</TD>
+</TR>
+<TR>
+ <TD>visibility</TD>
+ <TD>A pointer to the function to call when the window is iconified
+ or restored (made visible.)</TD>
+</TR>
+</TABLE></CENTER>
+
<H3>Methods</H3>
<UL>
<LI><A href=#Fl_Glut_Window.Fl_Glut_Window>Fl_Glut_Window</A></LI>
<LI><A href=#Fl_Glut_Window.~Fl_Glut_Window>~Fl_Glut_Window</A></LI>
+<LI><A href=#Fl_Glut_Window.make_current>make_current</A></LI>
</UL>
<H4><A name=Fl_Glut_Window.Fl_Glut_Window>
Fl_Glut_Window::Fl_Glut_Window(int x, int y, int w, int h, const char
@@ -142,4 +202,9 @@ will create the window with a preset size, but the window manager will
choose the position according to it's own whims.
<H4><A name=Fl_Glut_Window.~Fl_Glut_Window>virtual
Fl_Glut_Window::~Fl_Glut_Window()</A></H4>
- Destroys the GLUT window. </BODY></HTML>
+ Destroys the GLUT window.
+<H4><A name="Fl_Glut_Window.make_current">void Fl_Glut_Window::make_current()</A></H4>
+Switches all drawing functions to the GLUT window.
+
+</BODY>
+</HTML>
diff --git a/documentation/index.html b/documentation/index.html
index c29e6d540..2c95634d0 100644
--- a/documentation/index.html
+++ b/documentation/index.html
@@ -1,6 +1,6 @@
<HTML>
<HEAD><meta name="robots" content="noindex">
- <TITLE>FLTK 1.0.4 Programming Manual</TITLE>
+ <TITLE>FLTK 1.0.8 Programming Manual</TITLE>
</HEAD>
<BODY>
@@ -8,9 +8,9 @@
<TR>
<TD ALIGN=CENTER VALIGN=MIDDLE><IMG SRC=FL.gif ALIGN=ABSMIDDLE></TD>
<TD ALIGN=CENTER VALIGN=MIDDLE>
-<H1>FLTK 1.0.4 Programming Manual</H1>
-Revision 11 by Michael Sweet, Craig P. Earls, and Bill Spitzak<BR>
-Copyright 1998-1999 by Bill Spitzak and others.<BR>
+<H1>FLTK 1.0.8 Programming Manual</H1>
+Revision 12 by Michael Sweet, Craig P. Earls, and Bill Spitzak<BR>
+Copyright 1998-2000 by Bill Spitzak and others.<BR>
</TD>
</TR>
<TR>
diff --git a/documentation/intro.html b/documentation/intro.html
index 1e827babf..19b9ca680 100644
--- a/documentation/intro.html
+++ b/documentation/intro.html
@@ -73,8 +73,6 @@ carefully optimized for code size and performance.</LI>
(only about 10% of the code is different).</LI>
<LI>Interactive user interface builder program. Output is
human-readable and editable C++ source code.</LI>
-<LI>Support for the X11 double buffering extension (emulation if not
-available and under Windows.)</LI>
<LI>Support for X11 overlay hardware (emulation if none and under
WIN32.)</LI>
<LI>Very small &amp; fast portable 2-D drawing library to hide Xlib and
diff --git a/documentation/opengl.html b/documentation/opengl.html
index 8a5ab0aa7..2de7430e3 100644
--- a/documentation/opengl.html
+++ b/documentation/opengl.html
@@ -104,8 +104,8 @@ int MyWindow::handle(int event) {
... Return 1 if you understand/use the shortcut event, 0 otherwise...
return 1;
default:
- // tell FLTK that I don't understand other events
- return 0;
+ // pass other events to the base class...
+ return Fl_Gl_Window::handle(event);
}
}
</PRE>
diff --git a/documentation/osissues.html b/documentation/osissues.html
index 83f6d6897..f9ec4a51a 100644
--- a/documentation/osissues.html
+++ b/documentation/osissues.html
@@ -232,10 +232,10 @@ MyWindow::~MyWindow() {
</PRE>
</UL>
<H3>Setting the Icon of a Window</H3>
- FLTK currently supports setting a window's icon *before* it is shown
+FLTK currently supports setting a window's icon *before* it is shown
using the <TT>Fl_Window::icon()</TT> method.
<H4>void Fl_Window::icon(char *)</H4>
- Sets the icon for the window to the passed pointer. You will need to
+Sets the icon for the window to the passed pointer. You will need to
cast the icon <TT>Pixmap</TT> to a <TT>char *</TT> when calling this
method. To set the icon using a bitmap compiled with your application
use:
@@ -249,6 +249,11 @@ Pixmap p = XCreateBitmapFromData(fl_display, DefaultRootWindow(fl_display),
window-&gt;icon((char *)p);
</PRE>
</UL>
+
+<P><B>Note:</B> you must call <A HREF="Fl_Window.html#Fl_Window.show">
+<TT>Fl_Window::show(argc, argv)</TT></A> for the icon to be used. The
+<TT>Fl_Window::show()</TT> method does not bind the icon to the window.
+
<H2>WIN32-Specific Interface</H2>
<UL>
<PRE>
@@ -330,6 +335,14 @@ application use:
window-&gt;icon((char *)LoadIcon(fl_display, MAKEINTRESOURCE(IDI_ICON)));
</PRE>
</UL>
+
+You can also use the <TT>LoadImage()</TT> and related functions to load
+specific resolutions or create the icon from bitmap data.
+
+<P><B>Note:</B> you must call <A HREF="Fl_Window.html#Fl_Window.show">
+<TT>Fl_Window::show(argc, argv)</TT></A> for the icon to be used. The
+<TT>Fl_Window::show()</TT> method does not bind the icon to the window.
+
<H3>How to Not Get a MSDOS Console Window</H3>
WIN32 has a really stupid mode switch stored in the executables that
controls whether or not to make a console window.
@@ -360,4 +373,4 @@ feature, not a bug. </P>
<P><TT>SetCapture</TT> (used by <TT>Fl::grab()</TT>) doesn't work, and
the main window title bar turns gray while menus are popped up. </P>
<P>FLUID does not support BMP files yet. </P>
-</BODY></HTML> \ No newline at end of file
+</BODY></HTML>
diff --git a/documentation/preface.html b/documentation/preface.html
index de053541b..228bc437b 100644
--- a/documentation/preface.html
+++ b/documentation/preface.html
@@ -1,9 +1,9 @@
<HTML>
<HEAD>
<META CONTENT="Written by Michael Sweet, Craig P. Earls, and Bill Spitzak" NAME=Author>
- <META CONTENT="Copyright 1998-1999 by Bill Spitzak and Others." NAME=Copyright>
- <META CONTENT="Revision 11" NAME=DocNumber>
- <TITLE>FLTK 1.0.4 Programming Manual</TITLE>
+ <META CONTENT="Copyright 1998-2000 by Bill Spitzak and Others." NAME=Copyright>
+ <META CONTENT="Revision 12" NAME=DocNumber>
+ <TITLE>FLTK 1.0.8 Programming Manual</TITLE>
</HEAD>
<BODY>
<H1 ALIGN=RIGHT><A NAME=preface>Preface</A></H1>
diff --git a/documentation/subclassing.html b/documentation/subclassing.html
index 943b954eb..6df01be99 100644
--- a/documentation/subclassing.html
+++ b/documentation/subclassing.html
@@ -218,7 +218,7 @@ int MyClass::handle(int event) {
}
return 0;
default:
- return 0;
+ return Fl_Widget::handle(event);
}
}
</PRE>