diff options
| author | Michael R Sweet <michael.r.sweet@gmail.com> | 1999-01-07 16:36:11 +0000 |
|---|---|---|
| committer | Michael R Sweet <michael.r.sweet@gmail.com> | 1999-01-07 16:36:11 +0000 |
| commit | 367f908d8ed5a3464b9676223a26ddf4e11bdb5b (patch) | |
| tree | 2b0ec583852973ccf7b9804957e78d474e0e7e5d /documentation/fluid.html | |
| parent | 85e6f449590eeb6e09f7547733adf4c7137470d0 (diff) | |
"Final" changes for first draft of 1.0 documentation.
git-svn-id: file:///fltk/svn/fltk/trunk@187 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'documentation/fluid.html')
| -rw-r--r-- | documentation/fluid.html | 578 |
1 files changed, 275 insertions, 303 deletions
diff --git a/documentation/fluid.html b/documentation/fluid.html index 47cb7d7fd..55a46d55f 100644 --- a/documentation/fluid.html +++ b/documentation/fluid.html @@ -1,269 +1,239 @@ <HTML> <BODY> -<H1 ALIGN=RIGHT><A NAME="fluid">6 - Programming with FLUID</A></H1> +<H1 ALIGN=RIGHT><A NAME="FLUID">8 - Programming with FLUID</A></H1> This chapter shows how to use the Fast Light User-Interface Designer ("FLUID") to create your GUIs. <H2>What is FLUID?</H2> -<H2>Creating A Simple Program</H2> +The Fast Light User Interface Designer, or "FLUID", is a graphical +editor that is used to produce FLTK source code. -<H2>Functions</H2> - -<H2>Windows</H2> - -<H2>Groups</H2> - -<H2>Tabs</H2> - -<H2>Menus</H2> - -<H2>Using Custom Widgets</H2> - -<H2>Classes</H2> - -</BODY> -</HTML> -<title>fluid Reference Manual</title> - -<center><img src=fluid.gif></center> - -<h2>What is Fluid?</h2> - -<p>Fluid (the Fast Light User Interface Designer) is a graphical -editor that is used to produce fltk source code. - -<p>Fluid edits and saves it's state in ".fl" files. These files are -text, and you could (with care) edit them in a text editor, perhaps to +<p>FLUID edits and saves its state in ".fl" files. These files are +text, and you can (with care) edit them in a text editor, perhaps to get some special effects. -<p>Fluid can "compile" the .fl file into a .C and a .H file. The .C -file defines all the objects from the .fl file and the .H file +<p>FLUID can "compile" the .fl file into a .cxx and a .h file. The .cxx +file defines all the objects from the .fl file and the .h file declares all the global ones. <p>A simple program can be made by putting all your code (including a -main() function) into the .fl file and thus making the .C file a -single source file to compile. Normally though you write other .C -files that call the fluid functions. These .C files must #include the -.H file output (or they can #include the .C file so it still appears -to make to be a single source file). - -<pre> - _________ - / / - __________ +->/.C file /--------+ - / / / /________/ | - /.fl file /<==>[fluid]< #include | - /_________/ \ ___v_____ | - \ / / | - +>/.H file / | - /________/ | - ^ | - #include | - ___|_____ | __________ - / / V / / - / main.C /--->[c++,link]-->/ program / - /________/ /_________/ -</pre> - -<p>Normally the fluid file defines one or more "functions", which -output C++ functions. Each function defines a one or more fltk +<tt>main()</tt> function) into the .fl file and thus making the .cxx +file a single source file to compile. Most programs are more complex +than this, so you write other .cxx files that call the FLUID +functions. These .cxx files must <tt>#include</tt> the .h file or +they can <tt>#include</tt> the .cxx file so it still appears to be a single +source file. + +<hr break> +<ul><pre> + ___________ + / / + __________ +->/.cxx file /--------+ + / / / /__________/ | + /.fl file /<==>[FLUID]< #include | + /_________/ \ ___v_____ | + \ / / | + +>/.h file / | + /________/ | + ^ | + #include | + ___|_______ | __________ + / / V / / + / main.cxx /--->[c++,link]-->/ program / + /__________/ /_________/ +</pre></ul> + +<p>Normally the FLUID file defines one or more "functions", which +output C++ functions. Each function defines a one or more FLTK windows, and all the widgets that go inside those windows. -<p>Widgets created by fluid are either "named", "complex named" or -"unnamed". A named widget has a legal C++ variable identifier as it's -name (ie only alphanumeric and underscore). In this case fluid -defines a global variable that will point at the widget after the -function defining it is called. A "complex named" object has -punctuation such as '.' or '->' or any other symbols in it's name. In -this case fluid assigns a pointer to the widget to the name, but does +<p>Widgets created by FLUID are either "named", "complex named" or +"unnamed". A named widget has a legal C++ variable identifier as its +name (i.e. only alphanumeric and underscore). In this case FLUID +defines a global variable or class member that will point at the widget +after the function defining it is called. A "complex named" object has +punctuation such as '.' or '->' or any other symbols in its name. In +this case FLUID assigns a pointer to the widget to the name, but does not attempt to declare it. This can be used to get the widgets into structures. An "unnamed" widget has a blank name and no pointer to them is stored. <p>Widgets may either call a named callback function that you write in another source file, or you can supply a small piece of C++ source and -fluid will write a private callback function into the .C file. +FLUID will write a private callback function into the .cxx file. -<a name=tutorial> -<h2>Worlds shortest tutorial</h2> +<h2>A Short Tutorial</h2> <ol> -<li>Type "fluid&" + <li>Type "FLUID&" -<li>Pick "New/code/function" off the menu. + <li>Pick "New/code/function" off the menu. -<li>Hit Tab, Delete to delete the function name and hit OK. This is -how you get fluid to output a "main()" function. The text "main()" -with a triangle next to it should appear highlighted in the main -window. + <li>Hit Tab, Delete to delete the function name and hit OK. This is + how you get FLUID to output a "main()" function. The text "main()" + with a triangle next to it should appear highlighted in the main + window. -<li>Pick "New/group/Window" off the menu. + <li>Pick "New/group/Window" off the menu. -<li>Move the new window and resize it to the size you want. + <li>Move the new window and resize it to the size you want. -<li>Pick "New/buttons/Button" off the menu. + <li>Pick "New/buttons/Button" off the menu. -<li>Hit the "OK" button to dismiss the panel that appears. + <li>Hit the "OK" button to dismiss the panel that appears. -<li>In the window you created, try moving the button by dragging it -around. Notice that it "snaps" to fixed locations. If you want to -drag it smoothly, hold down Alt. You can also change the size of the -steps with Edit/Preferences. + <li>In the window you created, try moving the button by dragging it + around. Notice that it "snaps" to fixed locations. If you want to + drag it smoothly, hold down Alt. You can also change the size of the + steps with Edit/Preferences. -<li>Try resizing the widget by dragging the edges and corners. + <li>Try resizing the widget by dragging the edges and corners. -<li>Type Alt+c to copy the widget. + <li>Type Alt+c to copy the widget. -<li>Type Alt+v to paste a copy into the window. + <li>Type Alt+v to paste a copy into the window. -<li>Type Alt+v several times. + <li>Type Alt+v several times. -<li>Drag the widgets and resize them so they don't overlap. Notice -that you have to click a widget to pick it first, then drag it. + <li>Drag the widgets and resize them so they don't overlap. Notice + that you have to click a widget to pick it first, then drag it. -<li>Try selecting several widgets by dragging a box around them. Check -what happens when you move them, or when you drag an edge to resize -them. + <li>Try selecting several widgets by dragging a box around them. Check + what happens when you move them, or when you drag an edge to resize + them. -<li>You can also use Shift+click to toggle widgets on and off. + <li>You can also use Shift+click to toggle widgets on and off. -<li>You can also select widgets by clicking on them in the list in the -main window, try that. + <li>You can also select widgets by clicking on them in the list in the + main window, try that. -<li>Double-click one of the widgets. You will get a control panel. + <li>Double-click one of the widgets. You will get a control panel. -<li>Try changing the "label". Try changing other items near the top of -the panel. To see any changes to the box type clearer, type "Alt+o" -to make the red overlay disappear. + <li>Try changing the "label". Try changing other items near the top of + the panel. To see any changes to the box type clearer, type "Alt+o" + to make the red overlay disappear. -<li>Type "#include <stdlib.h>" into the first line of "extra code:". + <li>Type "#include <stdlib.h>" into the first line of "extra code:". -<li>Type "exit(0);" into the "callback:". + <li>Type "exit(0);" into the "callback:". -<li>Hit OK. + <li>Hit OK. -<li>Pick "File/Save As" off the menu. + <li>Pick "File/Save As" off the menu. -<li>Type "test.fl" into the file chooser and hit return. + <li>Type "test.fl" into the file chooser and hit return. -<li>Pick "File/Write Code" off the menu, hit OK on the confirmation panel. + <li>Pick "File/Write Code" off the menu, hit OK on the confirmation panel. -<li>Go back to your terminal window. Type "more test.C" and "more -test.H" and you can see the code it made. Also try "more test.fl" to -see how fluid saves it's data. + <li>Go back to your terminal window. Type "more test.cxx" and "more + test.h" and you can see the code it made. Also try "more test.fl" to + see how FLUID saves its data. -<li>Type "make test" (you may have to add libaries to your Makefile). + <li>Type "make test" (you may have to add libaries to your Makefile). -<li>Type "./test" to run your program. + <li>Type "./test" to run your program. -<li>Try the buttons. The one you put the code into will exit the -program. + <li>Try the buttons. The one you put the code into will exit the + program. -<li>Type "Alt+Q" to exit fluid. + <li>Type "Alt+Q" to exit FLUID. -<li>Ok, now try to make a real program. + <li>Ok, now try to make a real program. </ol> -<a name=running> -<h2>Running fluid</h2> +<h2>Running FLUID Under UNIX</h2> -<p>Type +To run FLUID under UNIX, type: -<pre> - fluid <name>.fl & -</pre> +<ul><pre> +fluid <i>filename.fl</i> & +</pre></ul> -<p>to edit the .fl file <name>.fl. If the file does not exist you -will get an error pop-up, but if you dismiss it you will be editing a -blank setup of that name. You can run fluid without any name, in +to edit the .fl file <i>filename.fl</i>. If the file does not exist +you will get an error pop-up, but if you dismiss it you will be editing +a blank file of that name. You can run FLUID without any name, in which case you will be editing an unnamed blank setup (but you can use save-as to write it to a file). -<p>You can provide any of the standard fltk switches before the name: +<p>You can provide any of the standard FLTK switches before the name: -<pre> - -display host:n.n - -geometry WxH+X+Y - -title windowtitle - -name classname - -iconic - -fg color - -bg color - -bg2 color -</pre> +<ul><pre> +-display host:n.n +-geometry WxH+X+Y +-title windowtitle +-name classname +-iconic +-fg color +-bg color +-bg2 color +</pre></ul> -<p>Changing the colors may be useful to see what your interface will +Changing the colors may be useful to see what your interface will look at if the user calls it with the same switches. <p>In the current version, if you don't go into the background (with -'&') then you will be able to abort fluid by typing ^C on the terminal. +'&') then you will be able to abort FLUID by typing ^C on the terminal. It will exit immediately, losing any changes. -<a name=compiling> +<h2>Running FLUID Under Microsoft Windows</h2> + +To run FLUID under windows, double-click on the <i>fluid.exe</i> file. +You can also run FLUID from the </i>Command Prompt</i> window (FLUID +always runs in the background). + <h2>Compiling .fl files</h2> -<p>Fluid can also be called as a command-line "compiler" to create the -.C and .H file from a .fl file. To do this type +FLUID can also be called as a command-line "compiler" to create the +.cxx and .h file from a .fl file. To do this type: -<pre> - fluid -c <name>.fl -</pre> +<ul><pre> + FLUID -c <i>filename.fl</i> +</pre></ul> -<p>This will read the .fl file and write <name>.C and -<name>.H (the directory will be stripped, they are written to the -current directory always), and then exit. If there are any errors +This will read the .fl file and write <i>filename.cxx</i> and +<i>filename.h</i>. The directory will be stripped, so they are written to +the current directory always. If there are any errors reading or writing the files it will print the error and exit with a -non-zero code. This is useful in a makefile. A line like this will +non-zero code. In a makefile you can use a line like this: work: -<pre> -my_panels.H my_panels.C : my_panels.fl +<ul><pre> +my_panels.h my_panels.cxx: my_panels.fl fluid -c my_panels.fl -</pre> +</pre></ul> -<p>Some versions of Make will accept rules like this to allow all .fl +Some versions of make will accept rules like this to allow all .fl files found to be compiled: -<pre> -.SUFFIXES : .fl .C .H -.fl.H : +<ul><pre> +.SUFFIXES: .fl .cxx .h +.fl.h .fl.cxx: fluid -c $< -.fl.C : - fluid -c $< -</pre> - -<p>Some versions of Make (gnumake) may prefer this syntax: - -<pre> -%.H: %.fl - fluid -c $< - -%.C: %.fl - fluid -c $< -</pre> +</pre></ul> -<a name=browser> <h2>The Widget Browser</h2> -<p><img src=fluid_main.gif align = left> +<table cellpadding=0 cellspacing=0> +<tr> +<td> -<p>The main window shows a menu bar and a scrolling browser of all the +The main window shows a menu bar and a scrolling browser of all the defined widgets. The name of the .fl file being edited is shown in the window title. <p>The widgets are stored in a hierarchy. You can open and close a level by clicking the "triangle" at the left of a widget. This -widget is the <i>parent</i>, and all the widgets listed below it are it's +widget is the <i>parent</i>, and all the widgets listed below it are its <i>children</i>. There can be zero children. <p>The top level of the hierarchy is <i>functions</i>. Each of these -will produce a single C++ public function in the output .C file. -Calling the function will create all of it's child windows. +will produce a single C++ public function in the output .cxx file. +Calling the function will create all of its child windows. <p>The second level of the hierarchy is <i>windows</i>. Each of these produces an instance of class Fl_Window. @@ -277,7 +247,12 @@ provide the well-known file-card tab interface. as "main_panel" in the example), or if <i>unnamed</i> as their <i>type</i> and <i>label</i> (such as "Button "the green""). -<p>You <i>select</i> widgets by clicking on their names, which +</td> +<td><img src="fluid_main.gif" width=245></td> +</tr> +</table> + +You <i>select</i> widgets by clicking on their names, which highlights them (you can also select widgets from any displayed window). You can select many widgets by dragging the mouse across them, or by using shift+click to toggle them on and off. To select no @@ -289,74 +264,73 @@ this. widgets you have picked) by typing the F1 key. This will bring up a control panel or window from which you can change the widget. -<a name=menu> <h2>Menu Items</h2> <p>The menu bar at the top is duplicated as a pop-up menu on any displayed window. The shortcuts for all the menu items work in any window. The menu items are: -</ul><h4>File/Open... (Alt+Shift+O)</h4><ul> +<h3>File/Open... (Alt+Shift+O)</h3> Discard the current editing session and read in a different .fl file. You are asked for confirmation if you have changed the current data. -<p>fluid can also read .fd files produced by the Forms and XForms -"fdesign" programs. It is best to read them with Merge. Fluid does not +<p>FLUID can also read .fd files produced by the Forms and XForms +"fdesign" programs. It is best to read them with Merge. FLUID does not understand everything in a .fd file, and will print a warning message on the controlling terminal for all data it does not understand. You will probably need to edit the resulting setup to fix these errors. -Be careful not to save the file without changing the name, as fluid -will write over the .fd file with it's own format, which fdesign +Be careful not to save the file without changing the name, as FLUID +will write over the .fd file with its own format, which fdesign cannot read! -</ul><h4>File/Save (Alt+s)</h4><ul> +<H3>File/Save (Alt+s)</H3> Write the current data to the .fl file. If the file is unnamed -(because fluid was started with no name) then ask for a file name. +(because FLUID was started with no name) then ask for a file name. -</ul><h4>File/Save As...(Alt+Shift+S)</h4><ul> +<H3>File/Save As...(Alt+Shift+S)</H3> Ask for a new name to save the file as, and save it. -</ul><h4>File/Merge... (Alt+i)</h4><ul> +<H3>File/Merge... (Alt+i)</H3> Insert the contents of another .fl file, without changing the name of the current .fl file. All the functions (even if they have the same names as the current ones) are added, you will have to use cut/paste to put the widgets where you want. -</ul><h4>File/Write code (Alt+Shift+C)</h4><ul> +<H3>File/Write code (Alt+Shift+C)</H3> -"Compiles" the data into a .C and .H file. These are exactly the same -as the files you get when you run fluid with the -c switch. +"Compiles" the data into a .cxx and .h file. These are exactly the same +as the files you get when you run FLUID with the -c switch. <p>The output file names are the same as the .fl file, with the -leading directory and trailing ".fl" stripped, and ".H" or ".C" +leading directory and trailing ".fl" stripped, and ".h" or ".cxx" appended. Currently there is no way to override this. -</ul><h4>File/Quit (Alt+q)</h4><ul> +<H3>File/Quit (Alt+q)</H3> -Exit fluid. You are asked for confirmation if you have changed the +Exit FLUID. You are asked for confirmation if you have changed the current data. -</ul><h4>Edit/Undo (Alt+z)</h4><ul> +<H3>Edit/Undo (Alt+z)</H3> Don't you wish... This isn't implemented yet. You should do save often so that any mistakes you make don't irretrivably destroy your data. -</ul><h4>Edit/Cut (Alt+x)</h4><ul> +<H3>Edit/Cut (Alt+x)</H3> Delete the selected widgets and all their children. These are saved to a "clipboard" file (/usr/tmp/cut_buffer.fl) and can be pasted back -into this fluid or any other one. +into this FLUID or any other one. -</ul><h4>Edit/Copy (Alt+c)</h4><ul> +<H3>Edit/Copy (Alt+c)</H3> Copy the selected widgets and all their children to the "clipboard" file. -</ul><h4>Edit/Paste (Alt+c)</h4><ul> +<H3>Edit/Paste (Alt+c)</H3> Paste in the widgets in the clipboard file. @@ -372,7 +346,7 @@ doing a paste. <p>Cut/paste is the only way to change the parent of a widget. -</ul><h4>Edit/Select All (Alt+a)</h4><ul> +<H3>Edit/Select All (Alt+a)</H3> Select all widgets in the same group as the current selection. @@ -380,20 +354,20 @@ Select all widgets in the same group as the current selection. that group's parent. Repeatedly typing Alt+a will select larger and larger groups of widgets until everything is selected. -</ul><h4>Edit/Open... (F1 or double click)</h4><ul> +<H3>Edit/Open... (F1 or double click)</H3> If the current widget is a window and it is not displayed, display it. Otherwise open a control panel for the most recent (and possibly all) selected widgets. -</ul><h4>Edit/Sort</h4><ul> +<H3>Edit/Sort</H3> All the selected widgets are sorted into left to right, top to bottom -order. You need to do this to make navigation keys in fltk work +order. You need to do this to make navigation keys in FLTK work correctly. You may then fine-tune the sorting with "Earlier" and "Later". This does not affect the positions of windows or functions. -</ul><h4>Edit/Earlier (F2)</h4><ul> +<H3>Edit/Earlier (F2)</H3> All the selected widgets are moved one earlier in order amoung the children of their parent (if possible). This will affect navigation @@ -401,35 +375,35 @@ order, and if the widgets overlap it will affect how they draw, as the later widget is drawn on top of the earlier one. You can also use this to reorder functions and windows within functions. -</ul><h4>Edit/Later (F3)</h4><ul> +<H3>Edit/Later (F3)</H3> All the selected widgets are moved one later in order amoung the children of their parent (if possible). -</ul><h4>Edit/Group (F7)</h4><ul> +<H3>Edit/Group (F7)</H3> Create a new Fl_Group and make all the currently selected widgets be children of it. -</ul><h4>Edit/Ungroup (F8)</h4><ul> +<H3>Edit/Ungroup (F8)</H3> If all the children of a group are selected, delete that group and -make them all be children of it's parent. +make them all be children of its parent. -</ul><h4>Edit/Overlays on/off (Alt+o)</h4><ul> +<H3>Edit/Overlays on/off (Alt+o)</H3> Toggle the display of the red overlays off, without changing the selection. This makes it easier to see box borders and how the layout looks. The overlays will be forced back on if you change the selection. -</ul><h4>Edit/Preferences (Alt+p)</h4><ul> +<H3>Edit/Preferences (Alt+p)</H3> Currently the only preferences are for the "alignment grid" that all widgets snap to when you move them and resize them, and for the "snap" -which is how far a widget has to be dragged from it's original +which is how far a widget has to be dragged from its original position to actually change. -</ul><h4>New/code/Function</h4><ul> +<H3>New/code/Function</H3> Create a new C function. You will be asked for a name for the function. This name should be a legal C++ function template, without @@ -441,17 +415,17 @@ as returning an Fl_Window*. The unnamed window will be returned from it (more than one unnamed window is useless). If the function contains only named windows it will be declared as returning void. -<p>It is possible to make the .C output be a self-contained program +<p>It is possible to make the .cxx output be a self-contained program that can be compiled and executed. This is done by deleting the function name, in which case "main(argc,argv)" is used. The function will call show() on all the windows it creates and then call Fl::run(). This can be used to test resize behavior or other parts of the user interface. I'm not sure if it is possible to create really -useful programs using just Fluid. +useful programs using just FLUID. <p>You can change the function name by double clicking the function. -</ul><h4>New/Window</h4><ul> +<H3>New/Window</H3> Create a new Fl_Window. It is added to the currently selected function, or to the function containing the currently selected item. @@ -461,7 +435,7 @@ to whatever size you require. <p>You also get the window's control panel, which is almost exactly the same as any other Fl_Widget, and is described in the next chapter. -</ul><h4>New/...</h4><ul> +<H3>New/...</H3> All other items on the New menu are subclasses of Fl_Widget. Creating them will add them to the currently selected group or window, or the @@ -472,29 +446,28 @@ possible. <p>When you create the widget you will get the widget's control panel, described in the next chapter. -</ul><h4>Help/About fluid</h4><ul> - -Pops up a panel showing the version of fluid. +<H3>Help/About FLUID</H3> -</ul><h4>Help/Manual</h4><ul> +Pops up a panel showing the version of FLUID. -Not yet implemented. Use netscape to read these pages instead. +<H3>Help/Manual</H3> -</ul> +Not yet implemented. Use a HTML or PDF file viewer to read these pages +instead. -<a name=widget_panel> <h2>The Widget Panel</h2> -When you double-click a widget or a set of widgets you will get the -"widget attribute panel": +<table cellpadding=0 cellspacing=0> +<tr> +<td> -<p><img align = left src = fluid_widget.gif> +When you double-click a widget or a set of widgets you will get the +"widget attribute panel". -<p>When you change attributes -using this panel, the changes are reflected immediately in the window. -It is useful to hit the "no overlay" button (or type Alt+o) to -hide the red overlay so you can see the widgets more accurately, -especially when setting the box type. +<p>When you change attributes using this panel, the changes are +reflected immediately in the window. It is useful to hit the "no +overlay" button (or type Alt+o) to hide the red overlay so you can see +the widgets more accurately, especially when setting the box type. <p>If you have several widgets selected, they may have different values for the fields. In this case the value for <i>one</i> of the @@ -502,12 +475,17 @@ widgets is shown. But if you change this value, <i>all</i> the selected widgets are changed to the new value. <p>Hitting "OK" makes the changes permanent. Selecting a different -widget also makes the changes permanent. Fluid checks for simple +widget also makes the changes permanent. FLUID checks for simple syntax errors in any code (such as mismatched parenthesis) before saving any text. -<p>"Revert" or "Cancel" put everything back to when you last brought -up the panel or hit OK. However in the current version of Fluid, +</td> +<td><img src="fluid_widget.gif" width=225></td> +</tr> +</table> + +"Revert" or "Cancel" put everything back to when you last brought +up 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 is undone, however. @@ -515,55 +493,55 @@ is undone, however. <a name=widget_attributes> <h2>Widget Attributes</h2> -</ul><h4>Name (text field)</h4><ul> +<H3>Name (text field)</H3> Name of a global C variable to declare, and to store a pointer to this widget into. This variable will be of type "<class>*". If the name is blank then no variable is created. <p>You can name several widgets with "name[0]", "name[1]", "name[2]", -etc. This will cause Fluid to declare an array of pointers. The +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. -</ul><h4>Type (upper-right pulldown menu)</h4><ul> +<H3>Type (upper-right pulldown menu)</H3> Some classes have subtypes that modify their appearance or behavior. You pick the subtype off of this menu. -</ul><h4>Box (pulldown menu)</h4><ul> +<H3>Box (pulldown menu)</H3> The boxtype to draw as a background for the widget. <p>Many widgets will work, and draw faster, with a "frame" instead of a "box". A frame does not draw the colored interior, leaving whatever -was already there visible. Be careful, as fluid may draw this ok but +was already there visible. Be careful, as FLUID may draw this ok but the real program leave unwanted stuff inside the widget. <p>If a window is filled with child widgets, you can speed up -redrawing by changing the window's box type to "NO_BOX". Fluid will +redrawing by changing the window's box type to "NO_BOX". FLUID will display a checkerboard for any areas that are not colored in by boxes (notice that this checkerboard is not drawn by the resulting program, instead random garbage is left there). -</ul><h4>Color</h4><ul> +<H3>Color</H3> <p>The color to draw the box with. -</ul><h4>Color2</h4><ul> +<H3>Color2</H3> -<p>Some widgets will use this color for certain parts. Fluid does not +<p>Some widgets will use this color for certain parts. FLUID does not always show the result of this: this is the color buttons draw in when pushed down, and the color of input fields when they have the focus. -</ul><h4>Label</h4><ul> +<H3>Label</H3> String to print next to or inside the button. <p>You can put newlines into the string to make multiple lines, the easiest way is by typing ctrl+j. -</ul><h4>Label style (pull down menu)</h4><ul> +<H3>Label style (pull down menu)</H3> How to draw the label. Normal, shadowned, engraved, and embossed change the appearance of the text. "symbol" requires the label to @@ -575,46 +553,46 @@ href=#images>"Image..."</a>. This lets you use the contents of an image file (currently an xpm pixmap or xbm bitmap) to label the widget. -</ul><h4>Label alignement (buttons)</h4><ul> +<H3>Label alignement (buttons)</H3> 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. -</ul><h4>Label font</h4><ul> +<H3>Label font</H3> Font to draw the label in. Ignored by symbols, bitmaps, and pixmaps. Your program can change the actual font used by these "slots", in case you want some font other than the 16 provided. -</ul><h4>Label size</h4><ul> +<H3>Label size</H3> Point size for the font to draw the label in. Ignored by symbols, bitmaps, and pixmaps. To see the result without dismissing the panel, type the new number and then Tab. -</ul><h4>Label color</h4><ul> +<H3>Label color</H3> Color to draw the label. Ignored by pixmaps (bitmaps, however, do use this color as the foreground color). -</ul><h4>Text font, size, color</h4><ul> +<H3>Text font, size, color</H3> Some widgets display text, such as input fields, pull-down menus, browsers. You can change this here. -</ul><h4>Visible</h4><ul> +<H3>Visible</H3> If you turn this off the widget is hidden initially. Don't change this for windows or for the immediate children of a Tabs group. -</ul><h4>Active</h4><ul> +<H3>Active</H3> If you turn this off the widget is deactivated initially. Currently -no fltk widgets display the fact that they are inactive (like by graying +no FLTK widgets display the fact that they are inactive (like by graying out), but this may change in the future. -</ul><h4>Resizable</h4><ul> +<H3>Resizable</H3> If a window is resizable or has an immediate child that is resizable, then the user will be able to resize it. In addition all the size @@ -627,41 +605,41 @@ other children. <p>You can get more complex behavior by making invisible boxes the resizable widget, or by using hierarchies of groups. Unfortunatley -the only way to test it is to compile the program. Resizing the fluid +the only way to test it is to compile the program. Resizing the FLUID window is <i>not</i> the same as what will happen in the user program. -</ul><h4>Hotspot</h4><ul> +<H3>Hotspot</H3> Each window may have exactly one hotspot (turning this on will turn off any others). This will cause it to be positioned with that widget -centered on the mouse. This position is determined <i>when the fluid +centered on the mouse. This position is determined <i>when the FLUID function is called, so you should call it immediately before showing the window</i>. If you want the window to hide and then reappear at a new position, you should have your program set the hotspot itself just before show(). -</ul><h4>subclass</h4><ul> +<H3>subclass</H3> This is how you put your own subclasses of Fl_Widget in. Whatever identifier you type in here will be the class that is instantiated. -<p>In addition, no #include header file is put in the .H file. You +<p>In addition, no #include header file is put in the .h file. You must provide a #include line as the first of the "extra code" which declares your subclass. <p>The class had better be similar to the class you are spoofing. It does not have to be a subclass. It is sometimes useful to change this -to another fltk class: currently the only way to get a double-buffered +to another FLTK class: currently the only way to get a double-buffered window is to change this field for the window to "Fl_Double_Window" -and to add "#include <FL/Fl_Double_Window.H>" to the extra code. +and to add "#include <FL/Fl_Double_Window.h>" to the extra code. -</ul><h4>Extra code</h4><ul> +<H3>Extra code</H3> These four fields let you type in literal lines of code to dump into -the .H or .C files. +the .h or .cxx files. -<p>If the text starts with a '#' or the word "extern" then fluid -thinks this is an "include" line, and it is written to the .H file. +<p>If the text starts with a '#' or the word "extern" then FLUID +thinks this is an "include" line, and it is written to the .h file. If the same include line occurs several times then only one copy is written. @@ -671,37 +649,37 @@ pointed to by the local variable 'w'. You can also access any arguments passed to the function here, and any named widgets that are before this one. -<p>Fluid will check for matching parenthesis, braces, and quotes, but +<p>FLUID will check for matching parenthesis, braces, and quotes, but does not do much other error checking. Be careful here, as it may be hard to figure out what widget is producing an error in the compiler. If you need more than 4 lines you probably should call a function in -your own .C code. +your own .cxx code. -</ul><h4>Callback</h4><ul> +<H3>Callback</H3> This can either be the name of a function, or a small snippet of -code. Fluid thinks that if there is any punctuation then it is code. +code. FLUID thinks that if there is any punctuation then it is code. <p>A name names a function in your own code. It must be declared as "void <name>(<class>*,void*)". -<p>A code snippet is inserted into a static function in the .C output +<p>A code snippet is inserted into a static function in the .cxx output file. The function prototype is "void f(<class>* o, void* v)", so you can refer to -the widget as 'o' and the user_data as 'v'. Fluid will check for +the widget as 'o' and the user_data as 'v'. FLUID will check for matching parenthesis, braces, and quotes, but does not do much other error checking. Be careful here, as it may be hard to figure out what widget is producing an error in the compiler. <p>If the callback is blank then no callback is set. -</ul><h4>user_data</h4><ul> +<H3>user_data</H3> <p>This is a value for the user_data() of the widget. If blank the default value of zero is used. This can be any piece of C code that can be put "(void*)(<here>)". -</ul><h4>User data type</h4><ul> +<H3>User data type</H3> The "void*" in the callback function prototypes is replaced with this. You may want to use "long" for old XForms code. Be warned that @@ -709,7 +687,7 @@ anything other than "void*" is not guaranteed to work by the C++ spec! However on most architectures other pointer types are ok, and long is usually ok. -</ul><h4>When</h4><ul> +<H3>When</H3> When to do the callback. Can be "never", "changed", "release". The value of "enter key" is only useful for text input fields. The "no @@ -720,8 +698,6 @@ if the data is not changed. are not in the menu. You should use the extra code fields to put these values in. -</ul> - <a name=windows> <h2>Selecting & Moving Widgets</h2> @@ -754,7 +730,7 @@ hierarchy. Hit the right arrow enough and you will select every widget in the window. Up/down widgets move to the previous/next widgets that overlap horizontally. If the navigation does not seem to work you probably need to "Sort" the widgets. This is important if -you have input fields, as fltk uses the same rules when using arrow keys +you have input fields, as FLTK uses the same rules when using arrow keys to move between input fields. <p>To "open" a widget, double click it. To open several widgets @@ -764,7 +740,7 @@ select them and then type F1 or pick "Edit/Open" off the pop-up menu. the selection, so you can see the widget borders. <p>You can resize the window by using the window manager border -controls. Fltk will attempt to round the window size to the nearest +controls. FLTK will attempt to round the window size to the nearest multiple of the grid size and makes it big enough to contain all the widgets (it does this using illegal X methods, so it is possible it will barf with some window managers!). Notice that the actual window @@ -775,21 +751,19 @@ child widgets may be different. almost identical to the panel for any other Fl_Widget. There are three extra items: -</ul><h4>Border</h4><ul> +<H3>Border</H3> This button turns the window manager border on or off. On most window managers you will have to close the window and reopen it to see the effect. -</ul><h4>xclass</h4><ul> +<H3>xclass</H3> The string typed into here is passed to the X window manager as the class. This can change the icon or window decorations. On most (all?) window managers you will have to close the window and reopen it to see the effect. -</ul> - <a name=images> <h2>Image Labels</h2> @@ -799,8 +773,8 @@ already been chosen, you can change the image used by picking "Image..." again. The name of the image will appear in the "label" field, but you can't edit it. -<p>The <i>contents</i> of the image file are written to the .C file, -so if you wish to distribute the C code, you only need to copy the .C +<p>The <i>contents</i> of the image file are written to the .cxx file, +so if you wish to distribute the C code, you only need to copy the .cxx file, not the images. If many widgets share the same image then only one copy is written. @@ -810,9 +784,9 @@ to the location the .fl file is (not necessarily the current directory). I recommend you either put the images in the same directory as the .fl file, or use absolute path names. -</ul><h4>Notes for all image types</h4><ul> +<H3>Notes for all image types</H3> -<p>Fluid runs using the default visual of your X server. This may be +<p>FLUID runs using the default visual of your X server. This may be 8 bits, which will give you dithered images. You may get better results in your actual program by adding the code "Fl::visual(FL_RGB)" to your code right before the first window is displayed. @@ -822,12 +796,12 @@ source X pixmap. Thus once you have put an image on a widget, it is nearly free to put the same image on many other widgets. <p>If you are using a painting program to edit an image: the only way -to convince Fluid to read the image file again is to remove the image +to convince FLUID to read the image file again is to remove the image from all widgets that are using it (including ones in closed windows), -which will cause it to free it's internal copy, and then set the image -again. You may find it easier to exit Fluid and run it again. +which will cause it to free its internal copy, and then set the image +again. You may find it easier to exit FLUID and run it again. -<p>Don't rely on how fltk crops images that are outside the widget, as +<p>Don't rely on how FLTK crops images that are outside the widget, as this may change in future versions! The cropping of inside labels will probably be unchanged. @@ -838,57 +812,55 @@ and you want the image inside it, you must change the button's boxtype to FL_UP_FRAME (or another frame), otherwise when it is pushed it will erase the image. -</ul><h4>XBM (X bitmap files)</h4><ul> +<H3>XBM (X bitmap files)</H3> -<p>Fluid will read X bitmap files. These files have C source code to +<p>FLUID will read X bitmap files. These files have C source code to define a bitmap. Sometimes they are stored with the ".h" or ".bm" extension rather than the standard ".xbm". -<p>Fluid will output code to construct an Fl_Bitmap widget and use it +<p>FLUID will output code to construct an Fl_Bitmap widget and use it to label the widget. The '1' bits in the bitmap are drawn using the -label color of the widget. You can change the color in Fluid. The +label color of the widget. You can change the color in FLUID. The '0' bits are transparent. <p>The program "bitmap" on the X distribution does an ok job of editing bitmaps. -</ul><h4>XPM (X pixmap files)</h4><ul> +<H3>XPM (X pixmap files)</H3> -<p>Fluid will read X pixmap files as used by the libxpm library. +<p>FLUID will read X pixmap files as used by the libxpm library. These files have C source code to define a pixmap. The filenames usually have a ".xpm" extension. -<p>Fluid will output code to construct an Fl_Pixmap widget and use it +<p>FLUID will output code to construct an Fl_Pixmap widget and use it to label the widget. The label color of the widget is ignored, even for 2-color images that could be a bitmap. <p>XPM files can mark a single color as being transparent. Currently -fltk and Fluid simulate this transparency rather badly. It will use the +FLTK and FLUID simulate this transparency rather badly. It will use the color() of the widget as the background, and all widgets using the same pixmap are assummed to have the same color. This may be fixed in the future or on non-X systems. <p>I have not found any good editors for small iconic pictures. For -pixmaps I have used <a -href=http://www.danbbs.dk/~torsten/xpaint/index.html>XPaint</a>. This +pixmaps I have used <a href=http://www.danbbs.dk/~torsten/xpaint/index.html>XPaint</a>. This (and most other) painting programs are designed for large full color images and are difficult to use to edit an image of small size and few colors. -</ul><h4>GIF files</h4><ul> +<H3>GIF files</H3> -<p>Fluid will also read GIF image files. These files are often used +<p>FLUID will also read GIF image files. These files are often used on html documents to make icons. This lets you use nice icons that you steal off the net in your user interface. -<p>Fluid converts these into <a href=xpm.html>(modified)</a> xpm -format and uses an Fl_Pixmap widget to label the widget. Transparency -is handled the same as for xpm files. Notice that the conversion -removes the compression, so the code may be much bigger than the .gif -file. Only the first image of an animated gif file is used. +<p>FLUID converts these into (modified) XPM format and uses an +Fl_Pixmap widget to label the widget. Transparency is handled the same +as for xpm files. Notice that the conversion removes the compression, +so the code may be much bigger than the .gif file. Only the first +image of an animated gif file is used. <p>Behavior and performance with large .gif files is not guaranteed! -</ul> - -<p><a href = index.html>(back to contents)</a> +</BODY> +</HTML> |