summaryrefslogtreecommitdiff
path: root/documentation
AgeCommit message (Collapse)Author
2018-06-23Doxygen: created Group to document drivers, disabled by defaultMatthias Melcher
Uncomment `ENABLED_SECTIONS += DriverDev` in documentation/Doxyfile.in to enable driver documentation. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12968 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-05-24Added separate diagram for fl_arc(x,y,r,a1,a2) (very different from ↵Greg Ercolano
fl_arc(x,y,w,h,a1,a2)) git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12935 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-05-24Added a diagram to clarify how fl_pie() and fl_arc() works.Greg Ercolano
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12933 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-05-22Add Fl::screen_scale(int) function to get the scaling factor value of a screen.Manolo Gouy
This allows to keep class Fl_Screen_Driver away from the public API. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12926 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-05-12Remove public member function Fl_Window_Driver *Fl_Window::driver() so class ↵Manolo Gouy
Fl_Window_Driver is not in FLTK public API. This function is replaced by static Fl_Window_Driver* Fl_Window_Driver::(const Fl_Window *win). The purpose is to have class Fl_Window_Driver outside from FLTK ABI. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12915 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-05-11Fix typo.Manolo Gouy
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12913 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-05-07New Fl_Image_Surface::rescale() class function and document equivalence ↵Manolo Gouy
between Fl_Offscreen-based and Fl_Image_Surface-based approaches. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12907 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-05-07Documentation: in the programming manual, mention new class Fl_SVG_Image and ↵Manolo Gouy
member function Fl_Image::scale()? git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12906 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-04-18Clarified the fl_choice ordering in first example with an image and arrows,Greg Ercolano
as it's not clear in the text how the code order is reversed on-screen. Also, the whole 'three musketeers' thing with the case values not matching the numeric button names has always been confusing: case 0: .. // One case 1: .. // Two (default) case 2: .. // Three Changed that so it's a Zero/One/Two example instead. case 0: .. // "Zero" case 1: .. // "One" (default) case 2: .. // "Two" git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12853 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-04-18Docs for fl_choice() clarify argument order, added missing image for one of ↵Greg Ercolano
the examples. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12847 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-04-12Update 'examples' (test) documentation, add images.Albrecht Schlosser
Add missing documentation of demo programs in the 'test' directory. Some images were added as well. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12831 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-03-25Documentation: explain how images are best handled in the context of GUI ↵Manolo Gouy
rescaling. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12798 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-03-18Fix a doxygen warning, update copyright.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12773 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-03-11Documentation: homogenize to 'scale factor' and 'drawing unit'Manolo Gouy
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12737 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-03-11Documentation: homogenize the use of "screen" rather than "display" and ↵Manolo Gouy
"FLTK units". git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12735 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-03-10Documentation: describe the new GUI scaling feature of FLTK 1.4Manolo Gouy
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12731 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-02-22Document that fl_mac_set_about() is deprecated, MacOS-specific and replaced ↵Manolo Gouy
by cross-platform Fl_Sys_Menu_Bar::about(). git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12685 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-02-20Remove Fl::run_also_windowless() and FL::wait_also_windowless() from planned ↵Manolo Gouy
public FLTK 1.4 API. These were introduced at r12647, that is, during development of the 1.4 API. These functions provided windowless support only on the MacOS platform, where this can be obtained without those functions. Windowless support on other platforms would require changing the event loop. There's no evidence from STR's there's a demand for windowless mode on other platforms. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12680 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-02-11Document platform-dependent types fl_intptr_t and fl_uintptr_tManolo Gouy
Most other platform-dependent types of FL/platform_types.h are also documented. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12663 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-02-09Replace "WIN32" with "_WIN32" or "Windows".Albrecht Schlosser
Replace compiler/preprocessor/platform macro "WIN32" with "_WIN32". Replace "WIN32" in text and documentation with "Windows". Replace "MSWindows" with "Windows". To do: README.Windows.txt (and maybe other documentation as well) needs updates. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12655 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-02-06Beef up documentation of how FLTK handles cmd-Q/Quit xxx events under MacOS.Manolo Gouy
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12648 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-01-31Replace FL/x.H with FL/platform.H - step 1.Albrecht Schlosser
This first step replaces FL/x.H with FL/platform.H but keeps a small FL/x.H that #include's FL/platform.H for backwards compatibility. Documentation sources in documentation/src/*.dox have been fixed, but references in other source files need to be fixed in another step. Dependencies have been adjusted. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12640 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-01-16Add missing CMake variable FL_VERSION for doxygen docs generation.Albrecht Schlosser
Thanks to Jakub Tata-Tyczyński for finding this and reporting it in fltk.coredev. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12638 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-01-16Remove obsolete replacement of CMAKE_SOURCE_DIR.Albrecht Schlosser
The correct fix in the previous commit (svn r12636) would have been to replace CMAKE_SOURCE_DIR with FLTK_SOURCE_DIR since CMAKE_SOURCE_DIR is no longer used in doxygen docs generation. Sorry for the noise. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12637 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-01-16Implement Jakub's patch for the missing FLTK_SOURCE_DIR inIan MacArthur
the doxyfile generation of the html docs. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12636 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-01-10CMake: enable building FLTK in a subdirectory of another project.Albrecht Schlosser
Basically replace CMAKE_XXX_DIR with CMAKE_CURRENT_XXX_DIR where XXX = SOURCE or BINARY. Patch proposal by cleanrock, FLTK PR #4: https://github.com/fltk/test-only/pull/4 Patch modified to fix target dirs for test programs and doxygen docs. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12630 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2017-12-03Remove Fl_Sys_Menu_Bar.mm from list of input filesManolo Gouy
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12577 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2017-11-05Fix doxygen docs: missing excludes and CMake paths.Albrecht Schlosser
This commit fixes two issues: Doxygen build with CMake needs paths relative to CMake source dir. Missing excluded files taken from STR #3320, file #42 (by Manolo): http://www.fltk.org/strfiles/3320/scaling_rect_r12544.patch git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12545 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2017-10-23Refer to the preferred Fl_Surface_Device::push_current()/pop_current() ↵Manolo Gouy
functions. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12524 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2017-10-17Added Fl_Simple_Terminal widget, and mods to test+example programs (STR #3411).Greg Ercolano
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12506 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2017-09-12Demo image for Fl_Multi_Label docs.Greg Ercolano
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12453 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2017-09-12Documentation and copyright updates.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12450 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2017-08-18Documentation: remove unnecessary item from TODO list.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12389 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2017-07-22Update list of files excluded from documentation.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12346 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2017-04-02Fix doxygen/latex warning.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12214 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2017-03-17OpenGL documentation fixes (included header files).Albrecht Schlosser
Also reformatted very long lines, removed trailing spaces. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12204 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2017-02-19Fix typoManolo Gouy
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12174 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2017-02-08Rename test/help demo program to test/help_dialog.Albrecht Schlosser
This change avoids a name conflict with CMake's auto-generated target 'help' for "Unix Makefiles", "Ninja", and supposedly other generators as well. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12171 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2016-12-21X11 platform: Add optional use of the pango library to draw text, gaining ↵Manolo Gouy
the possibility to draw text in any script supported by Unicode. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12153 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2016-10-16Documentation updates.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3-porting@12033 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2016-09-12Make clear that clipboard and drag-n-drop textual data are UTF-8 encoded.Manolo Gouy
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3-porting@11934 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2016-07-24Doc changes: set fl_font before fl_measure() (STR #3243)Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3-porting@11848 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2016-07-22Bringing over fix [r11842] from 1.3 current to the porting branch.Greg Ercolano
Fixes to fl_choice() docs, added screenshots. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3-porting@11843 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2016-07-20Bringing over fix [r11835] from 1.3 current to the porting branch.Greg Ercolano
Improved fluid-org.png diagram. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3-porting@11836 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2016-07-20Bringing over fix [r11833] from 1.3 current to the porting branch.Greg Ercolano
Added updated settings dialog screenshots to the fluid docs. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3-porting@11834 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2016-07-20Bringing over fix [r11758] from 1.3 current to the porting branch.Greg Ercolano
(Enumerations.H had already been updated, but the enumerations.dox had not) Added references to the virtual colorcube. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3-porting@11828 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2016-07-19Bringing over this fix [r11798] from 1.3 current to the porting branch.Greg Ercolano
Small doc improvements/elaborations. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3-porting@11824 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2016-06-22Change copyright yearManolo Gouy
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3-porting@11792 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2016-05-25Generate Doxygen docs with the highest possible ABI version.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3-porting@11755 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2016-05-08Doxygen: put all driver classes in EXCLUDE_SYMBOLSManolo Gouy
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3-porting@11724 ea41ed52-d2ee-0310-a9c1-e6b18d33e121