Commit Graph

848 Commits

Author SHA1 Message Date
ManoloFLTK ffcf8bd0b7 Documentation: make clear that "Using OpenGL in Normal FLTK Windows" isn't useful with macOS. 2019-10-27 08:37:33 +01:00
Albrecht Schlosser bce85d9511 CMake: copy 'tiny.png' to doc folder
The image 'tiny.png' was not copied to the documentation/html
directory when docs were built with CMake.
2019-09-16 17:17:54 +02:00
Greg Ercolano 9e4c207e27 Added example images for Fl_[Hold/Multi]_Browser 2019-07-26 13:32:18 -07:00
Greg Ercolano bca3ae0b17 Added example for mac Application -> Preferences 2019-06-06 11:09:29 -07:00
Albrecht Schlosser 31093d0a14 Replace fl_ask() with fl_choice() in FAQ
fl_ask() is deprecated and should be replaced with fl_choice().
2019-05-15 18:02:01 +02:00
Albrecht Schlosser c4a755bdf8 Fix some links in documentation
Particularly to Doxygen docs and NEdit which appears to have moved
to sourceforge (according to Wikipedia), see
https://en.wikipedia.org/wiki/NEdit

Note: nedit.org exists but shows some non-English text.
2019-05-15 17:16:11 +02:00
ManoloFLTK 0f6cbd1cda Doxygen: rewording for more clarity. 2019-04-14 09:27:41 +02:00
ManoloFLTK f55729ed32 Doxygen: describe better support for OpenGL on HighDPI displays. 2019-04-12 18:47:42 +02:00
ManoloFLTK 63b86bd8f7 Revert back to previous state 2019-04-04 18:51:16 +02:00
ManoloFLTK 9b7f020ed3 Update procedure for OpenGL3 support. 2019-04-04 18:42:45 +02:00
ManoloFLTK 099b16d69d Document new and modified configure options. 2019-02-11 16:18:14 +01:00
Albrecht Schlosser 79af685c28 Fix typos 2019-02-09 21:21:48 +01:00
Matthias Melcher b663ce85e0 Improved decumentation for '@' symbols in labels (STR #2940). 2019-02-04 23:32:37 +01:00
Matthias Melcher d6294ac2fc Reorganized Fluid Template feature (STR #3336). 2019-02-01 23:16:49 +01:00
Matthias Melcher af8e406f88 Updated Fluid documentation and image (STR #3328). 2019-02-01 21:59:07 +01:00
Albrecht Schlosser de199c327e Add a CMake option to generate driver (developer) documentation.
Generating driver documentation can now be configured with CMake. The new
configuration OPTION_INCLUDE_DRIVER_DOCUMENTATION is "marked as advanced"
since only advanced users and/or FLTK developers need this.

Previously this could only be achieved by editing documentation/Doxyfile.in.

Added missing documentation option descriptions as well.
2018-12-29 20:35:10 +01:00
Albrecht Schlosser 7458281545 Rename README files to README.txt (and several similar files).
Files without '.txt' suffix can't be handled well by Windows (users),
hence renaming such text files to *.txt makes FLTK more "Windows-friendly".

There are a few exceptions (this is intentional): README and other files
in bundled libraries (maintained upstream) are not changed.
2018-12-10 16:50:56 +01:00
Manolo Gouy 4881b982a3 Documentation: replace several instances of "pixels" by "FLTK units" to account for screen rescaling.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@13135 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-11-27 09:57:45 +00:00
Manolo Gouy 153b175d90 Better doc for using OpenGL version 3.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@13023 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-08-21 07:45:32 +00:00
Manolo Gouy a3529e7c3f Improved documentation related to access to OpenGL 3 under X11 platform.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@13022 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-08-20 15:56:39 +00:00
Albrecht Schlosser fb0f940c51 Update doxygen files to fix broken PDF generation.
Note: PDF generation "worked" with the previous configuration up to
doxygen 1.8.6 on my "old" Ubuntu 14.04 system but did no longer work
with doxygen 1.8.7 - 1.8.13 (the latter on Ubuntu 18.04).

Tests showed that 1.8.14 is seriously broken and git:master (aka 1.8.15,
but not yet released as of today) is not usable as well. Hopefully there
will be some doxygen fixes in the future.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@13010 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-08-07 09:01:32 +00:00
Matthias Melcher a9fd08ff5a Doxygen: created Group to document drivers, disabled by default
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-06-23 16:47:40 +00:00
Greg Ercolano b721f519ac Added separate diagram for fl_arc(x,y,r,a1,a2) (very different from 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-24 19:48:41 +00:00
Greg Ercolano a4ff075c29 Added a diagram to clarify how fl_pie() and fl_arc() works.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12933 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-05-24 17:30:49 +00:00
Manolo Gouy ce71c4b679 Add Fl::screen_scale(int) function to get the scaling factor value of a screen.
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-22 17:00:27 +00:00
Manolo Gouy 8b7f7c78b2 Remove public member function Fl_Window_Driver *Fl_Window::driver() so class 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-12 09:36:36 +00:00
Manolo Gouy 1d8edbead1 Fix typo.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12913 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-05-11 06:25:35 +00:00
Manolo Gouy 4ede9cec29 New Fl_Image_Surface::rescale() class function and document equivalence 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-07 13:43:28 +00:00
Manolo Gouy d2355dd53b Documentation: in the programming manual, mention new class Fl_SVG_Image and member function Fl_Image::scale()?
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12906 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-05-07 10:24:19 +00:00
Greg Ercolano 8c32c708a9 Clarified the fl_choice ordering in first example with an image and arrows,
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-18 18:28:46 +00:00
Greg Ercolano 6ada360174 Docs for fl_choice() clarify argument order, added missing image for one of the examples.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12847 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-04-18 09:52:00 +00:00
Albrecht Schlosser 4a0c13ac34 Update 'examples' (test) documentation, add images.
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-04-12 19:56:34 +00:00
Manolo Gouy 0e765c6cd8 Documentation: explain how images are best handled in the context of GUI rescaling.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12798 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-03-25 06:15:50 +00:00
Albrecht Schlosser 6dbe7ca8ed Fix a doxygen warning, update copyright.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12773 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-03-18 15:25:08 +00:00
Manolo Gouy d8d04bf772 Documentation: homogenize to 'scale factor' and 'drawing unit'
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12737 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-03-11 14:49:09 +00:00
Manolo Gouy a45afd2b99 Documentation: homogenize the use of "screen" rather than "display" and "FLTK units".
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12735 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-03-11 08:09:50 +00:00
Manolo Gouy 329f43eaf7 Documentation: describe the new GUI scaling feature of FLTK 1.4
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12731 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-03-10 17:29:25 +00:00
Manolo Gouy a0863e393a Document that fl_mac_set_about() is deprecated, MacOS-specific and replaced 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-22 17:04:37 +00:00
Manolo Gouy 06b925964d Remove Fl::run_also_windowless() and FL::wait_also_windowless() from planned 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-20 09:08:38 +00:00
Manolo Gouy 3ca12a3a02 Document platform-dependent types fl_intptr_t and fl_uintptr_t
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-11 18:25:11 +00:00
Albrecht Schlosser 52ae3582a2 Replace "WIN32" with "_WIN32" or "Windows".
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-09 14:39:42 +00:00
Manolo Gouy 90630409cb Beef up documentation of how FLTK handles cmd-Q/Quit xxx events under MacOS.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12648 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2018-02-06 17:56:47 +00:00
Albrecht Schlosser cc595ce4ed Replace FL/x.H with FL/platform.H - step 1.
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-31 17:46:48 +00:00
Albrecht Schlosser 18d9891970 Add missing CMake variable FL_VERSION for doxygen docs generation.
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-16 23:45:45 +00:00
Albrecht Schlosser 6408823b3c Remove obsolete replacement of CMAKE_SOURCE_DIR.
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-16 23:37:14 +00:00
Ian MacArthur 98413277a8 Implement Jakub's patch for the missing FLTK_SOURCE_DIR in
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-16 22:17:58 +00:00
Albrecht Schlosser 7aef0cad39 CMake: enable building FLTK in a subdirectory of another project.
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
2018-01-10 20:49:03 +00:00
Manolo Gouy f609261697 Remove Fl_Sys_Menu_Bar.mm from list of input files
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12577 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2017-12-03 14:34:47 +00:00
Albrecht Schlosser c348189008 Fix doxygen docs: missing excludes and CMake paths.
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-11-05 19:56:41 +00:00
Manolo Gouy 84aba46e8a Refer to the preferred Fl_Surface_Device::push_current()/pop_current() functions.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12524 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2017-10-23 16:09:26 +00:00