From 4faea14c5488d86a52213004f4b6cbc4885f4596 Mon Sep 17 00:00:00 2001 From: Albrecht Schlosser Date: Wed, 17 Sep 2008 10:29:00 +0000 Subject: doxygen: fixed typos and code examples (html quotes and \ escape sequences) in tutorials git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6278 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- documentation/drawing.dox | 2 +- documentation/editor.dox | 424 ++++++++++++++++++++++----------------------- documentation/examples.dox | 4 +- documentation/intro.dox | 108 ++++++------ 4 files changed, 269 insertions(+), 269 deletions(-) (limited to 'documentation') diff --git a/documentation/drawing.dox b/documentation/drawing.dox index 29694cc00..114f78d70 100644 --- a/documentation/drawing.dox +++ b/documentation/drawing.dox @@ -546,7 +546,7 @@ Fl_Align align, Fl_Image *img = 0, int draw_symbols = 1)

Fancy string drawing function which is used to draw all the labels. The string is formatted and aligned inside the passed -box. Handles '\t' and '\n', expands all other control +box. Handles '\\t' and '\\n', expands all other control characters to ^X, and aligns inside or against the edges of the box described by x, y, w and h. See Fl_Widget::align() diff --git a/documentation/editor.dox b/documentation/editor.dox index f6e37e759..760e2ab1f 100644 --- a/documentation/editor.dox +++ b/documentation/editor.dox @@ -30,7 +30,7 @@ lets define what we want our text editor to do: the design of our GUI. Obviously the first thing that we need is a window, which we'll place inside a class called EditorWindow: -

+\endcode

Variables

Our text editor will need some global variables to keep track of things: -

+\endcode

The textbuf variable is the text editor buffer for our window class described previously. We'll cover the other @@ -70,45 +70,45 @@ define each function the editor needs to perform. The Fl_Menu_Item structure is used to define the menus and items in a menubar:

- +\endcode

Once we have the menus defined we can create the Fl_Menu_Bar widget and assign the menus to it with:

- +m->copy(menuitems); +\endcode

We'll define the callback functions later. @@ -118,48 +118,48 @@ m->copy(menuitems); Fl_Text_Editor widget to edit the text: -

+\code +w->editor = new Fl_Text_Editor(0, 30, 640, 370); +w->editor->buffer(textbuf); +\endcode

So that we can keep track of changes to the file, we also want to add -a "modify" callback:

+a "modify" callback:

- +\code +textbuf->add_modify_callback(changed_cb, w); +textbuf->call_modify_callbacks(); +\endcode

Finally, we want to use a mono-spaced font like FL_COURIER: -

+\code +w->editor->textfont(FL_COURIER); +\endcode

The Replace Dialog

We can use the FLTK convenience functions for many of the editor's dialogs, however the replace dialog needs its own custom window. To keep things simple we will have a -"find" string, a "replace" string, and -"replace all", "replace next", and -"cancel" buttons. The strings are just -Fl_Input widgets, the "replace all" and -"cancel" buttons are Fl_Button widgets, and -the "replace next " button is a +"find" string, a "replace" string, and +"replace all", "replace next", and +"cancel" buttons. The strings are just +Fl_Input widgets, the "replace all" and +"cancel" buttons are Fl_Button widgets, and +the "replace next " button is a Fl_Return_Button widget:

\image html editor-replace.gif "Figure 4-1: The search and replace dialog" - +\code +Fl_Window *replace_dlg = new Fl_Window(300, 105, "Replace"); +Fl_Input *replace_find = new Fl_Input(70, 10, 200, 25, "Find:"); +Fl_Input *replace_with = new Fl_Input(70, 40, 200, 25, "Replace:"); +Fl_Button *replace_all = new Fl_Button(10, 70, 90, 25, "Replace All"); +Fl_Button *replace_next = new Fl_Button(105, 70, 120, 25, "Replace Next"); +Fl_Button *replace_cancel = new Fl_Button(230, 70, 60, 25, "Cancel"); +\endcode

Callbacks

@@ -171,14 +171,14 @@ need to define our callback functions.

This function will be called whenever the user changes any text in the editor widget: -

+\endcode

The set_title() function is one that we will write to set the changed status on the current file. We're doing it this way @@ -191,12 +191,12 @@ title bar. href="Fl_Text_Editor.html#Fl_Text_Editor.kf_copy">kf_copy() to copy the currently selected text to the clipboard:

- +\endcode

cut_cb()

@@ -204,12 +204,12 @@ void copy_cb(Fl_Widget*, void* v) { href="Fl_Text_Editor.html#Fl_Text_Editor.kf_cut">kf_cut() to cut the currently selected text to the clipboard:

- +\endcode

delete_cb()

@@ -217,11 +217,11 @@ void cut_cb(Fl_Widget*, void* v) { href="Fl_Text_Buffer.html#Fl_Text_Buffer.remove_selection">remove_selection() to delete the currently selected text to the clipboard:

- +\endcode

find_cb()

@@ -230,18 +230,18 @@ href="functions.html#fl_input2">fl_input() convenience function and then calls the find2_cb() function to find the string: - +\endcode

find2_cb()

@@ -249,26 +249,26 @@ void find_cb(Fl_Widget* w, void* v) { string. If the search string is blank then we want to pop up the search dialog: - +\endcode

If the search string cannot be found we use the fl_alert() @@ -279,17 +279,17 @@ convenience function to display a message to that effect. filename. It also calls the check_save() function to give the user the opportunity to save the current file first as needed: -

+\endcode

open_cb()

@@ -298,14 +298,14 @@ the specified file into the input widget and current filename. It also calls the check_save() function to give the user the opportunity to save the current file first as needed: - +\endcode

We call the load_file() function to actually load the file. @@ -315,12 +315,12 @@ void open_cb(Fl_Widget*, void*) { href="Fl_Text_Editor.html#Fl_Text_Editor.kf_paste">kf_paste() to paste the clipboard at the current position:

- +\endcode

quit_cb()

@@ -328,123 +328,123 @@ void paste_cb(Fl_Widget*, void* v) { modified, and if so give the user a chance to save it. It then exits from the program: - +\endcode

replace_cb()

The replace callback just shows the replace dialog: -

+\endcode

replace2_cb()

-

This callback will replace the next occurence of the replacement +

This callback will replace the next occurrence of the replacement string. If nothing has been entered for the replacement string, then the replace dialog is displayed instead: -

+\endcode

replall_cb()

-

This callback will replace all occurences of the search +

This callback will replace all occurrences of the search string in the file: -

+\endcode

replcan_cb()

This callback just hides the replace dialog: -

+\endcode

save_cb()

This callback saves the current file. If the current filename is -blank it calls the "save as" callback: +blank it calls the "save as" callback: -

+\endcode

The save_file() function saves the current file to the specified filename. @@ -462,14 +462,14 @@ specified filename.

This callback asks the user for a filename and saves the current file: -

+\endcode

The save_file() function saves the current file to the specified filename. @@ -484,13 +484,13 @@ functions to make it all work:

This function checks to see if the current file needs to be saved. If so, it asks the user if they want to save it: -

+\endcode

load_file()

This function loads the specified file into the textbuf class: -

+\endcode

When loading the file we use the loadfile() -method to "replace" the text in the buffer, or the insertfile() method to insert text in the buffer from the named file. @@ -534,22 +534,22 @@ method to insert text in the buffer from the named file.

This function saves the current buffer to the specified file: -

+\endcode

set_title()

This function checks the changed variable and updates the window label accordingly: -

+\endcode

The main() Function

@@ -576,19 +576,19 @@ The main() function creates a new text buffer, creates a new view (window) for the text, shows the window, loads the file on the command-line (if any), and then enters the FLTK event loop: - +\endcode

Compiling the Editor

@@ -596,15 +596,15 @@ int main(int argc, char **argv) { workspace include the necessary rules to build the editor. You can also compile it using a standard compiler with: - +\endcode

or by using the fltk-config script with: -

+\endcode

As noted in Chapter 1, you may need to include compiler and linker options to tell them where to find the FLTK @@ -636,16 +636,16 @@ size of the text that is drawn.

Styles are defined using the Fl_Text_Display::Style_Table_Entry structure -defined in <FL/Fl_Text_Display.H>: +defined in : -

+\endcode

The color member sets the color for the text, the font member sets the FLTK font index to use, @@ -655,7 +655,7 @@ text. The attr member is currently not used.

For our text editor we'll define 7 styles for plain code, comments, keywords, and preprocessor directives: -

+\endcode

You'll notice that the comments show a letter next to each style - each style in the style buffer is referenced using a @@ -674,27 +674,27 @@ character starting with the letter 'A'.

You call the highlight_data() method to associate the style data and buffer with the text editor widget: -

+\endcode

Finally, you need to add a callback to the main text buffer so that changes to the text buffer are mirrored in the style buffer: -

+\code +textbuf->add_modify_callback(style_update, w->editor); +\endcode

The style_update() function, like the change_cb() function described earlier, is called whenever text is added or removed from the text buffer. It mirrors the changes in the style buffer and then updates the style data as necessary: -

+\endcode

The style_parse() function scans a copy of the text in the buffer and generates the necessary style characters for display. It assumes that parsing begins at the start of a line: -

+\endcode */ diff --git a/documentation/examples.dox b/documentation/examples.dox index 837c6f3b2..3674fe56e 100644 --- a/documentation/examples.dox +++ b/documentation/examples.dox @@ -295,8 +295,8 @@ the window. The ESC key will not work.

label

Every FLTK widget can have a label attached to it. The label demo shows alignment, clipping and wrapping of text labels. Labels -can contain symbols at the start and end of the text, like @FLTK -or @circle uh-huh @square. +can contain symbols at the start and end of the text, like \@FLTK +or \@circle uh-huh \@square.

line_style

Advanced line drawing can be tested with line_style. diff --git a/documentation/intro.dox b/documentation/intro.dox index cdfb9b9f3..fcd561198 100644 --- a/documentation/intro.dox +++ b/documentation/intro.dox @@ -2,8 +2,8 @@ \page intro 1 - Introduction to FLTK -

The Fast Light Tool Kit ("FLTK", pronounced -"fulltick") is a cross-platform C++ GUI toolkit for +

The Fast Light Tool Kit ("FLTK", pronounced +"fulltick") is a cross-platform C++ GUI toolkit for UNIX®/Linux® (X11), Microsoft® Windows®, and MacOS® X. FLTK provides modern GUI functionality without the bloat and supports 3D graphics via OpenGL® and its built-in @@ -25,7 +25,7 @@ tried to push their own baroque toolkit instead.

Many of the ideas in FLTK were developed on a NeXT (but not using NextStep) in 1987 in a C toolkit Bill called -"views". Here he came up with passing events downward +"views". Here he came up with passing events downward in the tree and having the handle routine return a value indicating whether it used the event, and the table-driven menus. In general he was trying to prove that complex UI ideas could be @@ -35,19 +35,19 @@ or support by the system.

After going to film school for a few years, Bill worked at Sun Microsystems on the (doomed) NeWS project. Here he found an even better and cleaner windowing system, and he reimplemented -"views" atop that. NeWS did have an unnecessarily +"views" atop that. NeWS did have an unnecessarily complex method of delivering events which hurt it. But the designers did admit that perhaps the user could write just as good of a button as they could, and officially exposed the lower level interface.

With the death of NeWS Bill realized that he would have to -live with X. The biggest problem with X is the "window -manager", which means that the toolkit can no longer +live with X. The biggest problem with X is the "window +manager", which means that the toolkit can no longer control the window borders or drag the window around.

At Digital Domain Bill discovered another toolkit, -"Forms". Forms was similar to his work, but provided +"Forms". Forms was similar to his work, but provided many more widgets, since it was used in many real applications, rather then as theoretical work. He decided to use Forms, except he integrated his table-driven menus into it. Several very large @@ -91,8 +91,8 @@ is now included with several Linux distributions.

  • sizeof(Fl_Widget) == 64 to 92.
    • -
  • The "core" (the "hello" program - compiled & linked with a static FLTK library using +
  • The "core" (the "hello" program + compiled & linked with a static FLTK library using gcc on a 486 and then stripped) is 114K.
  • The FLUID program (which includes every widget) is @@ -112,7 +112,7 @@ is now included with several Linux distributions.

  • Support for overlay hardware, with emulation if none is available.
    • -
  • Very small & fast portable 2-D drawing library +
  • Very small & fast portable 2-D drawing library to hide Xlib, WIN32, or QuickDraw.
  • OpenGL/Mesa drawing area widget.
    • @@ -120,7 +120,7 @@ is now included with several Linux distributions.

  • Support for OpenGL overlay hardware on both X11 and WIN32, with emulation if none is available.
    • -
  • Text widgets with Emacs key bindings, X cut & +
  • Text widgets with Emacs key bindings, X cut & paste, and foreign letter compose!
  • Compatibility header file for the GLUT library.
    • @@ -137,23 +137,23 @@ General Public License     with exceptions that allow for static linking. Contrary to popular belief, it can be used in commercial software - even Bill Gates could use it!

    -

    What Does "FLTK" Mean?

    +

    What Does "FLTK" Mean?

    FLTK was originally designed to be compatible with the Forms Library written for SGI machines. In that library all the -functions and structures started with "fl_". This +functions and structures started with "fl_". This naming was extended to all new methods and widgets in the C++ library, and this prefix was taken as the name of the library. -It is almost impossible to search for "FL" on the +It is almost impossible to search for "FL" on the Internet, due to the fact that it is also the abbreviation for Florida. After much debating and searching for a new name for the toolkit, which was already in use by several people, Bill -came up with "FLTK", including a bogus excuse that it -stands for "The Fast Light Toolkit".

    +came up with "FLTK", including a bogus excuse that it +stands for "The Fast Light Toolkit".

    Building and Installing FLTK Under UNIX and MacOS X

    -

    In most cases you can just type "make". This will +

    In most cases you can just type "make". This will run configure with the default of no options and then compile everything.

    @@ -165,36 +165,36 @@ locations you'll need to define the CFLAGS, CXXFLAGS, and LDFLAGS environment variables. For the Bourne and Korn shells you'd use:

    - +\code +CFLAGS=-Iincludedir; export CFLAGS +CXXFLAGS=-Iincludedir; export CXXFLAGS +LDFLAGS=-Llibdir; export LDFLAGS +\endcode

    For C shell and tcsh, use:

    - +\code +setenv CFLAGS "-Iincludedir" +setenv CXXFLAGS "-Iincludedir" +setenv LDFLAGS "-Llibdir" +\endcode

    By default configure will look for a C++ compiler named CC, c++, g++, or gcc in that order. To use another compiler you need to set the CXX environment variable:

    - +\endcode

    The CC environment variable can also be used to override the default C compiler (cc or gcc), which is used for a few FLTK source files.

    You can run configure yourself to get the exact setup you -need. Type "./configure <options>", where +need. Type "./configure <options>", where options are:

    @@ -203,7 +203,7 @@ options are:

    Enable the Cygwin libraries under WIN32
    --enable-debug
    -
    Enable debugging code & symbols
    +
    Enable debugging code & symbols
    --disable-gl
    Disable OpenGL support
    @@ -241,45 +241,45 @@ options are:

    When the configure script is done you can just run the -"make" command. This will build the library, FLUID +"make" command. This will build the library, FLUID tool, and all of the test programs.

    -

    To install the library, become root and type "make -install". This will copy the "fluid" executable -to "bindir", the header files to -"includedir", and the library files to -"libdir".

    +

    To install the library, become root and type "make +install". This will copy the "fluid" executable +to "bindir", the header files to +"includedir", and the library files to +"libdir".

    Building FLTK Under Microsoft Windows

    There are three ways to build FLTK under Microsoft Windows. The first is to use the Visual C++ 5.0 project files under the -"visualc" directory. Just open (or double-click on) -the "fltk.dsw" file to get the whole shebang.

    +"visualc" directory. Just open (or double-click on) +the "fltk.dsw" file to get the whole shebang.

    The second method is to use the configure script included with the FLTK software; this has only been tested with the CygWin tools:

    - +\endcode

    The final method is to use a GNU-based development tool with -the files in the "makefiles" directory. To build +the files in the "makefiles" directory. To build using one of these tools simply copy the appropriate makeinclude and config files to the main directory and do a make:

    - +\endcode

    Using the Visual C++ DLL Library

    -

    The "fltkdll.dsp" project file builds a DLL-version +

    The "fltkdll.dsp" project file builds a DLL-version of the FLTK library. Because of name mangling differences between PC compilers (even between different versions of Visual C++!) you can only use the DLL that is generated with the same @@ -304,10 +304,10 @@ is installed.

    To build the XFree86 version of FLTK for OS/2, copy the appropriate makeinclude and config files to the main directory and do a make:

    - +\endcode

    Internet Resources

    @@ -341,20 +341,20 @@ make

    To send a message to the FLTK mailing list -("fltk@fltk.org") you must first join the list. +("fltk@fltk.org") you must first join the list. Non-member submissions are blocked to avoid problems with unsolicited email.

    To join the FLTK mailing list, send a message to -"majordomo@fltk.org" with "subscribe fltk" +"majordomo@fltk.org" with "subscribe fltk" in the message body. A digest of this list is available by -subscribing to the "fltk-digest" mailing list.

    +subscribing to the "fltk-digest" mailing list.

    Reporting Bugs

    To report a bug in FLTK, send an email to -"fltk-bugs@fltk.org". Please include the FLTK version, -operating system & version, and compiler that you are using +"fltk-bugs@fltk.org". Please include the FLTK version, +operating system & version, and compiler that you are using when describing the bug or problem. We will be unable to provide any kind of help without that basic information.

    @@ -362,6 +362,6 @@ any kind of help without that basic information.

    SourceForge bug tracker pages.

    For general support and questions, please use the FLTK mailing list -at "fltk@fltk.org" or one of the newsgroups.

    +at "fltk@fltk.org" or one of the newsgroups.

    */ -- cgit v1.2.3