fltk/documentation at d90b170c8da99402619b4fcc091aeef66a29b691 - fltk

History

Greg Ercolano f58cd169c0 Various mods for Fl_Tree o Fix STR#2828 (E): {Vertical\|Widget} Gap o Moved Fabien's reselected methods to Fl_Tree_Prefs, return method made const, doxygen, removed underbars from methods (to follow general API) o Widgets can now appear to the right of labels. This can be controlled with item_draw_mode(FL_TREE_ITEM_DRAW_LABEL_AND_WIDGET) o Cleaned up Fl_Tree_Item::draw(), Fl_Tree::draw() o New methods: marginbottom() -- [ABI feature] extra space below last tree element when scrolling widgetmarginleft() -- [ABI feature] space to left of widget usericonmarginleft() -- space to left of usericon labelmarginleft() -- space to left of label item_draw_mode() -- control how items, widget() are drawn o Updated Fl_Tree docs, tree-elements.png o test/tree: added sliders to test the above new features, added "open all" and "close all" buttons o Probably other stuff.. TODO: Fix "scroll-beyond-bottom" (STR#2796) TODO: Fix other items in STR#2828 git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9377 ea41ed52-d2ee-0310-a9c1-e6b18d33e121		2012-04-22 13:40:02 +00:00
..
src	Various mods for Fl_Tree	2012-04-22 13:40:02 +00:00
Doxybook	Introducing a FAQ to the FLTK docs.	2011-10-25 02:17:29 +00:00
Doxyfile	Fix so that function Fl::cairo_make_current() is properly documented	2012-02-21 13:36:07 +00:00
Makefile	Introducing a FAQ to the FLTK docs.	2011-10-25 02:17:29 +00:00
README	Updated documentation/README to reflect the new distribution of	2011-01-11 13:06:15 +00:00
strip_tags	Updated documentation/strip_tags for usage of doxygen 1.7.3.	2011-02-27 14:48:20 +00:00

README

README (documentation)
----------------------
FLTK 1.3 documentation is available in HTML and PDF format. The
documentation must be generated in a separate step or downloaded
from FLTK's software download pages. The documentation can also
be accessed online.

To read the docs after downloading or generating them, open the
files:

    documentation/html/index.html
    documentation/fltk.pdf

with your browser or PDF viewer, respectively.


Online Documentation:
---------------------
A documentation version is available online at the FLTK web site,
along with the PDF version of the manual. The docs on the web site
are usually somewhat older (latest release). Use this URL to find
the current online documentation:

    http://www.fltk.org/documentation.php

    
Documentation Download:
-----------------------
To download pre-generated docs, go to

    http://www.fltk.org/software.php

and look for the files

    fltk-<version>-docs-html.tar.gz
    fltk-<version>-docs-pdf.tar.gz

Extract the documentation tarballs into the same directory as you
did with the source tarball.


Generation of Documentation:
----------------------------
To generate the documentation yourself, you should have Doxygen
version 1.5.7 or later (recommended version is 1.7.3).

To generate the PDF version you also need a current version of LaTeX.
You can use the packages tetex (older) or texlive (current) if your
distribution provides them. You may need to install additional fonts
and other sub-packages for the PDF version to be generated correctly.

Use "make html" in the documentation directory to generate the HTML
documentation, or "make pdf" to generate the PDF version. "make dist"
generates both versions in one step (as would do "make clean html pdf").

To read the HTML or PDF docs, see above.


FLTK Developer Snapshots or Subversion Usage:
---------------------------------------------
There is no pre-generated documentation available if you use a current
developer snapshot or subversion. You must generate the documentation
yourself.


Bugs and Feature Requests:
--------------------------
If you find any typos, things that are unclear, or would like to
contribute an example, section, or chapter to the FLTK manual, please
post a question in the fltk newsgroup fltk.general or post a bug
report or feature request at:

    http://www.fltk.org/str.php