From d7b88a3bcc7e76f38ee5799be7722fd5a10781ef Mon Sep 17 00:00:00 2001 From: Michael R Sweet Date: Wed, 13 Jan 1999 19:28:54 +0000 Subject: Updated all links so they work between files. Revision 1. git-svn-id: file:///fltk/svn/fltk/trunk@219 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- documentation/basics.html | 334 ++++++++++++++++++++-------------------------- 1 file changed, 147 insertions(+), 187 deletions(-) (limited to 'documentation/basics.html') diff --git a/documentation/basics.html b/documentation/basics.html index 57bec8472..563179b59 100644 --- a/documentation/basics.html +++ b/documentation/basics.html @@ -1,210 +1,170 @@ - - - +

2 - FLTK Basics

- -This chapter will teach you the basics of compiling programs that use -FLTK. - + This chapter will teach you the basics of compiling programs that use +FLTK.

Naming

- -All public symbols in FLTK start with the characters 'F' and 'L': - -

Functions are either Fl::foo() or fl_foo(). - -
Class and type names are capitalized: Fl_Foo. - -
Constants and enumerations are - uppercase: FL_FOO. - -
All header files start with <FL/...>. - -

- + All public symbols in FLTK start with the characters 'F' and 'L': +

Functions are either Fl::foo() or fl_foo().
Class and type names are capitalized: Fl_Foo.
Constants and enumerations + are uppercase: FL_FOO.
All header files start with <FL/...>.

Header Files

- -The proper way to include FLTK header files is: - -

-#include <FL/Fl_xyz.H>
-

- -Microsoft Windows developers please note: case *is* significant -under other operating systems, and the C standard uses the forward -slash (/) to separate directories. The following #include -directives are *not* recommended for portability reasons: - -

-#include <fl\fl_xyz.h>
-#include <fl/fl_xyz.h>
-#include <FL\Fl_xyz.H>
-

- + The proper way to include FLTK header files is: +

+#include <FL/Fl_xyz.H>
+

+Microsoft Windows developers please note: case *is* significant +under other operating systems, and the C standard uses the forward +slash (/) to separate directories. The following #include + directives are *not* recommended for portability reasons: +

+#include <fl\fl_xyz.h>
+#include <fl/fl_xyz.h>
+#include <FL\Fl_xyz.H>
+

Compiling Programs with Standard Compilers

- -Under UNIX (and under Microsoft Windows when using the GNU development tools) -you will probably need to tell the compiler where to find the header files. -This is usually done using the -I option: - -

+ Under UNIX (and under Microsoft Windows when using the GNU development 
+tools) you will probably need to tell the compiler where to find the 
+header files. This is usually done using the -I option: 
+
+ CC -I/usr/local/include ...
 gcc -I/usr/local/include ...
-
-
-Similarly, when linking your application you will need to tell the compiler
-to use the FLTK library:
-
-+
+
+ Similarly, when linking your application you will need to tell the 
+compiler to use the FLTK library: 
+
+ CC ... -L/usr/local/lib -lfltk -lXext -lX11 -lm
 gcc ... -L/usr/local/lib -lfltk -lXext -lX11 -lm
-
-
+

Compiling Programs with Microsoft Visual C++

- -In Visual C++ you will need to tell the compiler where to find the FLTK -header files. This can be done by selecting "Settings" from the -"Project" menu and then changing the "Preprocessor" settings under the -"C/C++" tab. Similarly, you will need to add the FLTK library to the -"Link" settings. - -

You can build your Microsoft Windows applications as Console or -WIN32 applications. If you want to use the standard C main() -function as the entry point, FLTK includes a WinMain() function -that will call your main() function for you. - -

Note: The Visual C++ optimizer is known to cause problems with -many programs. We only recommend using the "Favor Small Code" -optimization setting. - + In Visual C++ you will need to tell the compiler where to find the +FLTK header files. This can be done by selecting "Settings" from the +"Project" menu and then changing the "Preprocessor" settings under the +"C/C++" tab. Similarly, you will need to add the FLTK library to the +"Link" settings. +

You can build your Microsoft Windows applications as Console or +WIN32 applications. If you want to use the standard C main() + function as the entry point, FLTK includes a WinMain() + function that will call your main() function for you.

Note: The Visual C++ optimizer is known to cause problems with +many programs. We only recommend using the "Favor Small Code" +optimization setting.

Writing Your First FLTK Program

- -All programs must include the file <FL/Fl.H>. In -addition the program must include a header file for each FLTK class it -uses. Listing 1 shows a simple "Hello, World!" program that uses -FLTK to display the window. - -

Listing 1 - "hello.cxx"

-#include <FL/Fl.H>
-#include <FL/Fl_Window.H>
-#include <FL/Fl_Box.H>
+ All programs must include the file <FL/Fl.H In addition the 
+program must include a header file for each FLTK class it uses. 
+ Listing 1 shows a simple "Hello, World!" program that uses FLTK to 
+display the window. 
+Listing 1 - "hello.cxx"
+
  
++#include <FL/Fl.H>
+#include <FL/Fl_Window.H>
+#include <FL/Fl_Box.H>
 
 int main(int argc, char **argv) {
   Fl_Window *window = new Fl_Window(300,180);
-  Fl_Box *box = new Fl_Box(FL_UP_BOX,20,40,260,100,"Hello, World!");
-  box->labelsize(36);
-  box->labelfont(FL_BOLD+FL_ITALIC);
-  box->labeltype(FL_SHADOW_LABEL);
-  window->end();
-  window->show(argc, argv);
+  Fl_Box *box = new Fl_Box(FL_UP_BOX,20,40,260,100,"Hello, World!");
+  box->labelsize(36);
+  box->labelfont(FL_BOLD+FL_ITALIC);
+  box->labeltype(FL_SHADOW_LABEL);
+  window->end();
+  window->show(argc, argv);
   return Fl::run();
 }
-
-
-After including the required header files, the program then creates a
-window:
-
--Fl_Window *window = new Fl_Window(300,180);
-
-
-and a box with the "Hello, World!" string in it:
-
--Fl_Box *box = new Fl_Box(FL_UP_BOX,20,40,260,100,"Hello, World!");
-
-
-Next, we set the size, font, and style of the label:
-
--box->labelsize(36);
-box->labelfont(FL_BOLD+FL_ITALIC);
-box->labeltype(FL_SHADOW_LABEL);
-
-
-Finally, we show the window and enter the FLTK event loop:
-
--window->end();
-window->show(argc, argv);
-return Fl::run();
-
-
-The resulting program will display the window below. You can quit
-the program by closing the window or pressing the ESCape key.
-
-
-
+

+

+ After including the required header files, the program then creates a +window: + ++Fl_Window *window = new Fl_Window(300,180); + + + and a box with the "Hello, World!" string in it: + ++Fl_Box *box = new Fl_Box(FL_UP_BOX,20,40,260,100,"Hello, World!"); + + + Next, we set the size, font, and style of the label: + ++box->labelsize(36); +box->labelfont(FL_BOLD+FL_ITALIC); +box->labeltype(FL_SHADOW_LABEL); + + + Finally, we show the window and enter the FLTK event loop: + ++window->end(); +window->show(argc, argv); +return Fl::run(); + + + The resulting program will display the window below. You can quit the +program by closing the window or pressing the ESCape key. + Creating the Widgets - -The widgets are created using the C++ new operator; the arguments -to the constructors are usually one of the following: - -+ The widgets are created using the C++ new operator; the +arguments to the constructors are usually one of the following: + + Fl_Widget(boxtype, x, y, width, height) Fl_Widget(x, y, width, height) Fl_Widget(width, height) - - -The boxtype value is the style of the box that is drawn around -the widget. Usually this is FL_NO_BOX, which means that no -box is drawn. In our "Hello, World!" example we use FL_UP_BOX, -which means that a raised button border will be drawn around the -widget. You can learn more about boxtypes in Chapter -3. - -The x and y parameters determine where the widget -or window is placed on the screen. In FLTK the top left corner of the -window or screen is the origin (i.e. x = 0, y = 0) and the units are in -pixels. - - The width and height parameters determine the size -of the widget or window in pixels. The maximum widget size is typically -governed by the underlying window system or hardware. - + + + The boxtype value is the style of the box that is drawn +around the widget. Usually this is FL_NO_BOX, which means +that no box is drawn. In our "Hello, World!" example we use +FL_UP_BOX, which means that a raised button border will be drawn +around the widget. You can learn more about boxtypes in +Chapter 3. +The x and y parameters determine where the widget +or window is placed on the screen. In FLTK the top left corner of the +window or screen is the origin (i.e. x = 0, y = 0) and the units are in +pixels. +The width and height parameters determine the size +of the widget or window in pixels. The maximum widget size is +typically governed by the underlying window system or hardware. Labels - -All widgets support labels. In the case of window widgets, the label -is used for the label in the title bar. Our example program calls the -labelfont, -labelsize, and -labeltype methods. - -The labelfont method sets the typeface and style that is -used for the label, which for this example we are using -FL_BOLD and FL_ITALIC. You can also specify typefaces -directly. - - The labelsize method sets the height of the font in pixels. - - The labeltype method sets the type of label. FLTK supports -normal, embossed, shadowed, symbol, and image labels. - - A complete list of all label options can be found in -Chapter 3. - + All widgets support labels. In the case of window widgets, the label +is used for the label in the title bar. Our example program calls the +labelfont, +labelsize, and +labeltype methods. + The labelfont method sets the typeface and style that is +used for the label, which for this example we are using FL_BOLD + and FL_ITALIC. You can also specify typefaces directly. +The labelsize method sets the height of the font in pixels. +The labeltype method sets the type of label. FLTK supports +normal, embossed, shadowed, symbol, and image labels. +A complete list of all label options can be found in +Chapter 3. Showing the Window - -The show() method shows the widget or window. For windows you can -also provide the command-line arguments to allow users to customize the -appearance, size, and position of your windows. - + The show() method shows the widget or window. For windows +you can also provide the command-line arguments to allow users to +customize the appearance, size, and position of your windows. The Main Event Loop - -FLTK provides the Fl:run() method to enter -a standard event processing loop. This is equivalent to the following -code: - -+ FLTK provides the Fl:run() + method to enter a standard event processing loop. This is equivalent +to the following code: + + while (Fl::wait()); - - -Fl::run() does not return until all of the windows under FLTK control -are closed (either by the user or your program). - - - + + +Fl::run() does not return until all of the windows under FLTK +control are closed (either by the user or your program). \ No newline at end of file -- cgit v1.2.3