mirrors/fltk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
6645d3cb6a
fltk/documentation
History
Fabien Costantini 6645d3cb6a Doxygen Documentation WP6 Done, Also completed the documentation of Help_View, Help_Dialog and cleaned up Preferences from ugly stars in comments and also removed redundant get/set text from methods doc. In this increment, we don't bother with the old dox format (comments in header). We have better things to do with our time (like about 40 mores files to doxyfy :-). 
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6243 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 20:00:03 +00:00
..
adjuster1.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
advanced.dox documentation/preface.dox re-added, with history (preface.html) 2008-09-13 13:28:51 +00:00
advanced.html Removed the Fl::set_awake_cb API and documented the Fl::awake(function, data) API. 2007-03-20 10:41:14 +00:00
basics.dox Doxygen documentation - WP12 and WP13 - first step. 2008-09-13 15:55:32 +00:00
basics.html Added a few links in the documentation Basics page 2008-01-04 20:31:06 +00:00
blocks.man Do some rearranging of image and desktop support files. 2006-08-25 06:58:33 +00:00
boxtypes.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
buttons.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
charts.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
checkers.man More packaging fun. 2006-01-15 18:36:16 +00:00
choice.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
clock.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
common.dox Doxygen documentation - WP12 and WP13 - first step. 2008-09-13 15:55:32 +00:00
common.html Replaced '>' with '>' in the documentation where appropriate (STR# 1682, 1684, 1685) 2007-05-17 15:52:15 +00:00
counter.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
cubeview.gif Finish changes to FLUID chapter... 2002-03-24 21:51:32 +00:00
dial.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
drawing.dox Doxygen documentation - WP12 and WP13 - first step. 2008-09-13 15:55:32 +00:00
drawing.html STR 1874: remove fl_create_offscreen_with_alpha which is merely a helper function for built-in image rendering on only a single platform and should not be public. 2008-02-20 17:31:39 +00:00
editor-replace.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
editor.dox Doxygen documentation - WP12 and WP13 - first step. 2008-09-13 15:55:32 +00:00
editor.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
editor.html Replaced '>' with '>' in the documentation where appropriate (STR# 1682, 1684, 1685) 2007-05-17 15:52:15 +00:00
enumerations.dox Saving an improved version of FL/Enumerations.H and related files. 2008-09-14 11:15:17 +00:00
enumerations.html Replaced '>' with '>' in the documentation where appropriate (STR# 1682, 1684, 1685) 2007-05-17 15:52:15 +00:00
events.dox Doxygen documentation - WP12 and WP13 - first step. 2008-09-13 15:55:32 +00:00
events.html STR 1867: Documentation fix 2008-02-14 18:36:42 +00:00
examples.dox Doxygen documentation - WP12 and WP13 - first step. 2008-09-13 15:55:32 +00:00
examples.html Typo... 2007-11-20 11:09:07 +00:00
FL200.gif Added two UTF-8 support headers which can not be used just yet. Added sample implementation of Doxygen documentation, including a Doxygen config file, two copied doc pages documentation/index.do and documentation/preface.dox, and sample headers fro Fl_Preferences and Fl_Clock. 2008-04-08 00:09:16 +00:00
Fl_Adjuster.html Documentation fixes. 2006-10-29 14:16:03 +00:00
fl_alert.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
fl_ask.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
Fl_Bitmap.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_BMP_Image.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Box.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Browser_.html STR #1726, STR #1753: documentation updates 2007-12-28 23:01:40 +00:00
Fl_Browser.html STR #1726, STR #1753: documentation updates 2007-12-28 23:01:40 +00:00
Fl_Button.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Chart.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Check_Browser.html STR #1767: Adding "remove" function for the Fl_Check_Browser 2007-11-19 15:49:51 +00:00
Fl_Check_Button.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
Fl_Check_Button.html Documentation fixes. 2006-10-29 14:16:03 +00:00
fl_choice.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
Fl_Choice.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Clock_Output.html Fix HTML errors. 2007-02-09 18:46:32 +00:00
Fl_Clock.html Fix HTML errors. 2007-02-09 18:46:32 +00:00
Fl_Color_Chooser.html Documentation fixes. 2006-10-29 14:16:03 +00:00
fl_color_chooser.jpg Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
Fl_Counter.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Dial.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Double_Window.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_End.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_File_Browser.html Replaced '>' with '>' in the documentation where appropriate (STR# 1682, 1684, 1685) 2007-05-17 15:52:15 +00:00
Fl_File_Chooser.html Fixed Fl_File_Chooser::add_extra docs. 2008-06-17 08:44:21 +00:00
Fl_File_Chooser.jpg New file chooser. 2002-06-07 15:06:32 +00:00
Fl_File_Icon.html Replaced '>' with '>' in the documentation where appropriate (STR# 1682, 1684, 1685) 2007-05-17 15:52:15 +00:00
Fl_File_Input.gif Add docos for Fl_File_Input. 2002-05-01 00:55:45 +00:00
Fl_File_Input.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Float_Input.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Free.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_GIF_Image.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Gl_Window.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Group.html Add clip_children() method (STR #1844) 2007-12-15 16:42:00 +00:00
Fl_Help_Dialog.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
Fl_Help_Dialog.html Documentation fix (STR #1686) 2007-05-18 18:57:40 +00:00
Fl_Help_View.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Hold_Browser.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Image.html Add delete/release comments for Fl_Image::copy() (STR #1827) 2007-12-15 17:19:36 +00:00
Fl_Input_.html Added support for keyboard shortcuts to Fl_Input_ derived widgets (STR #1770). Code added for Fluid. Documentation updated. 2008-04-22 23:33:17 +00:00
Fl_Input_Choice.html Fix Fl_Input_Choice targets (STR #1578) 2007-01-31 23:10:14 +00:00
fl_input.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
Fl_Input.html STR 1857: fixed malformed HTML. 2008-01-16 15:25:17 +00:00
Fl_Int_Input.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_JPEG_Image.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Light_Button.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
Fl_Light_Button.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Menu_.html Updated Fl_Menu_ documentation with a warning to not change the structure of a menu during a callback by itself. 2007-10-06 17:42:05 +00:00
Fl_Menu_Bar.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Menu_Button.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Menu_Item.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Menu_Window.html Documentation fixes. 2006-10-29 14:16:03 +00:00
fl_message.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
Fl_Multi_Browser.html STR #1777: Updated documentation to explain deselecting a line in an Fl_Multi_Browser. 2007-10-07 18:49:55 +00:00
Fl_Multiline_Input.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Multiline_Output.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Output.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Overlay_Window.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Pack.html Note that Fl_Pack only works with frame box types (STR #1794) 2007-11-21 05:00:55 +00:00
fl_password.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
Fl_Pixmap.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_PNG_Image.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_PNM_Image.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Positioner.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Preferences.html Fix HTML errors. 2007-02-09 18:46:32 +00:00
Fl_Progress.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Repeat_Button.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Return_Button.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
Fl_Return_Button.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_RGB_Image.html typo 2008-01-10 22:43:37 +00:00
Fl_Roller.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
Fl_Roller.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Round_Button.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
Fl_Round_Button.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Scroll.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
Fl_Scroll.html Fixed issues with Fl_Scroll inside and Fl_Scroll (STR #265) 2008-04-24 09:01:37 +00:00
Fl_Scrollbar.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Secret_Input.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Select_Browser.html STR #1726, STR #1753: documentation updates 2007-12-28 23:01:40 +00:00
Fl_Shared_Image.html Documentation fixes. 2006-10-29 14:16:03 +00:00
fl_show_colormap.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
Fl_Single_Window.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Slider.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Spinner.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Tabs.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Text_Buffer.html STR #1644: documenting return values for loading and saving text from the Fl_Text_Buffer. 2007-05-01 15:59:39 +00:00
Fl_Text_Display.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Text_Editor.html Adding keyboard shortcut to Fl_Value_Input and Fl_Text_Editor 2008-04-23 14:19:58 +00:00
Fl_Tile.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
Fl_Tile.html Updated the Fl_Tile documentation, hoping that the way it works becomes a bit clearer. I would like to ask a native English speaker to look over my text though. Thanks. 2006-11-26 13:48:04 +00:00
Fl_Tiled_Image.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Timer.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Toggle_Button.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Tooltip.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Valuator.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Value_Input.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
Fl_Value_Input.html Adding keyboard shortcut to Fl_Value_Input and Fl_Text_Editor 2008-04-23 14:19:58 +00:00
Fl_Value_Output.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
Fl_Value_Output.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Value_Slider.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_Widget.html Fix HTML errors. 2007-02-09 18:46:32 +00:00
Fl_Window.html STR #1796: fixed documentation for size_range 2007-12-18 10:02:54 +00:00
Fl_Wizard.html Added link in Fl_Wizard documentation (STR #1550) 2007-01-18 12:03:29 +00:00
Fl_XBM_Image.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Fl_XPM_Image.html Documentation fixes. 2006-10-29 14:16:03 +00:00
FL.gif Update copyright in FLUID "about" window. 2002-02-20 13:02:27 +00:00
Fl.html Fixed typos 2008-02-26 15:04:03 +00:00
fltk-config.man STR 1897: fixed man pages for unicode translation 2008-03-16 12:12:55 +00:00
fltk.book Add handler for thread messages (STR #1536) 2007-02-08 23:04:20 +00:00
fltk.man STR 1897: fixed man pages for unicode translation 2008-03-16 12:12:55 +00:00
fluid1.gif Working on the FLUID chapter, to do a new FLTK 1.1.0 beta release... 2002-03-22 22:40:10 +00:00
fluid2.gif Working on the FLUID chapter, to do a new FLTK 1.1.0 beta release... 2002-03-22 22:40:10 +00:00
fluid3-cxx.gif Working on the FLUID chapter, to do a new FLTK 1.1.0 beta release... 2002-03-22 22:40:10 +00:00
fluid3-gui.gif Working on the FLUID chapter, to do a new FLTK 1.1.0 beta release... 2002-03-22 22:40:10 +00:00
fluid3-style.gif Working on the FLUID chapter, to do a new FLTK 1.1.0 beta release... 2002-03-22 22:40:10 +00:00
fluid4.gif Working on the FLUID chapter, to do a new FLTK 1.1.0 beta release... 2002-03-22 22:40:10 +00:00
fluid_prefs.gif Doco updates for 1.1. 2002-03-24 17:26:00 +00:00
fluid_widget_cxx.gif Doco updates for 1.1. 2002-03-24 17:26:00 +00:00
fluid_widget_gui.gif Doco updates for 1.1. 2002-03-24 17:26:00 +00:00
fluid_widget_style.gif Doco updates for 1.1. 2002-03-24 17:26:00 +00:00
fluid-catgets.gif Doco updates for 1.1. 2002-03-24 17:26:00 +00:00
fluid-gettext.gif Doco updates for 1.1. 2002-03-24 17:26:00 +00:00
fluid-org.gif Fixed various typos and added a Fluid organization chart image 1999-01-13 15:35:04 +00:00
fluid.dox doxygen doc updates: 2008-09-13 17:41:00 +00:00
fluid.html Added STR #1859 as a fluid documentation sub chapter 2008-02-25 14:14:52 +00:00
fluid.man STR 1897: fixed man pages for unicode translation 2008-03-16 12:12:55 +00:00
forms.dox Doxygen documentation - WP12 and WP13 - first step. 2008-09-13 15:55:32 +00:00
forms.html Documentation fixes. 2006-10-29 14:16:03 +00:00
functions.html STR 1874: remove fl_create_offscreen_with_alpha which is merely a helper function for built-in image rendering on only a single platform and should not be public. 2008-02-20 17:31:39 +00:00
glut.dox Doxygen documentation - WP12 and WP13 - first step. 2008-09-13 15:55:32 +00:00
glut.html Fix HTML errors. 2007-02-09 18:46:32 +00:00
hello.C.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
index.dox Doxygen documentation - WP12 and WP13 - first step. 2008-09-13 15:55:32 +00:00
index.html First checkin simply updating a few version numbers and copyright dates 2008-03-27 21:38:44 +00:00
input_choice.jpg Added Greg Ercolano's simple Fl_Input_Choice widget which is a 2005-02-24 21:14:22 +00:00
intro.dox Doxygen documentation - WP12 and WP13 - first step. 2008-09-13 15:55:32 +00:00
intro.html Syb=nching the list of mirrors in doc/intro.html and README 2008-03-01 11:08:32 +00:00
license.dox Doxygen documentation - WP12 and WP13 - first step. 2008-09-13 15:55:32 +00:00
license.html Documentation fixes. 2006-10-29 14:16:03 +00:00
Makefile Use install command instead of CHMOD, CP, and MKDIR. 2007-02-06 19:35:28 +00:00
menu_button.gif More image updates, minor typos, etc. 1999-01-14 22:14:01 +00:00
menu.gif Revised documentation files. 1998-12-29 14:21:17 +00:00
menubar.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
migration_1_1.dox Doxygen documentation - WP12 and WP13 - first step. 2008-09-13 15:55:32 +00:00
migration_1_3.dox Doxygen documentation - WP12 and WP13 - first step. 2008-09-13 15:55:32 +00:00
migration.html Replaced '>' with '>' in the documentation where appropriate (STR# 1682, 1684, 1685) 2007-05-17 15:52:15 +00:00
opengl.dox Doxygen documentation - WP12 and WP13 - first step. 2008-09-13 15:55:32 +00:00
opengl.html Documentation fixes. 2006-10-29 14:16:03 +00:00
osissues.dox Doxygen documentation - WP12 and WP13 - first step. 2008-09-13 15:55:32 +00:00
osissues.html Updated Cygwin/Mingw makefiles and documentation (STR #1683) 2007-05-18 19:04:14 +00:00
positioner.gif Revised documentation files. 1998-12-29 14:21:17 +00:00
preface.dox Doxygen documentation - WP12 and WP13 - first step. 2008-09-13 15:55:32 +00:00
preface.html First checkin simply updating a few version numbers and copyright dates 2008-03-27 21:38:44 +00:00
README Configure script changes to support man pages, HTMLDOC, AIX/QNX with 2001-02-12 15:12:14 +00:00
resizebox1.gif Revised documentation files. 1998-12-29 14:21:17 +00:00
resizebox2.gif Revised documentation files. 1998-12-29 14:21:17 +00:00
round_clock.gif Updated screenshots for current release. 1999-01-13 20:12:41 +00:00
scrollbar.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
slider.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
subclassing.dox Doxygen documentation - WP12 and WP13 - first step. 2008-09-13 15:55:32 +00:00
subclassing.html Documentation fixes. 2006-10-29 14:16:03 +00:00
sudoku.man More packaging fun. 2006-01-15 18:36:16 +00:00
symbols.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
tabs.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
text.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
todo_filelist_doc.txt Doxygen Documentation WP6 Done, Also completed the documentation of Help_View, Help_Dialog and cleaned up Preferences from ugly stars in comments and also removed redundant get/set text from methods doc. In this increment, we don't bother with the old dox format (comments in header). We have better things to do with our time (like about 40 mores files to doxyfy :-). 2008-09-14 20:00:03 +00:00
valuators.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
value_slider.gif Update documentation screenshots (still have some to go...) 2001-12-12 21:33:34 +00:00
widgets.html STR 1862: added missing Fl_File_Input in docs 2008-01-30 09:43:49 +00:00

README 

README
------

The documentation in this directory is in HTML format.  To read it just
point your browser at the "index.html" file. A slightly more browseable
version is accessable at the FLTK web site, along with PostScript(tm)
and PDF versions of the manual.

You can generate your own (printable) copy of the manual by typing
"make" in this directory.  You will need to have the HTMLDOC software
installed on your system.  HTMLDOC can be downloaded from:

    http://www.easysw.com/htmldoc

The default media size is 8.27x11.0" (210x279mm), which is the lesser
of A4 and US Letter sizes.  You can change this in the makefile by
uncommenting the corresponding media size or defining your own.

If you find any typos, things that are unclear, or would like to
contribute an example, section, or chapter to the FLTK manual, please
contact Michael Sweet (mike@easysw.com).