summaryrefslogtreecommitdiff
path: root/documentation/fluid.dox
diff options
context:
space:
mode:
authorAlbrecht Schlosser <albrechts.fltk@online.de>2008-09-17 21:13:03 +0000
committerAlbrecht Schlosser <albrechts.fltk@online.de>2008-09-17 21:13:03 +0000
commit74cbd55745e7c55a62be524279c707a572f6c688 (patch)
tree42413a44b04943949c1e9057d25895a51b3c4295 /documentation/fluid.dox
parenta2eaf60572320f112e3e9bebb57dbe14450258f0 (diff)
Another bunch of doxygen updates: *.dox. Fixed links and many html tags.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6287 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'documentation/fluid.dox')
-rw-r--r--documentation/fluid.dox28
1 files changed, 13 insertions, 15 deletions
diff --git a/documentation/fluid.dox b/documentation/fluid.dox
index 95c436277..b29156713 100644
--- a/documentation/fluid.dox
+++ b/documentation/fluid.dox
@@ -37,8 +37,8 @@ POSIX catgets interfaces.
main()</TT> function) into the <TT>.fl</TT> file and thus making the <TT>.cxx</TT> file a
single source file to compile. Most programs are more complex than
this, so you write other <TT>.cxx</TT> files that call the FLUID functions.
-These <TT>.cxx</TT> files must <TT>#include</TT> the <TT>.h</TT> file or they can <TT>
-#include</TT> the <TT>.cxx</TT> file so it still appears to be a single source
+These <TT>.cxx</TT> files must <TT>\#include</TT> the <TT>.h</TT> file or they can <TT>
+\#include</TT> the <TT>.cxx</TT> file so it still appears to be a single source
file.
\image html fluid-org.gif "Figure 9-1: FLUID organization"
@@ -154,9 +154,7 @@ how to:
constructor and any member functions necessary.
<li>Use FLUID to set callbacks member functions of a custom widget
classes.
-<li>Subclass an <a
-href="Fl_Gl_Window.html#Fl_Gl_Window"><TT>Fl_Gl_Window</TT></A> to suit
-your purposes.
+<li>Subclass an Fl_Gl_Window to suit your purposes.
</ol>
<h3>The CubeView Class</h3>
@@ -361,7 +359,7 @@ CubeView defined in the previous section using FLUID.
<h4><a name="defui">Defining the CubeViewUI Class</a></h4>
<P>Once you have started FLUID, the first step in defining a class is to
-create a new class within FLUID using the \em New->Code->Class</b>
+create a new class within FLUID using the \em New->Code->Class
menu item. Name the class "CubeViewUI" and leave the
subclass blank. We do not need any inheritance for this
window. You should see the new class declaration in the FLUID
@@ -416,9 +414,9 @@ This will be no ordinary box, however.
display CubeView is to enter CubeView in the "Class:" text
entry box. This tells FLUID that it is not an <tt>Fl_Box</tt>, but a
similar widget with the same constructor. In the "Extra
-Code:" field enter <tt>#include "CubeView.h"</tt>
+Code:" field enter <tt>\#include "CubeView.h"</tt>
-<p>This <tt>#include</tt> is important, as we have just included
+<p>This <tt>\#include</tt> is important, as we have just included
CubeView as a member of CubeViewUI, so any public CubeView methods are
now available to CubeViewUI.
@@ -595,7 +593,7 @@ changed the current file.
<H4>Edit/Undo (Ctrl+z)</H4>
-<P>This isn't implemented yet. You should do save often so you can
+<P>This isn't implemented yet. You should do save often so you can
recover from any mistakes you make.
<H4>Edit/Cut (Ctrl+x)</H4>
@@ -990,8 +988,8 @@ menus, and browsers.
<tt>Fl_Widget</tt>. Whatever identifier you type in here will
be the class that is instantiated.
-<P>In addition, no <tt>#include</tt> header file is put in the
-<TT>.h</TT> file. You must provide a <tt>#include</tt> line as
+<P>In addition, no <tt>\#include</tt> header file is put in the
+<TT>.h</TT> file. You must provide a <tt>\#include</tt> line as
the first line of the "Extra Code" which declares your
subclass.</P>
@@ -1032,7 +1030,7 @@ Otherwise is controls whether the widget is declared
<P>These four fields let you type in literal lines of code to
dump into the <TT>.h</TT> or <TT>.cxx</TT> files.
-<P>If the text starts with a <tt>#</tt> or the word
+<P>If the text starts with a <tt>\#</tt> or the word
<tt>extern</tt> then FLUID thinks this is an "include"
line, and it is written to the <TT>.h</TT> file. If the same
include line occurs several times then only one copy is
@@ -1301,7 +1299,7 @@ strings.
\image html fluid-gettext.gif "Figure 9-11: Internationalization using GNU gettext"
-<P>The "#include" field controls the header file to include for
+<P>The "\#include" field controls the header file to include for
I18N; by default this is \b <libintl.h>, the
standard I18N file for GNU gettext.
@@ -1324,7 +1322,7 @@ strings.
\image html fluid-catgets.gif "Figure 9-12: Internationalization using POSIX catgets"
-<P>The "#include" field controls the header file to include for
+<P>The "\#include" field controls the header file to include for
I18N; by default this is \b <nl_types.h>, the
standard I18N file for POSIX catgets.
@@ -1340,7 +1338,7 @@ The default set is 1 and rarely needs to be changed.
<H2><A NAME="limitations">Known limitations</A></H2>
Declaration Blocks can be used to temporarily block out already
-designed code using <code>#if 0</code> and <code>#endif</code>
+designed code using <tt>\#if 0</tt> and <tt>\#endif</tt>
type construction. This will effectively avoid compilation of
blocks of code. However, static code and data generated by this
segment (menu items, images, include statements, etc.) will still