From 74cbd55745e7c55a62be524279c707a572f6c688 Mon Sep 17 00:00:00 2001 From: Albrecht Schlosser Date: Wed, 17 Sep 2008 21:13:03 +0000 Subject: 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 --- documentation/forms.dox | 62 ++++++++++++++++++++++++------------------------- 1 file changed, 31 insertions(+), 31 deletions(-) (limited to 'documentation/forms.dox') diff --git a/documentation/forms.dox b/documentation/forms.dox index b2cb92ade..6db19983e 100644 --- a/documentation/forms.dox +++ b/documentation/forms.dox @@ -12,7 +12,7 @@ new name so you don't write over the old one.

You will need to edit your main code considerably to get it to link with the output from FLUID. If you are not interested in this you may have more immediate luck with the forms compatibility header, -<FL/forms.H>.

+.

Using the Compatibility Header File

You should be able to compile existing Forms or XForms source code by changing the include directory switch to your compiler so that the @@ -29,17 +29,17 @@ a goal of FLTK. Compatibility was limited to things that were free, or that would add code that would not be linked in if the feature is unused, or that was not X-specific.

To use any new features of FLTK, you should rewrite your code to not -use the inline functions and instead use "pure" FLTK. This will make +use the inline functions and instead use "pure" FLTK. This will make it a lot cleaner and make it easier to figure out how to call the FLTK functions. Unfortunately this conversion is harder than expected and even Digital Domain's inhouse code still uses forms.H a lot.

Problems You Will Encounter

Many parts of XForms use X-specific structures like XEvent in their interface. I did not emulate these! Unfortunately these -features (such as the "canvas" widget) are needed by most large +features (such as the "canvas" widget) are needed by most large programs. You will need to rewrite these to use FLTK subclasses.

Fl_Free widgets emulate -the old Forms "free" widget. It may be useful for porting +the old Forms "free" widget. It may be useful for porting programs that change the handle() function on widgets, but you will still need to rewrite things.

Fl_Timer widgets are @@ -49,8 +49,8 @@ inefficient and inaccurate compared to using

All instance variables are hidden. If you directly refer to the x, y, w, h, label, or other fields of your Forms widgets you will have to add empty parenthesis after each reference. The easiest way to -do this is to globally replace "->x" with "->x()", etc. Replace -"boxtype" with "box()".

+do this is to globally replace "->x" with "->x()", etc. Replace +"boxtype" with "box()".

const char * arguments to most FLTK methods are simply stored, while Forms would strdup() the passed string. This is most noticable with the label of widgets. Your program must always @@ -61,11 +61,11 @@ may want to try the Fl_Output

The default fonts and sizes are matched to the older GL version of Forms, so all labels will draw somewhat larger than an XForms program does.

-

fdesign outputs a setting of a "fdui" instance variable to the main +

fdesign outputs a setting of a "fdui" instance variable to the main window. I did not emulate this because I wanted all instance variables to be hidden. You can store the same information in the user_data() field of a window. To do this, search through the fdesign output for -all occurances of "->fdui" and edit to use "->user_data()" instead. +all occurances of "->fdui" and edit to use "->user_data()" instead. This will require casts and is not trivial.

The prototype for the functions passed to fl_add_timeout() and fl_set_idle_callback() callback are different.

@@ -123,9 +123,9 @@ IRISGL version of Forms. Most of these problems are the same ones encountered when going from old Forms to XForms:

Does Not Run In Background

The IRISGL library always forked when you created the first window, -unless "foreground()" was called. FLTK acts like "foreground()" is -called all the time. If you really want the fork behavior do "if -(fork()) exit(0)" right at the start of your program. +unless "foreground()" was called. FLTK acts like "foreground()" is +called all the time. If you really want the fork behavior do "if +(fork()) exit(0)" right at the start of your program.

You Cannot Use IRISGL Windows or fl_queue

If a Forms (not XForms) program if you wanted your own window for displaying things you would create a IRISGL window and draw in it, @@ -148,7 +148,7 @@ of your program, call Fl::wait() and then check these variables, acting on them as though they are events read from fl_queue.

You Must Use OpenGL to Draw Everything

-

The file <FL/gl.h> defines replacements for a lot of IRISGL +

The file defines replacements for a lot of IRISGL calls, translating them to OpenGL. There are much better translators available that you might want to investigate.

You Cannot Make Forms Subclasses

@@ -158,15 +158,15 @@ subclass of Fl_Widget. It is important to note that the handle() method is not exactly the same as the handle() function of Forms. Where a Forms handle() returned non-zero, your handle() must call do_callback(). And your -handle() must return non-zero if it "understood" the event. -

An attempt has been made to emulate the "free" widget. This appears +handle() must return non-zero if it "understood" the event. +

An attempt has been made to emulate the "free" widget. This appears to work quite well. It may be quicker to modify your subclass into a -"free" widget, since the "handle" functions match.

+"free" widget, since the "handle" functions match.

If your subclass draws into the overlay you are in trouble and will have to rewrite things a lot.

-

You Cannot Use <device.h>

- If you have written your own "free" widgets you will probably get a -lot of errors about "getvaluator". You should substitute: +

You Cannot Use

+ If you have written your own "free" widgets you will probably get a +lot of errors about "getvaluator". You should substitute:
@@ -181,21 +181,21 @@ lot of errors about "getvaluator". You should substitute:
FormsFLTK
MOUSE_XFl::event_x_root()
Anything else in getvaluator and you are on your own...

Font Numbers Are Different

- The "style" numbers have been changed because I wanted to insert + The "style" numbers have been changed because I wanted to insert bold-italic versions of the normal fonts. If you use Times, Courier, or Bookman to display any text you will get a different font out of FLTK. If you are really desperate to fix this use the following code: -