diff --git a/documentation/src/common.dox b/documentation/src/common.dox index 96f46f2e4..96692d20b 100644 --- a/documentation/src/common.dox +++ b/documentation/src/common.dox @@ -166,7 +166,6 @@ If you change a widget's size or position after it is displayed you will have to call \p redraw() on the widget's parent. - \section common_colors Colors FLTK stores the colors of widgets as an 32-bit unsigned @@ -215,7 +214,6 @@ Similarly, the label color is set using the \p labelcolor() method: button->labelcolor(FL_WHITE); \endcode - \section common_boxtypes Box Types The type Fl_Boxtype stored and returned in Fl_Widget::box() @@ -269,7 +267,6 @@ void xyz_draw(int x, int y, int w, int h, Fl_Color c) { } \endcode - \anchor common_fl_down Fl_Boxtype fl_down(Fl_Boxtype b) @@ -279,7 +276,6 @@ If no "down" version of a given box exists, the behavior of this function is undefined and some random box or frame is returned. See \ref drawing_fl_frame "Drawing Functions" for more details. - \anchor common_fl_frame Fl_Boxtype fl_frame(Fl_Boxtype b) @@ -289,8 +285,6 @@ If no frame version of a given box exists, the behavior of this function is undefined and some random box or frame is returned. See \ref drawing_fl_frame "Drawing Functions" for more details. - -\anchor common_fl_box Fl_Boxtype fl_box(Fl_Boxtype b) \par @@ -323,7 +317,6 @@ value evenly divideable by two. \ref common_fl_frame "fl_frame(Fl_Boxtype)" expects the \p UP_BOX design at a value divideable by four. - \section common_labels Labels and Label Types The \p label(), \p align(), \p labelfont(), \p labelsize(), @@ -375,7 +368,6 @@ constants are defined and may be OR'd together as needed: \li \p FL_TEXT_OVER_IMAGE - show the label text over the image. \li \p FL_IMAGE_OVER_TEXT - show the label image over the text (default). - \anchor common_labeltype \par labeltype() @@ -389,7 +381,6 @@ following standard label types are included: \li \p FL_EMBOSSED_LABEL - draws edges as thought the text is raised. \li \p FL_ICON_LABEL - draws the icon associated with the text. -\anchor common_image_deimage \par image() and deimage() The \p image() and \p deimage() methods set an image that @@ -466,7 +457,6 @@ method to select your label type. The Fl::set_labeltype() method can also be used to overload an existing label type such as \p FL_NORMAL_LABEL. - \par Making your own symbols It is also possible to define your own drawings and add diff --git a/documentation/src/development.dox b/documentation/src/development.dox index 5a4c8448e..54fee79c7 100644 --- a/documentation/src/development.dox +++ b/documentation/src/development.dox @@ -251,96 +251,36 @@ The following section is \section development_links Creating Links Links to other documents and external links can be embedded with - \li normal HTML links - \li HTML links without markup - doxygen creates "http://..." - links automatically - \li links to other doxygen chapters with the \\ref statments - \li links to named sections within the same or other doxygen chapters, - if they are defined there with a \\section statement + +- doxygen \\ref links to other doxygen \\page, \\section, + \\subsection and \\anchor locations +- HTML links without markup - doxygen creates "http://..." + links automatically +- standard, non-Doxygen, HTML links \code - see chapter \ref unicode creates a link to the named chapter unicode - that has been created with a \subpage statement. - see chapter 5 creates - a link to a named html anchor "character_encoding" within the same file. +- see chapter \ref unicode creates a link to the named chapter + unicode that has been created with a \page statement. - For further informations about quoting see +- For further informations about quoting see http://www.stack.nl/~dimitri/doxygen/htmlcmds.html - Bold link text: you can see the online documentation - of FLTK 1.3 at \b http://www.fltk.org/doc-1.3/index.html - - see section \ref development_non-ascii +- see Nedit creates + a standard HTML link + \endcode appears as: - see chapter \ref unicode creates a link to the named chapter unicode - that has been created with a \\subpage statement. +- see chapter \ref unicode creates a link to the named chapter + unicode that has been created with a \\page statement. - see chapter 5 creates - a link to a named html anchor "character_encoding" within the same file. - - For further informations about quoting see +- For further informations about quoting see http://www.stack.nl/~dimitri/doxygen/htmlcmds.html - Bold link text: you can see the online documentation - of FLTK 1.3 at \b http://www.fltk.org/doc-1.3/index.html - - see section \ref development_non-ascii - -\section development_old-links Changing Old Links - -Old HTML links and anchors in text documentation pages should be changed -as follows: - -\code -

Fl::event_*() methods

- -becomes: - - -\section events_event_xxx Fl::event_*() methods -\endcode - -The additional HTML "" statement is temporary needed, until -all links (references) are modified, then: - -\code -

Fl::event_*() methods

- -becomes: - -\section events_event_xxx Fl::event_*() methods -\endcode - -The "\section" statement can also be a "\subsection" or "\subsubsection" -statement. - -The references (in this example from index.dox) are changed as follows: - -\code - - \subpage events - - - - - -becomes: - - \subpage events - - - \li \ref events_event_xxx - \li \ref events_propagation - - -\endcode +- see Nedit creates + a standard HTML link \section development_paragraphs Paragraph Layout @@ -421,18 +361,8 @@ Each introduction (tutorial) page ends with navigation elements. These elements must only be included in the html documentation, therefore they must be separated with \\htmlonly and \\endhtmlonly. -Example navigation links: +The following code gives the navigation bar at the bottom of this page: -\verbatim -\htmlonly -
-[Index]    -[Previous] Migrating Code from FLTK 1.1 to 1.3   -[Next] Software License -\endhtmlonly -\endverbatim - -Now replaced by: \verbatim \htmlonly
diff --git a/documentation/src/drawing.dox b/documentation/src/drawing.dox index 589ac76d5..e3e220bc4 100644 --- a/documentation/src/drawing.dox +++ b/documentation/src/drawing.dox @@ -44,22 +44,18 @@ header file. FLTK provides the following types of drawing functions: \li \ref ssect_Fl_Image \li \ref ssect_Offscreen - \subsection ssect_Boxes Boxes FLTK provides three functions that can be used to draw boxes for buttons and other UI controls. Each function uses the supplied upper-lefthand corner and width and height to determine where to draw the box. - void fl_draw_box(Fl_Boxtype b, int x, int y, int w, int h, Fl_Color c); \par The \p %fl_draw_box() function draws a standard boxtype \p b in the specified color \p c. - - \anchor drawing_fl_frame void fl_frame(const char *s, int x, int y, int w, int h)
void fl_frame2(const char *s, int x, int y, int w, int h) @@ -86,7 +82,6 @@ Note that is described in the \ref common_boxtypes section. - \subsection ssect_Clipping Clipping You can limit all your drawing to a rectangular region by calling @@ -98,7 +93,6 @@ transformation matrix. In addition, the system may provide clipping when updating windows which may be more complex than a simple rectangle. - void fl_push_clip(int x, int y, int w, int h)
void fl_clip(int x, int y, int w, int h) @@ -110,13 +104,11 @@ region onto the stack. The \p %fl_clip() version is deprecated and will be removed from future releases. - void fl_push_no_clip() \par Pushes an empty clip region on the stack so nothing will be clipped. - void fl_pop_clip() \par @@ -129,7 +121,6 @@ You must call \p %fl_pop_clip() once for every time you call If you return to FLTK with the clip stack not empty unpredictable results occur. - int fl_not_clipped(int x, int y, int w, int h) \par @@ -141,7 +132,6 @@ region. If this returns 0 you don't have to draw the object. Under X this returns 2 if the rectangle is partially clipped, and 1 if it is entirely inside the clip region. - int fl_clip_box(int x, int y, int w, int h, int &X, int &Y, int &W, int &H) \par @@ -152,7 +142,6 @@ different than the original. This can be used to limit the necessary drawing to a rectangle. \c W and \c H are set to zero if the rectangle is completely outside the region. - void fl_clip_region(Fl_Region r)
Fl_Region fl_clip_region() @@ -162,7 +151,6 @@ Fl_Region is an operating system specific type. The second form returns the current clipping region. - \section drawing_colors Colors FLTK manages colors as 32-bit unsigned integers. Values from @@ -182,7 +170,6 @@ fl_rgb_color(uchar r, uchar b, uchar c) and fl_rgb_color(uchar grayscale) functions. - void fl_color(Fl_Color c)
void fl_color(int c) @@ -211,7 +198,6 @@ closest possible match to the RGB color is used. The RGB color is used directly on TrueColor displays. For colormap visuals the nearest index in the gray ramp or color cube is used. - \subsection ssect_Lines Line Dashes and Thickness FLTK supports drawing of lines with different styles and @@ -219,7 +205,6 @@ widths. Full functionality is not available under Windows 95, 98, and Me due to the reduced drawing functionality these operating systems provide. - void fl_line_style(int style, int width, char* dashes) \par @@ -272,7 +257,6 @@ The dashes array does not work under Windows 95, 98, or Me, since those operating systems do not support complex line styles. - \subsection ssect_Fast Drawing Fast Shapes These functions are used to draw almost all the FLTK widgets. @@ -283,13 +267,11 @@ ported. It is undefined whether these are affected by the so you should only call these while the matrix is set to the identity matrix (the default). - void fl_point(int x, int y) \par Draw a single pixel at the given coordinates. - void fl_rectf(int x, int y, int w, int h)
void fl_rectf(int x, int y, int w, int h) @@ -305,35 +287,30 @@ color this is done by drawing a solid-colored block using \ref drawing_fl_draw_image "fl_draw_image()" so that the correct color shade is produced. - void fl_rect(int x, int y, int w, int h)
void fl_rect(int x, int y, int w, int h, Fl_Color c) \par Draw a 1-pixel border \e inside this bounding box. - void fl_line(int x, int y, int x1, int y1)
void fl_line(int x, int y, int x1, int y1, int x2, int y2) \par Draw one or two lines between the given points. - void fl_loop(int x, int y, int x1, int y1, int x2, int y2)
void fl_loop(int x, int y, int x1, int y1, int x2, int y2, int x3, int y3) \par Outline a 3 or 4-sided polygon with lines. - void fl_polygon(int x, int y, int x1, int y1, int x2, int y2)
void fl_polygon(int x, int y, int x1, int y1, int x2, int y2, int x3, int y3) \par Fill a 3 or 4-sided polygon. The polygon must be convex. - void fl_xyline(int x, int y, int x1)
void fl_xyline(int x, int y, int x1, int y2)
void fl_xyline(int x, int y, int x1, int y2, int x3) @@ -342,7 +319,6 @@ void fl_xyline(int x, int y, int x1, int y2, int x3) Draw horizontal and vertical lines. A horizontal line is drawn first, then a vertical, then a horizontal. - void fl_yxline(int x, int y, int y1)
void fl_yxline(int x, int y, int y1, int x2)
void fl_yxline(int x, int y, int y1, int x2, int y3) @@ -351,7 +327,6 @@ void fl_yxline(int x, int y, int y1, int x2, int y3) Draw vertical and horizontal lines. A vertical line is drawn first, then a horizontal, then a vertical. - void fl_arc(int x, int y, int w, int h, double a1, double a2)
void fl_pie(int x, int y, int w, int h, double a1, double a2) @@ -386,7 +361,6 @@ use \p w-1 and \p h-1. \todo add an Fl_Draw_Area_Cb typedef to allow fl_scroll(...) to be doxygenated? - void fl_scroll(int X, int Y, int W, int H, int dx, int dy, void (*draw_area)(void*, int,int,int,int), void* data) \par @@ -396,7 +370,6 @@ of the rectangular area is first shifted by \p dx and exposed rectangular area, - \subsection ssect_Complex Drawing Complex Shapes The complex drawing functions let you draw arbitrary shapes @@ -410,7 +383,6 @@ severely limits the accuracy of these functions for complex graphics, so use OpenGL when greater accuracy and/or performance is required. - void fl_push_matrix()
void fl_pop_matrix() @@ -418,7 +390,6 @@ void fl_pop_matrix() Save and restore the current transformation. The maximum depth of the stack is 4. - void fl_scale(double x,double y)
void fl_scale(double x)
void fl_translate(double x,double y)
@@ -429,7 +400,6 @@ void fl_mult_matrix(double a,double b,double c,double d,double x,double y) Concatenate another transformation onto the current one. The rotation angle is in degrees (not radians) and is counter-clockwise. - double fl_transform_x(double x, double y)
double fl_transform_y(double x, double y)
double fl_transform_dx(double x, double y)
@@ -441,7 +411,6 @@ Transform a coordinate or a distance using the current transformation matrix. After transforming a coordinate pair, it can be added to the vertex list without any forther translations using \p %fl_transformed_vertex(). - void fl_begin_points()
void fl_end_points() @@ -449,28 +418,24 @@ void fl_end_points() Start and end drawing a list of points. Points are added to the list with \p %fl_vertex(). - void fl_begin_line()
void fl_end_line() \par Start and end drawing lines. - void fl_begin_loop()
void fl_end_loop() \par Start and end drawing a closed sequence of lines. - void fl_begin_polygon()
void fl_end_polygon() \par Start and end drawing a convex filled polygon. - void fl_begin_complex_polygon()
void fl_gap()
void fl_end_complex_polygon() @@ -498,20 +463,17 @@ For portability, you should only draw polygons that appear the same whether "even/odd" or "non-zero" winding rules are used to fill them. Holes should be drawn in the opposite direction of the outside loop. - void fl_vertex(double x,double y) \par Add a single vertex to the current path. - void fl_curve(double X0, double Y0, double X1, double Y1, double X2, double Y2, double X3, double Y3) \par Add a series of points on a Bezier curve to the path. The curve ends (and two of the points) are at X0,Y0 and X3,Y3. - \anchor drawing_fl_arc void fl_arc(double x, double y, double r, double start, double end) @@ -527,7 +489,6 @@ in degrees counter-clockwise from 3 o'clock. If \p end is less than \p start then it draws the arc in a clockwise direction. - void fl_circle(double x, double y, double r) \par @@ -540,7 +501,6 @@ a circle as part of a complex polygon you must use \p %fl_arc(). \p %fl_circle() draws incorrectly if the transformation is both rotated and non-square scaled. - \subsection ssect_Text Drawing Text All text is drawn in the @@ -548,7 +508,6 @@ All text is drawn in the It is undefined whether this location or the characters are modified by the current transformation. - void fl_draw(const char *, int x, int y)
void fl_draw(const char *, int n, int x, int y) @@ -586,7 +545,6 @@ to look for symbol names starting with the "@" character. \par The text length is limited to 1024 characters per line. - void fl_measure(const char *str, int& w, int& h, int draw_symbols) \par @@ -594,23 +552,19 @@ Measure how wide and tall the string will be when printed by the \p fl_draw(...align) function. If the incoming \p w is non-zero it will wrap to that width. - int fl_height() \par Recommended minimum line spacing for the current font. You can also just use the value of \p size passed to \ref drawing_fl_font "fl_font()". -fl_font(). - int fl_descent() \par Recommended distance above the bottom of a \p %fl_height() tall box to draw the text at so it looks centered vertically in that box. - double fl_width(const char* txt)
double fl_width(const char* txt, int n)
double fl_width(Fl_Unichar) @@ -619,7 +573,6 @@ double fl_width(Fl_Unichar) Return the pixel width of a nul-terminated string, a sequence of \p n characters, or a single character in the current font. - const char* fl_shortcut_label(int shortcut) \par @@ -630,7 +583,6 @@ key. If the shortcut is zero an empty string is returned. The return value points at a static buffer that is overwritten with each call. - \subsection ssect_Fonts Fonts FLTK supports a set of standard fonts based on the Times, @@ -646,7 +598,6 @@ these, and FL_SYMBOL and FL_ZAPF_DINGBATS. Faces greater than 255 cannot be used in Fl_Widget labels, since Fl_Widget stores the index as a byte. - \anchor drawing_fl_font void fl_font(int face, int size) @@ -661,7 +612,6 @@ The font is identified by a \p face and a \p size. The size of the font is measured in \p pixels and not "points". Lines should be spaced \p size pixels apart or more. - int fl_font()
int fl_size() @@ -669,7 +619,6 @@ int fl_size() Returns the face and size set by the most recent call to \p fl_font(a,b). This can be used to save/restore the font. - \subsection ssect_CharacterEncoding Character Encoding \todo @@ -709,16 +658,15 @@ html "¸"). \todo drawing.dox: I fixed the above encoding problem of these \¸ and umlaut characters, but this text is obsoleted by FLTK 1.3 - with utf-8 encoding, or must be rewritten accordingly: + with UTF-8 encoding, or must be rewritten accordingly: How to use native (e.g. Windows "ANSI", or ISO-8859-x) encoding in embedded strings for labels, error messages - and more. Please check this (utf-8) encoding on different + and more. Please check this (UTF-8) encoding on different OS'es and with different language and font environments. -For more information about character encoding, unicode and utf-8 -see chapter \ref unicode. +For more information about character encodings, see the chapter on +\ref unicode. - \subsection ssect_Overlay Drawing Overlays These functions allow you to draw interactive selection rectangles @@ -744,7 +692,6 @@ should call \p %fl_overlay_clear() after a FL_RELEASE event. - \section drawing_images Drawing Images To draw images, you can either do it directly from data in @@ -761,7 +708,6 @@ The behavior when drawing images when the current transformation matrix is not the identity is not defined, so you should only draw images when the matrix is set to the identity. - \anchor drawing_fl_draw_image void fl_draw_image(const uchar *buf,int X,int Y,int W,int H,int D,int L)
void fl_draw_image_mono(const uchar *buf,int X,int Y,int W,int H,int D,int L) @@ -844,7 +790,6 @@ the first one may be greater than zero. If \p D is 4 or more, you must fill in the unused bytes with zero. - int fl_draw_pixmap(char* const* data, int x, int y, Fl_Color bg)
int fl_draw_pixmap(const char* const* cdata, int x, int y, Fl_Color bg) @@ -868,7 +813,6 @@ Transparent colors are replaced by the optional Fl_Color argument. To draw with true transparency you must use the Fl_Pixmap class. - int fl_measure_pixmap(char* const* data, int &w, int &h)
int fl_measure_pixmap(const char* const* cdata, int &w, int &h) @@ -883,7 +827,6 @@ there was any problem. FLTK provides a single function for reading from the current window or off-screen buffer into a RGB(A) image buffer. - uchar* fl_read_image(uchar *p, int X, int Y, int W, int H, int alpha) \par @@ -899,7 +842,6 @@ The \p alpha parameter controls whether an alpha channel is created and the value that is placed in the alpha channel. If 0, no alpha channel is generated. - \subsection ssect_Fl_Image Image Classes FLTK provides a base image class called Fl_Image which supports @@ -930,7 +872,6 @@ provided by the draw() method is either a 24-bit blend against the existing window contents or a "screen door" transparency mask, depending on the platform and screen color depth. - char fl_can_do_alpha_blending() \par @@ -982,7 +923,6 @@ void Fl_Tiled_Image::draw(int x, int y) Draws the image with the upper-left corner at x,y. This is the same as doing \p draw(x,y,img->w(),img->h(),0,0). - \subsection ssect_Offscreen Offscreen Drawing \todo @@ -995,19 +935,16 @@ repeated drawing. Fl_Double_Window uses offscreen rendering to avoid flickering on systems that don't support double-buffering natively. - Fl_Offscreen fl_create_offscreen(int w, int h) \par Create an RGB offscreen buffer with \p w*h pixels. - void fl_delete_offscreen(Fl_Offscreen) \par Delete a previously created offscreen buffer. All drawings are lost. - void fl_begin_offscreen(Fl_Offscreen) \par @@ -1015,13 +952,11 @@ Send all subsequent drawing commands to this offscreen buffer. FLTK can draw into a buffer at any time. There is no need to wait for an Fl_Widget::draw() to occur. - void fl_end_offscreen() \par Quit sending drawing commands to this offscreen buffer. - void fl_copy_offscreen(int x, int y, int w, int h, Fl_Offscreen osrc, int srcx, int srcy) diff --git a/documentation/src/editor.dox b/documentation/src/editor.dox index 210a34da1..86eed4635 100644 --- a/documentation/src/editor.dox +++ b/documentation/src/editor.dox @@ -621,7 +621,7 @@ The Fl_Text_Editor widget supports highlighting of text with different fonts, colors, and sizes. The implementation is based on the excellent NEdit -text editor core, which +text editor core, from http://www.nedit.org/, which uses a parallel "style" buffer which tracks the font, color, and size of the text that is drawn. diff --git a/documentation/src/enumerations.dox b/documentation/src/enumerations.dox index 78b6df103..9a1a5ae88 100644 --- a/documentation/src/enumerations.dox +++ b/documentation/src/enumerations.dox @@ -248,8 +248,7 @@ RGB color value are described in the \ref drawing_colors section of the \ref drawing -chapter, or in the generated -Function Reference pages. +chapter. \section enumerations_cursors Cursors @@ -305,7 +304,7 @@ The following damage mask bits are used by the standard FLTK widgets: [Prev] - Unicode and utf-8 Support + Unicode and UTF-8 Support diff --git a/documentation/src/events.dox b/documentation/src/events.dox index 1859b3d66..e5a984bfe 100644 --- a/documentation/src/events.dox +++ b/documentation/src/events.dox @@ -261,7 +261,6 @@ widget. This indicates that some other widget or program has claimed the selection. Motif programs used this to clear the selection indication. Most modern programs ignore this. - \section events_dnd Drag and Drop Events FLTK supports drag and drop of text and files from any @@ -303,7 +302,6 @@ the immediatly following \p FL_PASTE event. - \section events_event_xxx Fl::event_*() methods FLTK keeps the information about the most recent event in @@ -334,7 +332,6 @@ These are all trivial inline functions and thus very fast and small: \li Fl::get_mouse() \li Fl::test_shortcut() - \section events_propagation Event Propagation FLTK follows very simple and unchangeable rules for sending @@ -369,7 +366,6 @@ control those leaf widgets: \li Fl::release() \li Fl_Widget::take_focus() - \section events_compose_characters FLTK Compose-Character Sequences \todo Does Fltk Compose Character Sequences text need updating diff --git a/documentation/src/examples.dox b/documentation/src/examples.dox index 69942567e..72797d441 100644 --- a/documentation/src/examples.dox +++ b/documentation/src/examples.dox @@ -106,14 +106,12 @@ merely a test platform to verify the functionality of the FLTK library. - \subsection examples_adjuster adjuster \par \c adjuster shows a nifty little widget for quickly setting values in a great range. - \subsection examples_arc arc \par @@ -121,7 +119,6 @@ The \c arc demo explains how to derive your own widget to generate some custom drawings. The sample drawings use the matrix based arc drawing for some fun effects. - \subsection examples_ask ask \par @@ -129,7 +126,6 @@ based arc drawing for some fun effects. the correct answers or you may end up in a loop, or you may end up in a loop, or you... . - \subsection examples_bitmap bitmap \par @@ -137,7 +133,6 @@ This simple test shows the use of a single color bitmap as a label for a box widget. Bitmaps are stored in the X11 '.bmp' file format and can be part of the source code. - \subsection examples_blocks blocks \par @@ -146,7 +141,6 @@ timers, graphics, and how to implement sound on all platforms. \c blocks is also a good example for the Mac OS X specific bundle format. - \subsection examples_boxtype boxtype \par @@ -155,7 +149,6 @@ frames in FLTK. More types can be added by the application programmer. When using themes, FLTK shuffles boxtypes around to give your program a new look. - \subsection examples_browser browser \par @@ -163,19 +156,16 @@ a new look. Important features tested are loading of files, line formatting, and correct positioning of the browser data window. - \subsection examples_button button \par The \c button test is a simple demo of push-buttons and callbacks. - \subsection examples_buttons buttons \par \c buttons shows a sample of FLTK button types. - \subsection examples_checkers checkers \par @@ -185,7 +175,6 @@ application with a graphical UI. Check out the code that drags the pieces, and how the pieces are drawn by layering. Then tell me how to beat the computer at Checkers. - \subsection examples_clock clock \par @@ -193,7 +182,6 @@ The \c clock demo shows two analog clocks. The innards of the Fl_Clock widget are pretty interesting, explaining the use of timeouts and matrix based drawing. - \subsection examples_colbrowser colbrowser \par @@ -202,14 +190,12 @@ the use of timeouts and matrix based drawing. of every text entry in the file. This is beautiful, but only moderatly useful unless your UI is written in Motif. - \subsection examples_color_chooser color_chooser \par The \c color_chooser gives a short demo of FLTK's palette based color chooser and of the RGB based color wheel. - \subsection examples_cube cube \par @@ -217,13 +203,11 @@ The \c cube demo shows the speed of OpenGL. It also tests the ability to render two OpenGL buffers into a single window, and shows OpenGL text. - \subsection examples_CubeView CubeView \par \c CubeView shows how to create a UI containing OpenGL with Fluid. - \subsection examples_cursor cursor \par @@ -231,14 +215,12 @@ The \c cursor demo shows all mouse cursor shapes that come standard with FLTK. The fgcolor and bgcolor sliders work only on few systems (some version of Irix for example). - \subsection examples_curve curve \par \c curve draws a nice Bezier curve into a custom widget. The points option for splines is not supported on all platforms. - \subsection examples_demo demo \par @@ -246,7 +228,6 @@ This tool allows quick access to all programs in the \c test directory. \c demo is based on the visuals of the IrixGL demo program. The menu tree can be changed by editing test/demo.menu. - \subsection examples_doublebuffer doublebuffer \par @@ -257,7 +238,6 @@ amount of RAM. Some modern OS's double buffer all windows automatically to allow transparency and shadows on the desktop. FLTK is smart enough to not tripple buffer a window in that case. - \subsection examples_editor editor \par @@ -267,14 +247,12 @@ Fl_Text_Editor is a complete port of nedit (with permission). The \c editor test is almost a full application, showing custom syntax highlighting and dialog creation. - \subsection examples_fast_slow fast_slow \par \c fast_slow shows how an application can use the Fl_Widget::when() setting to receive different kinds of callbacks. - \subsection examples_file_chooser file_chooser \par @@ -282,7 +260,6 @@ The standard FLTK \c file_chooser is the result of many iterations, trying to find a middle ground between a complex browser and a fast light implementation. - \subsection examples_fonts fonts \par @@ -291,7 +268,6 @@ If your machine still has some pixmap based fonts, the supported sizes will be shown in bold face. Only the first 256 fonts will be listed. - \subsection examples_forms forms \par @@ -300,7 +276,6 @@ Search for "fltk" to find all changes necessary to port to fltk. This demo shows the different boxtypes. Note that some boxtypes are not appropriate for some objects. - \subsection examples_fractals fractals \par @@ -308,7 +283,6 @@ boxtypes are not appropriate for some objects. FLTK supports a rather large subset of Glut, so that many Glut applications compile just fine. - \subsection examples_fullscreen fullscreen \par @@ -318,7 +292,6 @@ You can toggle the border on/off, switch between single- and double-buffered rendering, and take over the entire screen. More information in the source code. - \subsection examples_gl_overlay gl_overlay \par @@ -326,14 +299,12 @@ screen. More information in the source code. hardware overlay plane is available, FLTK will simulate it for you. - \subsection examples_glpuzzle glpuzzle \par The \c glpuzzle test shows how most Glut source code compiles easily under FLTK. - \subsection examples_hello hello \par @@ -341,7 +312,6 @@ easily under FLTK. tiny demo shows how little is needed to get a functioning application running with FLTK. Quite impressive, I'd say. - \subsection examples_help help \par @@ -351,14 +321,12 @@ various image formats. This widget makes it easy to provide help pages to the user without depending on the operating system's html browser. - \subsection examples_iconize iconize \par \c iconize demonstrates the effect of the window functions hide(), iconize(), and show(). - \subsection examples_image image \par @@ -367,7 +335,6 @@ This generated image contains an alpha (transparency) channel which lets previous renderings 'shine through', either via true transparency or by using screen door transparency (pixelation). - \subsection examples_inactive inactive \par @@ -375,7 +342,6 @@ transparency or by using screen door transparency (pixelation). To see the inactive version of images, you can check out the pixmap or image test. - \subsection examples_input input \par @@ -383,7 +349,6 @@ This tool shows and tests different types of text input fields based on Fl_Input_. The \c input program also tests various settings of Fl_Input::when(). - \subsection examples_input_choice input_choice \par @@ -392,7 +357,6 @@ field with an attached pulldown menu. Windows users will recognize similarities to the 'ComboBox'. \c input_choice starts up in 'plastic' scheme, but the traditional scheme is also supported. - \subsection examples_keyboard keyboard \par @@ -402,7 +366,6 @@ and Fl::event_text(). It is also great to see the modifier buttons and the scroll wheel at work. Quit this application by closing the window. The ESC key will not work. - \subsection examples_label label \par @@ -411,14 +374,12 @@ 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. - \subsection examples_line_style line_style \par Advanced line drawing can be tested with \c line_style. Not all platforms support all line styles. - \subsection examples_list_visuals list_visuals \par @@ -426,7 +387,6 @@ This little app finds all available pixel formats for the current X11 screen. But since you are now an FLTK user, you don't have to worry about any of this. - \subsection examples_mandelbrot mandelbrot \par @@ -436,7 +396,6 @@ system. This is one of the few occasions where the idle callback is very useful by giving all available processor time to the application without blocking the UI or other apps. - \subsection examples_menubar menubar \par @@ -444,13 +403,11 @@ The \c menubar tests many aspects of FLTK's popup menu system. Among the features are radio buttons, menus taller than the screen, arbitrary sub menu depth, and global shortcuts. - \subsection examples_message message \par \c message pops up a few of FLTK's standard message boxes. - \subsection examples_minimum minimum \par @@ -459,14 +416,12 @@ are set correctly. In a real life application, the trail would be avoided by choosing a smaller label or by setting label clipping differently. - \subsection examples_navigation navigation \par \c navigation demonstrates how the text cursor moves from text field to text field when using the arrow keys, tab, and shift-tab. - \subsection examples_output output \par @@ -474,7 +429,6 @@ text field to text field when using the arrow keys, tab, and shift-tab. multi line mode of the Fl_Output widget. Fonts can be selected from the FLTK standard list of fonts. - \subsection examples_overlay overlay \par @@ -483,7 +437,6 @@ be layered to display cursor and manipulator style elements. This example derives a new class from Fl_Overlay_Window and provides a new function to draw custom overlays. - \subsection examples_pack pack \par @@ -492,7 +445,6 @@ and repositioning of children of the Fl_Pack group. Putting an Fl_Pack into an Fl_Scroll is a useful way to create a browser for large sets of data. - \subsection examples_pixmap_browser pixmap_browser \par @@ -500,7 +452,6 @@ a useful way to create a browser for large sets of data. the same image multiple times, Fl_Shared_Image will keep it only once in memory. - \subsection examples_pixmap pixmap \par @@ -509,7 +460,6 @@ label for a box widget. Pixmaps are stored in the X11 '.xpm' file format and can be part of the source code. Pixmaps support one transparent color. - \subsection examples_preferences preferences \par @@ -517,7 +467,6 @@ I do have my \c preferences in the morning, but sometimes I just can't remember a thing. This is where the Fl_Preferences come in handy. They remember any kind of data between program launches. - \subsection examples_radio radio \par @@ -525,21 +474,18 @@ The \c radio tool was created entirely with fluid. It shows some of the available button types and tests radio button behavior. - \subsection examples_resizebox resizebox \par \c resizebox shows some possible ways of FLTK's automatic resize bahavior.. - \subsection examples_resize resize \par The \c resize demo tests size and position functions with the given window manager. - \subsection examples_scroll scroll \par @@ -549,7 +495,6 @@ clipping and smart window area copying to improve redraw speed. The buttons at the bottom of the window control decoration rendering and updates. - \subsection examples_shape shape \par @@ -557,7 +502,6 @@ and updates. your own OpenGL rendering widget. Now that you know that, go ahead and write that flight simulator you always dreamt of. - \subsection examples_subwindow subwindow \par @@ -567,7 +511,6 @@ to a group by resetting the FLTK coordinate system to 0, 0 in the top left corner. On Win32 and X11, subwindows have their own operating system specific handle. - \subsection examples_sudoku sudoku \par @@ -575,7 +518,6 @@ Another highly addictive game - don't play it, I warned you. The implementation shows how to create application icons, how to deal with OS specifics, and how to generate sound. - \subsection examples_symbols symbols \par @@ -585,7 +527,6 @@ and with a little patience, you can define your own. The rotation number refers to 45 degree rotations if you were looking at a numeric keypad (2 is down, 6 is right, etc.). - \subsection examples_tabs tabs \par @@ -598,7 +539,6 @@ The \c tabs application shows the Fl_Tabs widget on the left and the Fl_Wizard widget on the right side for direct comparison of these two panel management widgets. - \subsection examples_threads threads \par @@ -609,7 +549,6 @@ Fl::unlock(), and Fl::awake() in secondary threads to keep FLTK happy. Although locking works on all platforms, this demo is not available on every machine. - \subsection examples_tile tile \par @@ -617,7 +556,6 @@ The \c tile tool shows a nice way of using Fl_Tile. To test correct resizing of subwindows, the widget for region 1 is created from an Fl_Window class. - \subsection examples_tiled_image tiled_image \par @@ -625,14 +563,12 @@ The \c tiled_image demo uses an image as the background for a window by repeating it over the full size of the widget. The window is resizable and shows how the image gets repeated. - \subsection examples_valuators valuators \par \c valuators shows all of FLTK's nifty widgets to change numeric values. - \subsection examples_fluid fluid \par diff --git a/documentation/src/fluid.dox b/documentation/src/fluid.dox index e716c15d6..9decaf6ef 100644 --- a/documentation/src/fluid.dox +++ b/documentation/src/fluid.dox @@ -1470,7 +1470,6 @@ file to be used for all of the windows defined in your The \b Set: field controls the set number in the catalog file. The default set is 1 and rarely needs to be changed. - \section fluid_limitations Known limitations Declaration Blocks can be used to temporarily block out already diff --git a/documentation/src/intro.dox b/documentation/src/intro.dox index 239175fa2..a0ed8d58c 100644 --- a/documentation/src/intro.dox +++ b/documentation/src/intro.dox @@ -285,9 +285,7 @@ native Presentation Manager version has not been implemented yet (volunteers are welcome!). The current set of Makefiles/configuration failes assumes that EMX 0.9d -and libExt (from -posix2.sourceforge.net) -is installed. +and libExt (from http://posix2.sourceforge.net) 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: @@ -302,21 +300,19 @@ make FLTK is available on the 'net in a bunch of locations: \par WWW -http://www.fltk.org/
-http://www.fltk.org/str.php - [for reporting bugs]
-http://www.fltk.org/software.php - [source code] +http://www.fltk.org/
+http://www.fltk.org/str.php [for reporting bugs]
+http://www.fltk.org/software.php [source code] \par FTP -California, USA (ftp.fltk.org)
-Maryland, USA (ftp2.fltk.org)
-Espoo, Finland (ftp.funet.fi)
-Germany (linux.mathematik.tu-darmstadt.de)
-Austria (gd.tuwien.ac.at) +ftp://ftp.fltk.org/pub/fltk [California, USA]
+ftp://ftp2.fltk.org/pub/fltk [Maryland, USA]
+ftp://ftp.funet.fi/pub/mirrors/ftp.fltk.org/pub/fltk [Espoo, Finland]
+ftp://linux.mathematik.tu-darmstadt.de/pub/linux/mirrors/misc/fltk [Germany]
+ftp://gd.tuwien.ac.at/hci/fltk [Austria] \par EMail -fltk@fltk.org [see instructions below]
+fltk@fltk.org [see instructions below]
fltk-bugs@fltk.org [for reporting bugs] \par NNTP Newsgroups diff --git a/documentation/src/opengl.dox b/documentation/src/opengl.dox index c56d21e0e..51882a293 100644 --- a/documentation/src/opengl.dox +++ b/documentation/src/opengl.dox @@ -163,7 +163,6 @@ Your main program can now create one of your windows by doing You can also use your new window class in \ref fluid "FLUID" -FLUID by: -# Putting your class definition in a \p MyWindow.H file. @@ -259,7 +258,7 @@ void gl_font(Fl_Font fontid, int size) \par Sets the current OpenGL font to the same font you get by calling -fl_font(). +\ref ssect_Fonts "fl_font()". int gl_height()
int gl_descent()
@@ -293,7 +292,7 @@ void gl_draw(const char *s, int x, int y, int w, int h, Fl_Align) Draws a string formatted into a box, with newlines and tabs expanded, other control characters changed to ^X, and aligned with the edges or center. Exactly the same output as -fl_draw(). +\ref ssect_Text "fl_draw()". \section opengl_speed Speeding up OpenGL diff --git a/documentation/src/preface.dox b/documentation/src/preface.dox index 167146125..d0e27427d 100644 --- a/documentation/src/preface.dox +++ b/documentation/src/preface.dox @@ -41,8 +41,7 @@ This manual is organized into the following chapters and appendices: \section preface_conventions Conventions This manual was generated using Doxygen -(see -http://www.stack.nl/~dimitri/doxygen/) +(see http://www.stack.nl/~dimitri/doxygen/) to process the source code itself, special comments in the code, and additional documentation files. In general, Doxygen recognizes and denotes the following entities as shown: @@ -50,10 +49,7 @@ In general, Doxygen recognizes and denotes the following entities as shown: - methods, such as Fl_Widget::callback(Fl_Callback* cb, void* p), - functions, such as fl_draw(const char *str, int x, int y), - internal links, such as \ref preface_conventions, -- external links, such as - - http://www.stack.nl/~dimitri/doxygen/ - +- external links, such as http://www.stack.nl/~dimitri/doxygen/ Other code samples and commands are shown in regular courier type. diff --git a/documentation/src/subclassing.dox b/documentation/src/subclassing.dox index 7ffcc8eca..1a81d2363 100644 --- a/documentation/src/subclassing.dox +++ b/documentation/src/subclassing.dox @@ -188,7 +188,6 @@ Calling \p set_flag(SHORTCUT_LABEL) modifies the behavior of \ref subclassing_draw_label "draw_label()" so that '\&' characters cause an underscore to be printed under the next letter. - \anchor subclassing_clear_visible \anchor subclassing_set_visible void Fl_Widget::set_visible()
@@ -304,7 +303,6 @@ You must return non-zero if your \p handle() method uses the event. If you return zero, the parent widget will try sending the event to another widget. - \section subclassing_drawing Drawing the Widget The \p draw() virtual method is called when FLTK wants