diff options
| author | Albrecht Schlosser <albrechts.fltk@online.de> | 2008-09-17 10:29:00 +0000 |
|---|---|---|
| committer | Albrecht Schlosser <albrechts.fltk@online.de> | 2008-09-17 10:29:00 +0000 |
| commit | 4faea14c5488d86a52213004f4b6cbc4885f4596 (patch) | |
| tree | 58b3b12bdba4acfd754c441756105edbd70ec866 | |
| parent | 82d47bd253cf56f34ab947e15de15b43120a10cb (diff) | |
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
| -rw-r--r-- | documentation/drawing.dox | 2 | ||||
| -rw-r--r-- | documentation/editor.dox | 424 | ||||
| -rw-r--r-- | documentation/examples.dox | 4 | ||||
| -rw-r--r-- | documentation/intro.dox | 108 |
4 files changed, 269 insertions, 269 deletions
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)</H4> <P>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 <i>x</i>, <i>y</i>, <i>w</i> and <i>h</i>. See <A href="Fl_Widget.html#Fl_Widget.align"><TT>Fl_Widget::align()</TT></A> 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 <TT>EditorWindow</TT>: -<UL><PRE> +\code class EditorWindow : public Fl_Double_Window { public: EditorWindow(int w, int h, const char* t); @@ -46,18 +46,18 @@ class EditorWindow : public Fl_Double_Window { Fl_Text_Editor *editor; char search[256]; }; -</PRE></UL> +\endcode <H2>Variables</H2> <P>Our text editor will need some global variables to keep track of things: -<UL><PRE> +\code int changed = 0; -char filename[256] = ""; +char filename[256] = ""; Fl_Text_Buffer *textbuf; -</PRE></UL> +\endcode <P>The <TT>textbuf</TT> 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 <A href="Fl_Menu_Item.html"><TT>Fl_Menu_Item</TT></A> structure is used to define the menus and items in a menubar:</P> -<UL><PRE> +\code Fl_Menu_Item menuitems[] = { - { "&File", 0, 0, 0, FL_SUBMENU }, - { "&New File", 0, (Fl_Callback *)new_cb }, - { "&Open File...", FL_CTRL + 'o', (Fl_Callback *)open_cb }, - { "&Insert File...", FL_CTRL + 'i', (Fl_Callback *)insert_cb, 0, FL_MENU_DIVIDER }, - { "&Save File", FL_CTRL + 's', (Fl_Callback *)save_cb }, - { "Save File &As...", FL_CTRL + FL_SHIFT + 's', (Fl_Callback *)saveas_cb, 0, FL_MENU_DIVIDER }, - { "New &View", FL_ALT + 'v', (Fl_Callback *)view_cb, 0 }, - { "&Close View", FL_CTRL + 'w', (Fl_Callback *)close_cb, 0, FL_MENU_DIVIDER }, - { "E&xit", FL_CTRL + 'q', (Fl_Callback *)quit_cb, 0 }, + { "&File", 0, 0, 0, FL_SUBMENU }, + { "&New File", 0, (Fl_Callback *)new_cb }, + { "&Open File...", FL_CTRL + 'o', (Fl_Callback *)open_cb }, + { "&Insert File...", FL_CTRL + 'i', (Fl_Callback *)insert_cb, 0, FL_MENU_DIVIDER }, + { "&Save File", FL_CTRL + 's', (Fl_Callback *)save_cb }, + { "Save File &As...", FL_CTRL + FL_SHIFT + 's', (Fl_Callback *)saveas_cb, 0, FL_MENU_DIVIDER }, + { "New &View", FL_ALT + 'v', (Fl_Callback *)view_cb, 0 }, + { "&Close View", FL_CTRL + 'w', (Fl_Callback *)close_cb, 0, FL_MENU_DIVIDER }, + { "E&xit", FL_CTRL + 'q', (Fl_Callback *)quit_cb, 0 }, { 0 }, - { "&Edit", 0, 0, 0, FL_SUBMENU }, - { "&Undo", FL_CTRL + 'z', (Fl_Callback *)undo_cb, 0, FL_MENU_DIVIDER }, - { "Cu&t", FL_CTRL + 'x', (Fl_Callback *)cut_cb }, - { "&Copy", FL_CTRL + 'c', (Fl_Callback *)copy_cb }, - { "&Paste", FL_CTRL + 'v', (Fl_Callback *)paste_cb }, - { "&Delete", 0, (Fl_Callback *)delete_cb }, + { "&Edit", 0, 0, 0, FL_SUBMENU }, + { "&Undo", FL_CTRL + 'z', (Fl_Callback *)undo_cb, 0, FL_MENU_DIVIDER }, + { "Cu&t", FL_CTRL + 'x', (Fl_Callback *)cut_cb }, + { "&Copy", FL_CTRL + 'c', (Fl_Callback *)copy_cb }, + { "&Paste", FL_CTRL + 'v', (Fl_Callback *)paste_cb }, + { "&Delete", 0, (Fl_Callback *)delete_cb }, { 0 }, - { "&Search", 0, 0, 0, FL_SUBMENU }, - { "&Find...", FL_CTRL + 'f', (Fl_Callback *)find_cb }, - { "F&ind Again", FL_CTRL + 'g', find2_cb }, - { "&Replace...", FL_CTRL + 'r', replace_cb }, - { "Re&place Again", FL_CTRL + 't', replace2_cb }, + { "&Search", 0, 0, 0, FL_SUBMENU }, + { "&Find...", FL_CTRL + 'f', (Fl_Callback *)find_cb }, + { "F&ind Again", FL_CTRL + 'g', find2_cb }, + { "&Replace...", FL_CTRL + 'r', replace_cb }, + { "Re&place Again", FL_CTRL + 't', replace2_cb }, { 0 }, { 0 } }; -</PRE></UL> +\endcode <P>Once we have the menus defined we can create the <TT>Fl_Menu_Bar</TT> widget and assign the menus to it with:</P> -<UL><PRE> +\code Fl_Menu_Bar *m = new Fl_Menu_Bar(0, 0, 640, 30); -m->copy(menuitems); -</PRE></UL> +m->copy(menuitems); +\endcode <P>We'll define the callback functions later. @@ -118,48 +118,48 @@ m->copy(menuitems); <A HREF="Fl_Text_Editor.html"><TT>Fl_Text_Editor</TT></A> widget to edit the text: -<UL><PRE> -w->editor = new Fl_Text_Editor(0, 30, 640, 370); -w->editor->buffer(textbuf); -</PRE></UL> +\code +w->editor = new Fl_Text_Editor(0, 30, 640, 370); +w->editor->buffer(textbuf); +\endcode <P>So that we can keep track of changes to the file, we also want to add -a "modify" callback:</P> +a "modify" callback:</P> -<UL><PRE> -textbuf->add_modify_callback(changed_cb, w); -textbuf->call_modify_callbacks(); -</PRE></UL> +\code +textbuf->add_modify_callback(changed_cb, w); +textbuf->call_modify_callbacks(); +\endcode <P>Finally, we want to use a mono-spaced font like <TT>FL_COURIER</TT>: -<UL><PRE> -w->editor->textfont(FL_COURIER); -</PRE></UL> +\code +w->editor->textfont(FL_COURIER); +\endcode <H2>The Replace Dialog</H2> <P>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 -<TT>Fl_Input</TT> widgets, the "replace all" and -"cancel" buttons are <TT>Fl_Button</TT> 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 +<TT>Fl_Input</TT> widgets, the "replace all" and +"cancel" buttons are <TT>Fl_Button</TT> widgets, and +the "replace next " button is a <TT>Fl_Return_Button</TT> widget:</P> \image html editor-replace.gif "Figure 4-1: The search and replace dialog" -<UL><PRE> -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"); -</PRE></UL> +\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 <H2>Callbacks</H2> @@ -171,14 +171,14 @@ need to define our callback functions.</P> <P>This function will be called whenever the user changes any text in the <TT>editor</TT> widget: -<UL><PRE> +\code void changed_cb(int, int nInserted, int nDeleted,int, const char*, void* v) { - if ((nInserted || nDeleted) && !loading) changed = 1; + if ((nInserted || nDeleted) && !loading) changed = 1; EditorWindow *w = (EditorWindow *)v; set_title(w); - if (loading) w->editor->show_insert_position(); + if (loading) w->editor->show_insert_position(); } -</PRE></UL> +\endcode <P>The <TT>set_title()</TT> 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"><TT>kf_copy()</TT></A> to copy the currently selected text to the clipboard:</P> -<UL><PRE> +\code void copy_cb(Fl_Widget*, void* v) { EditorWindow* e = (EditorWindow*)v; - Fl_Text_Editor::kf_copy(0, e->editor); + Fl_Text_Editor::kf_copy(0, e->editor); } -</PRE></UL> +\endcode <H3>cut_cb()</H3> @@ -204,12 +204,12 @@ void copy_cb(Fl_Widget*, void* v) { href="Fl_Text_Editor.html#Fl_Text_Editor.kf_cut"><TT>kf_cut()</TT></A> to cut the currently selected text to the clipboard:</P> -<UL><PRE> +\code void cut_cb(Fl_Widget*, void* v) { EditorWindow* e = (EditorWindow*)v; - Fl_Text_Editor::kf_cut(0, e->editor); + Fl_Text_Editor::kf_cut(0, e->editor); } -</PRE></UL> +\endcode <H3>delete_cb()</H3> @@ -217,11 +217,11 @@ void cut_cb(Fl_Widget*, void* v) { href="Fl_Text_Buffer.html#Fl_Text_Buffer.remove_selection"><TT>remove_selection()</TT></A> to delete the currently selected text to the clipboard:</P> -<UL><PRE> +\code void delete_cb(Fl_Widget*, void* v) { - textbuf->remove_selection(); + textbuf->remove_selection(); } -</PRE></UL> +\endcode <H3>find_cb()</H3> @@ -230,18 +230,18 @@ href="functions.html#fl_input2"><TT>fl_input()</TT></A> convenience function and then calls the <TT>find2_cb()</TT> function to find the string: -<UL><PRE> +\code void find_cb(Fl_Widget* w, void* v) { EditorWindow* e = (EditorWindow*)v; const char *val; - val = fl_input("Search String:", e->search); + val = fl_input("Search String:", e->search); if (val != NULL) { // User entered a string - go find it! - strcpy(e->search, val); + strcpy(e->search, val); find2_cb(w, v); } -</PRE></UL> +\endcode <H3>find2_cb()</H3> @@ -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: -<UL><PRE> +\code void find2_cb(Fl_Widget* w, void* v) { EditorWindow* e = (EditorWindow*)v; - if (e->search[0] == '\0') { + if (e->search[0] == '\0') { // Search string is blank; get a new one... find_cb(w, v); return; } - int pos = e->editor->insert_position(); - int found = textbuf->search_forward(pos, e->search, &pos); + int pos = e->editor->insert_position(); + int found = textbuf->search_forward(pos, e->search, &pos); if (found) { // Found a match; select and update the position... - textbuf->select(pos, pos+strlen(e->search)); - e->editor->insert_position(pos+strlen(e->search)); - e->editor->show_insert_position(); + textbuf->select(pos, pos+strlen(e->search)); + e->editor->insert_position(pos+strlen(e->search)); + e->editor->show_insert_position(); } - else fl_alert("No occurrences of \'%s\' found!", e->search); + else fl_alert("No occurrences of \'%s\' found!", e->search); } -</PRE></UL> +\endcode <P>If the search string cannot be found we use the <A href="functions.html#fl_alert"><TT>fl_alert()</TT></A> @@ -279,17 +279,17 @@ convenience function to display a message to that effect. filename. It also calls the <TT>check_save()</TT> function to give the user the opportunity to save the current file first as needed: -<UL><PRE> +\code void new_cb(Fl_Widget*, void*) { if (!check_save()) return; filename[0] = '\0'; - textbuf->select(0, textbuf->length()); - textbuf->remove_selection(); + textbuf->select(0, textbuf->length()); + textbuf->remove_selection(); changed = 0; - textbuf->call_modify_callbacks(); + textbuf->call_modify_callbacks(); } -</PRE></UL> +\endcode <H3>open_cb()</H3> @@ -298,14 +298,14 @@ the specified file into the input widget and current filename. It also calls the <TT>check_save()</TT> function to give the user the opportunity to save the current file first as needed: -<UL><PRE> +\code void open_cb(Fl_Widget*, void*) { if (!check_save()) return; char *newfile = fl_file_chooser("Open File?", "*", filename); if (newfile != NULL) load_file(newfile, -1); } -</PRE></UL> +\endcode <P>We call the <TT>load_file()</TT> 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"><TT>kf_paste()</TT></A> to paste the clipboard at the current position:</P> -<UL><PRE> +\code void paste_cb(Fl_Widget*, void* v) { EditorWindow* e = (EditorWindow*)v; - Fl_Text_Editor::kf_paste(0, e->editor); + Fl_Text_Editor::kf_paste(0, e->editor); } -</PRE></UL> +\endcode <H3>quit_cb()</H3> @@ -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: -<UL><PRE> +\code void quit_cb(Fl_Widget*, void*) { - if (changed && !check_save()) + if (changed && !check_save()) return; exit(0); } -</PRE></UL> +\endcode <H3>replace_cb()</H3> <P>The replace callback just shows the replace dialog: -<UL><PRE> +\code void replace_cb(Fl_Widget*, void* v) { EditorWindow* e = (EditorWindow*)v; - e->replace_dlg->show(); + e->replace_dlg->show(); } -</PRE></UL> +\endcode <H3>replace2_cb()</H3> -<P>This callback will replace the next occurence of the replacement +<P>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: -<UL><PRE> +\code void replace2_cb(Fl_Widget*, void* v) { EditorWindow* e = (EditorWindow*)v; - const char *find = e->replace_find->value(); - const char *replace = e->replace_with->value(); + const char *find = e->replace_find->value(); + const char *replace = e->replace_with->value(); if (find[0] == '\0') { // Search string is blank; get a new one... - e->replace_dlg->show(); + e->replace_dlg->show(); return; } - e->replace_dlg->hide(); + e->replace_dlg->hide(); - int pos = e->editor->insert_position(); - int found = textbuf->search_forward(pos, find, &pos); + int pos = e->editor->insert_position(); + int found = textbuf->search_forward(pos, find, &pos); if (found) { // Found a match; update the position and replace text... - textbuf->select(pos, pos+strlen(find)); - textbuf->remove_selection(); - textbuf->insert(pos, replace); - textbuf->select(pos, pos+strlen(replace)); - e->editor->insert_position(pos+strlen(replace)); - e->editor->show_insert_position(); + textbuf->select(pos, pos+strlen(find)); + textbuf->remove_selection(); + textbuf->insert(pos, replace); + textbuf->select(pos, pos+strlen(replace)); + e->editor->insert_position(pos+strlen(replace)); + e->editor->show_insert_position(); } - else fl_alert("No occurrences of \'%s\' found!", find); + else fl_alert("No occurrences of \'%s\' found!", find); } -</PRE></UL> +\endcode <H3>replall_cb()</H3> -<P>This callback will replace all occurences of the search +<P>This callback will replace all occurrences of the search string in the file: -<UL><PRE> +\code void replall_cb(Fl_Widget*, void* v) { EditorWindow* e = (EditorWindow*)v; - const char *find = e->replace_find->value(); - const char *replace = e->replace_with->value(); + const char *find = e->replace_find->value(); + const char *replace = e->replace_with->value(); - find = e->replace_find->value(); + find = e->replace_find->value(); if (find[0] == '\0') { // Search string is blank; get a new one... - e->replace_dlg->show(); + e->replace_dlg->show(); return; } - e->replace_dlg->hide(); + e->replace_dlg->hide(); - e->editor->insert_position(0); + e->editor->insert_position(0); int times = 0; // Loop through the whole string for (int found = 1; found;) { - int pos = e->editor->insert_position(); - found = textbuf->search_forward(pos, find, &pos); + int pos = e->editor->insert_position(); + found = textbuf->search_forward(pos, find, &pos); if (found) { // Found a match; update the position and replace text... - textbuf->select(pos, pos+strlen(find)); - textbuf->remove_selection(); - textbuf->insert(pos, replace); - e->editor->insert_position(pos+strlen(replace)); - e->editor->show_insert_position(); + textbuf->select(pos, pos+strlen(find)); + textbuf->remove_selection(); + textbuf->insert(pos, replace); + e->editor->insert_position(pos+strlen(replace)); + e->editor->show_insert_position(); times++; } } - if (times) fl_message("Replaced %d occurrences.", times); - else fl_alert("No occurrences of \'%s\' found!", find); + if (times) fl_message("Replaced %d occurrences.", times); + else fl_alert("No occurrences of \'%s\' found!", find); } -</PRE></UL> +\endcode <H3>replcan_cb()</H3> <P>This callback just hides the replace dialog: -<UL><PRE> +\code void replcan_cb(Fl_Widget*, void* v) { EditorWindow* e = (EditorWindow*)v; - e->replace_dlg->hide(); + e->replace_dlg->hide(); } -</PRE></UL> +\endcode <H3>save_cb()</H3> <P>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: -<UL><PRE> +\code void save_cb(void) { if (filename[0] == '\0') { // No filename - get one! @@ -453,7 +453,7 @@ void save_cb(void) { } else save_file(filename); } -</PRE></UL> +\endcode <P>The <TT>save_file()</TT> function saves the current file to the specified filename. @@ -462,14 +462,14 @@ specified filename. <P>This callback asks the user for a filename and saves the current file: -<UL><PRE> +\code void saveas_cb(void) { char *newfile; - newfile = fl_file_chooser("Save File As?", "*", filename); + newfile = fl_file_chooser("Save File As?", "*", filename); if (newfile != NULL) save_file(newfile); } -</PRE></UL> +\endcode <P>The <TT>save_file()</TT> function saves the current file to the specified filename. @@ -484,13 +484,13 @@ functions to make it all work: <P>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: -<UL><PRE> +\code int check_save(void) { if (!changed) return 1; - int r = fl_choice("The current file has not been saved.\n" - "Would you like to save it now?", - "Cancel", "Save", "Discard"); + int r = fl_choice("The current file has not been saved.\n" + "Would you like to save it now?", + "Cancel", "Save", "Discard"); if (r == 1) { save_cb(); // Save the file... @@ -499,34 +499,34 @@ int check_save(void) { return (r == 2) ? 1 : 0; } -</PRE></UL> +\endcode <H3>load_file()</H3> <P>This function loads the specified file into the <TT>textbuf</TT> class: -<UL><PRE> +\code int loading = 0; void load_file(char *newfile, int ipos) { loading = 1; int insert = (ipos != -1); changed = insert; - if (!insert) strcpy(filename, ""); + if (!insert) strcpy(filename, ""); int r; - if (!insert) r = textbuf->loadfile(newfile); - else r = textbuf->insertfile(newfile, ipos); + if (!insert) r = textbuf->loadfile(newfile); + else r = textbuf->insertfile(newfile, ipos); if (r) - fl_alert("Error reading from file \'%s\':\n%s.", newfile, strerror(errno)); + fl_alert("Error reading from file \'%s\':\n%s.", newfile, strerror(errno)); else if (!insert) strcpy(filename, newfile); loading = 0; - textbuf->call_modify_callbacks(); + textbuf->call_modify_callbacks(); } -</PRE></UL> +\endcode <P>When loading the file we use the <A href="Fl_Text_Buffer.html#Fl_Text_Buffer.loadfile"><TT>loadfile()</TT></A> -method to "replace" the text in the buffer, or the <A +method to "replace" the text in the buffer, or the <A href="Fl_Text_Buffer.html#Fl_Text_Buffer.insertfile"><TT>insertfile()</TT></A> 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. <P>This function saves the current buffer to the specified file: -<UL><PRE> +\code void save_file(char *newfile) { - if (textbuf->savefile(newfile)) - fl_alert("Error writing to file \'%s\':\n%s.", newfile, strerror(errno)); + if (textbuf->savefile(newfile)) + fl_alert("Error writing to file \'%s\':\n%s.", newfile, strerror(errno)); else strcpy(filename, newfile); changed = 0; - textbuf->call_modify_callbacks(); + textbuf->call_modify_callbacks(); } -</PRE></UL> +\endcode <H3>set_title()</H3> <P>This function checks the <TT>changed</TT> variable and updates the window label accordingly: -<UL><PRE> +\code void set_title(Fl_Window* w) { if (filename[0] == '\0') strcpy(title, "Untitled"); else { @@ -564,9 +564,9 @@ void set_title(Fl_Window* w) { if (changed) strcat(title, " (modified)"); - w->label(title); + w->label(title); } -</PRE></UL> +\endcode <H2>The main() Function</H2> @@ -576,19 +576,19 @@ The <TT>main()</TT> 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: -<UL><PRE> +\code int main(int argc, char **argv) { textbuf = new Fl_Text_Buffer; Fl_Window* window = new_view(); - window->show(1, argv); + window->show(1, argv); - if (argc > 1) load_file(argv[1], -1); + if (argc > 1) load_file(argv[1], -1); return Fl::run(); } -</PRE></UL> +\endcode <H2>Compiling the Editor</H2> @@ -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: -<UL><PRE> +\code CC -o editor editor.cxx -lfltk -lXext -lX11 -lm -</PRE></UL> +\endcode <P>or by using the <TT>fltk-config</TT> script with: -<UL><PRE> +\code fltk-config --compile editor.cxx -</PRE></UL> +\endcode <P>As noted in <A href="basics.html">Chapter 1</A>, 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. <P>Styles are defined using the <CODE>Fl_Text_Display::Style_Table_Entry</CODE> structure -defined in <CODE><FL/Fl_Text_Display.H></CODE>: +defined in <CODE><FL/Fl_Text_Display.H></CODE>: -<UL><PRE> +\code struct Style_Table_Entry { Fl_Color color; Fl_Font font; int size; unsigned attr; }; -</PRE></UL> +\endcode <P>The <CODE>color</CODE> member sets the color for the text, the <CODE>font</CODE> member sets the FLTK font index to use, @@ -655,7 +655,7 @@ text. The <CODE>attr</CODE> member is currently not used. <P>For our text editor we'll define 7 styles for plain code, comments, keywords, and preprocessor directives: -<UL><PRE> +\code Fl_Text_Display::Style_Table_Entry styletable[] = { // Style table { FL_BLACK, FL_COURIER, FL_NORMAL_SIZE }, // A - Plain { FL_DARK_GREEN, FL_COURIER_ITALIC, FL_NORMAL_SIZE }, // B - Line comments @@ -665,7 +665,7 @@ Fl_Text_Display::Style_Table_Entry styletable[] = { // Style table { FL_DARK_RED, FL_COURIER_BOLD, FL_NORMAL_SIZE }, // F - Types { FL_BLUE, FL_COURIER_BOLD, FL_NORMAL_SIZE } // G - Keywords }; -</PRE></UL> +\endcode <P>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'. <P>You call the <CODE>highlight_data()</CODE> method to associate the style data and buffer with the text editor widget: -<UL><PRE> +\code Fl_Text_Buffer *stylebuf; -w->editor->highlight_data(stylebuf, styletable, +w->editor->highlight_data(stylebuf, styletable, sizeof(styletable) / sizeof(styletable[0]), 'A', style_unfinished_cb, 0); -</PRE></UL> +\endcode <P>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: -<UL><PRE> -textbuf->add_modify_callback(style_update, w->editor); -</PRE></UL> +\code +textbuf->add_modify_callback(style_update, w->editor); +\endcode <P>The <CODE>style_update()</CODE> function, like the <CODE>change_cb()</CODE> 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: -<UL><PRE> +\code // // 'style_update()' - Update the style buffer... // @@ -714,44 +714,44 @@ style_update(int pos, // I - Position of update // If this is just a selection change, just unselect the style buffer... - if (nInserted == 0 && nDeleted == 0) { - stylebuf->unselect(); + if (nInserted == 0 && nDeleted == 0) { + stylebuf->unselect(); return; } // Track changes in the text buffer... - if (nInserted > 0) { + if (nInserted > 0) { // Insert characters into the style buffer... style = new char[nInserted + 1]; memset(style, 'A', nInserted); style[nInserted] = '\0'; - stylebuf->replace(pos, pos + nDeleted, style); + stylebuf->replace(pos, pos + nDeleted, style); delete[] style; } else { // Just delete characters in the style buffer... - stylebuf->remove(pos, pos + nDeleted); + stylebuf->remove(pos, pos + nDeleted); } // Select the area that was just updated to avoid unnecessary // callbacks... - stylebuf->select(pos, pos + nInserted - nDeleted); + stylebuf->select(pos, pos + nInserted - nDeleted); // Re-parse the changed region; we do this by parsing from the // beginning of the line of the changed region to the end of // the line of the changed region... Then we check the last // style character and keep updating if we have a multi-line // comment character... - start = textbuf->line_start(pos); - end = textbuf->line_end(pos + nInserted - nDeleted); - text = textbuf->text_range(start, end); - style = stylebuf->text_range(start, end); + start = textbuf->line_start(pos); + end = textbuf->line_end(pos + nInserted - nDeleted); + text = textbuf->text_range(start, end); + style = stylebuf->text_range(start, end); last = style[end - start - 1]; style_parse(text, style, end - start); - stylebuf->replace(start, end, style); - ((Fl_Text_Editor *)cbArg)->redisplay_range(start, end); + stylebuf->replace(start, end, style); + ((Fl_Text_Editor *)cbArg)->redisplay_range(start, end); if (last != style[end - start - 1]) { // The last character on the line changed styles, so reparse the @@ -759,26 +759,26 @@ style_update(int pos, // I - Position of update free(text); free(style); - end = textbuf->length(); - text = textbuf->text_range(start, end); - style = stylebuf->text_range(start, end); + end = textbuf->length(); + text = textbuf->text_range(start, end); + style = stylebuf->text_range(start, end); style_parse(text, style, end - start); - stylebuf->replace(start, end, style); - ((Fl_Text_Editor *)cbArg)->redisplay_range(start, end); + stylebuf->replace(start, end, style); + ((Fl_Text_Editor *)cbArg)->redisplay_range(start, end); } free(text); free(style); } -</PRE></UL> +\endcode <P>The <CODE>style_parse()</CODE> 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: -<UL><PRE> +\code // // 'style_parse()' - Parse text and produce style data. // @@ -794,10 +794,10 @@ style_parse(const char *text, *bufptr; const char *temp; - for (current = *style, col = 0, last = 0; length > 0; length --, text ++) { + for (current = *style, col = 0, last = 0; length > 0; length --, text ++) { if (current == 'A') { // Check for directives, comments, strings, and keywords... - if (col == 0 && *text == '#') { + if (col == 0 && *text == '#') { // Set style to directive current = 'E'; } else if (strncmp(text, "//", 2) == 0) { @@ -814,10 +814,10 @@ style_parse(const char *text, continue; } else if (*text == '\"') { current = 'D'; - } else if (!last && islower(*text)) { + } else if (!last && islower(*text)) { // Might be a keyword... for (temp = text, bufptr = buf; - islower(*temp) && bufptr < (buf + sizeof(buf) - 1); + islower(*temp) && bufptr < (buf + sizeof(buf) - 1); *bufptr++ = *temp++); if (!islower(*temp)) { @@ -825,10 +825,10 @@ style_parse(const char *text, bufptr = buf; - if (bsearch(&bufptr, code_types, + if (bsearch(&bufptr, code_types, sizeof(code_types) / sizeof(code_types[0]), sizeof(code_types[0]), compare_keywords)) { - while (text < temp) { + while (text < temp) { *style++ = 'F'; text ++; length --; @@ -839,10 +839,10 @@ style_parse(const char *text, length ++; last = 1; continue; - } else if (bsearch(&bufptr, code_keywords, + } else if (bsearch(&bufptr, code_keywords, sizeof(code_keywords) / sizeof(code_keywords[0]), sizeof(code_keywords[0]), compare_keywords)) { - while (text < temp) { + while (text < temp) { *style++ = 'G'; text ++; length --; @@ -856,7 +856,7 @@ style_parse(const char *text, } } } - } else if (current == 'C' && strncmp(text, "*/", 2) == 0) { + } else if (current == 'C' && strncmp(text, "*/", 2) == 0) { // Close a C comment... *style++ = current; *style++ = current; @@ -885,7 +885,7 @@ style_parse(const char *text, } // Copy style info... - if (current == 'A' && (*text == '{' || *text == '}')) *style++ = 'G'; + if (current == 'A' && (*text == '{' || *text == '}')) *style++ = 'G'; else *style++ = current; col ++; @@ -898,6 +898,6 @@ style_parse(const char *text, } } } -</PRE></UL> +\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. <h3><a name="label">label</h3> Every FLTK widget can have a label attached to it. The <tt>label</tt> demo shows alignment, clipping and wrapping of text labels. Labels -can contain symbols at the start and end of the text, like <i>@FLTK</i> -or <i>@circle uh-huh @square</i>. +can contain symbols at the start and end of the text, like <i>\@FLTK</i> +or <i>\@circle uh-huh \@square</i>. <h3><a name="line_style">line_style</h3> Advanced line drawing can be tested with <tt>line_style</tt>. 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 -<P>The Fast Light Tool Kit ("FLTK", pronounced -"fulltick") is a cross-platform C++ GUI toolkit for +<P>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.</P> <P>Many of the ideas in FLTK were developed on a NeXT (but <I>not</I> 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.</P> <P>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.</P> <P>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.</P> <P>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.</P> <LI>sizeof(Fl_Widget) == 64 to 92.</LI> - <LI>The "core" (the "hello" program - compiled & linked with a static FLTK library using + <LI>The "core" (the "hello" program + compiled & linked with a static FLTK library using gcc on a 486 and then stripped) is 114K.</LI> <LI>The FLUID program (which includes every widget) is @@ -112,7 +112,7 @@ is now included with several Linux distributions.</P> <LI>Support for overlay hardware, with emulation if none is available.</LI> - <LI>Very small & fast portable 2-D drawing library + <LI>Very small & fast portable 2-D drawing library to hide Xlib, WIN32, or QuickDraw.</LI> <LI>OpenGL/Mesa drawing area widget.</LI> @@ -120,7 +120,7 @@ is now included with several Linux distributions.</P> <LI>Support for OpenGL overlay hardware on both X11 and WIN32, with emulation if none is available.</LI> - <LI>Text widgets with Emacs key bindings, X cut & + <LI>Text widgets with Emacs key bindings, X cut & paste, and foreign letter compose!</LI> <LI>Compatibility header file for the GLUT library.</LI> @@ -137,23 +137,23 @@ General Public License</A> with exceptions that allow for static linking. Contrary to popular belief, it can be used in commercial software - even Bill Gates could use it!</P> -<H2>What Does "FLTK" Mean?</H2> +<H2>What Does "FLTK" Mean?</H2> <P>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".</P> +came up with "FLTK", including a bogus excuse that it +stands for "The Fast Light Toolkit".</P> <H2>Building and Installing FLTK Under UNIX and MacOS X</H2> -<P>In most cases you can just type "make". This will +<P>In most cases you can just type "make". This will run configure with the default of no options and then compile everything.</P> @@ -165,36 +165,36 @@ locations you'll need to define the <tt>CFLAGS</tt>, <tt>CXXFLAGS</tt>, and <tt>LDFLAGS</tt> environment variables. For the Bourne and Korn shells you'd use:</P> -<UL><PRE> -CFLAGS=-I<I>includedir</I>; export CFLAGS -CXXFLAGS=-I<I>includedir</I>; export CXXFLAGS -LDFLAGS=-L<I>libdir</I>; export LDFLAGS -</PRE></UL> +\code +CFLAGS=-Iincludedir; export CFLAGS +CXXFLAGS=-Iincludedir; export CXXFLAGS +LDFLAGS=-Llibdir; export LDFLAGS +\endcode <P>For C shell and tcsh, use:</P> -<UL><PRE> -setenv CFLAGS "-I<I>includedir</I>" -setenv CXXFLAGS "-I<I>includedir</I>" -setenv LDFLAGS "-L<I>libdir</I>" -</PRE></UL> +\code +setenv CFLAGS "-Iincludedir" +setenv CXXFLAGS "-Iincludedir" +setenv LDFLAGS "-Llibdir" +\endcode <P>By default configure will look for a C++ compiler named <tt>CC</tt>, <tt>c++</tt>, <tt>g++</tt>, or <tt>gcc</tt> in that order. To use another compiler you need to set the <tt>CXX</tt> environment variable:</P> -<UL><PRE> +\code CXX=xlC; export CXX setenv CXX "xlC" -</PRE></UL> +\endcode <P>The <tt>CC</tt> environment variable can also be used to override the default C compiler (<tt>cc</tt> or <tt>gcc</tt>), which is used for a few FLTK source files.</P> <P>You can run configure yourself to get the exact setup you -need. Type "./configure <options>", where +need. Type "./configure <options>", where options are:</P> <DL> @@ -203,7 +203,7 @@ options are:</P> <DD>Enable the Cygwin libraries under WIN32</DD> <DT>--enable-debug</DT> - <DD>Enable debugging code & symbols</DD> + <DD>Enable debugging code & symbols</DD> <DT>--disable-gl</DT> <DD>Disable OpenGL support</DD> @@ -241,45 +241,45 @@ options are:</P> </DL> <P>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.</P> -<P>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".</P> +<P>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".</P> <H2>Building FLTK Under Microsoft Windows</H2> <P>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.</P> +"visualc" directory. Just open (or double-click on) +the "fltk.dsw" file to get the whole shebang.</P> <P>The second method is to use the <TT>configure</TT> script included with the FLTK software; this has only been tested with the CygWin tools:</P> -<UL><PRE> +\code sh configure --prefix=C:/FLTK make -</PRE></UL> +\endcode <P>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:</P> -<UL><PRE> -copy makefiles\Makefile.<env> Makefile +\code +copy makefiles\Makefile.<env> Makefile make -</PRE></UL> +\endcode <H3>Using the Visual C++ DLL Library</H3> -<P>The "fltkdll.dsp" project file builds a DLL-version +<P>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. <P>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: </P> -<UL><PRE> +\code copy makefiles\Makefile.os2x Makefile make -</PRE></UL> +\endcode <H2>Internet Resources</H2> @@ -341,20 +341,20 @@ make </DL> <P>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.</P> <P>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.</P> +subscribing to the "fltk-digest" mailing list.</P> <H2>Reporting Bugs</H2> <P>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.</P> @@ -362,6 +362,6 @@ any kind of help without that basic information.</P> SourceForge bug tracker pages.</P> <P>For general support and questions, please use the FLTK mailing list -at "fltk@fltk.org" or one of the newsgroups.</P> +at "fltk@fltk.org" or one of the newsgroups.</P> */ |