mirrors/fltk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix documentaion typos and small errors.

Browse Source 
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10296 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Albrecht Schlosser 2014-09-08 23:51:20 +00:00
parent 2af3261d51
commit f459ecd82f
1 changed files with 18 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
documentation/src/fluid.dox
View File

@ -50,7 +50,7 @@ the <tt>.cxx</tt> file so it still appears to be a single source file.
\image latex fluid-org.png "FLUID organization" width=12cm
Normally the FLUID file defines one or more functions or classes which
output C++ code. Each function defines a one or more FLTK
output C++ code. Each function defines one or more FLTK
windows, and all the widgets that go inside those windows.
Widgets created by FLUID are either "named", "complex named" or
@ -179,7 +179,7 @@ The CubeView class is a subclass of Fl_Gl_Window. It has methods for
setting the zoom, the \e x and \e y pan, and the rotation angle
about the \e x and \e y axes.
You can safely skip this section as long as you realize the CubeView
You can safely skip this section as long as you realize that CubeView
is a sublass of Fl_Gl_Window and will respond to calls from
CubeViewUI, generated by FLUID.
@ -390,7 +390,7 @@ browser window.
Click on the CubeViewUI class in the FLUID window and add a new method
by selecting <b>New->Code->Function/Method.</b> The name of the
function will also be CubeViewUI. FLUID will understands that this will
function will also be CubeViewUI. FLUID will understand that this will
be the constructor for the class and will generate the appropriate
code. Make sure you declare the constructor public.
@ -457,17 +457,17 @@ cube->redraw();
We call <tt>cube->redraw()</tt> after changing the value to update
the CubeView window. CubeView could easily be modified to do this, but
it is nice to keep this exposed in the case where you may want to do
it is nice to keep this exposed. In the case where you may want to do
more than one view change only redrawing once saves a lot of time.
There is no reason no wait until after you have added CubeView to
There is no reason to wait until after you have added CubeView to
enter these callbacks. FLUID assumes you are smart enough not to refer
to members or functions that don't exist.
\par Adding a Class Method
You can add class methods within FLUID that have nothing to do with the
GUI. An an example add a show function so that CubeViewUI can actually
GUI. As an example add a show function so that CubeViewUI can actually
appear on the screen.
Make sure the top level CubeViewUI is selected and select
@ -484,9 +484,9 @@ Once the new method has been added, highlight its name and select
\subsection fluid_addconst Adding Constructor Initialization Code
If you need to add code to initialize class, for example setting
If you need to add code to initialize a class, for example setting
initial values of the horizontal and vertical angles in the
CubeView, you can simply highlight the Constructor and select
CubeView, you can simply highlight the constructor and select
<b>New->Code->Code</b>. Add any required code.
\subsection fluid_gencode Generating the Code
@ -730,10 +730,9 @@ change the selection.
\par
Displays the project settings panel.
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.
The output filenames control the extensions or names of the files that
are generated by FLUID. If you check the "Include Header from Code"
button the code file will include the header file automatically.
\par
The \ref fluid_i18n "internationalization" options are described
@ -742,10 +741,10 @@ later in this chapter.
\image html fluid_prefs.png "Figure 9-7: FLUID Preferences Window"
\image latex fluid_prefs.png "FLUID Preferences Window" width=10cm
\par Edit/GUI Settings... (Shift+Ctrl+p)
\par Edit/Project Settings... (Shift+Ctrl+p)
\par
Displays the GUI settings panel. This panel is used
Displays the project settings ("Preferences") panel. This panel is used
to control the user interface settings.
\par New/Code/Function
@ -928,10 +927,9 @@ chooser.
\par Alignment (buttons)
\par
Where to draw the label. The arrows put it on that side of
the widget, you can combine the to put it in the corner. The
"box" button puts the label inside the widget, rather
than outside.
Where to draw the label. The arrows put it on that side of the
widget, you can combine them to put it in the corner. The "box"
button puts the label inside the widget, rather than outside.
\par
The \b clip button clips the label to the widget box, the
@ -1117,7 +1115,7 @@ blank then no variable is created.
You can name several widgets with "name[0]", "name[1]", "name[2]",
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.
in the array must be the same type.
\par Public (button)
@ -1125,7 +1123,7 @@ that in the array must be the same type.
Controls whether the widget is publicly accessible. When
embedding widgets in a C++ class, this controls whether the
widget is \p public or \p private in the class.
Otherwise is controls whether the widget is declared
Otherwise it controls whether the widget is declared
\p static or global (\p extern ).
\par Extra Code (text fields)