Commit Graph

866 Commits

Author SHA1 Message Date
Albrecht Schlosser
864a86b40f Fix doxygen warning
warning: Invalid section id `development_non'; ignoring section
2020-09-18 13:44:25 +02:00
Albrecht Schlosser
0c539b784d Fine tune GitLab-CI script
Also: update documentation copyright year.
2020-09-07 15:00:38 +02:00
Albrecht Schlosser
b65d3a249d Customize corner radius for rounded box/frame (#130)
Make maximum box corner radius and shadow width configurable.
See Fl::box_border_radius_max() and Fl::box_shadow_width().

Documentation: update image of box types.

Fixes #130
2020-09-01 12:35:48 +02:00
Albrecht Schlosser
a0638273c8 Documentation: update clock demo images
One of the images was cut off at the top or bottom.
Added window decoration with title, used a bright blue background.
2020-07-16 14:27:44 +02:00
Albrecht Schlosser
720b84ef9d CMake: refactor and reformat CMake files
- raise minimum CMake version from 2.6.3 to 3.2.3 (Jun 01, 2015)
- indent all CMake files according to the CMP (2 col.)
- refactor FLTK version number definitions and usage
- unify CMake and autoconf/configure variable names:
  - FL_VERSION -> FLTK_VERSION
  - FL_MAJOR_VERSION -> FLTK_VERSION_MAJOR
  - etc. for _MINOR_ and _PATCH_, respectively
  - note: this does not affect FL_VERSION etc. in source code
- generate "export headers" for all libraries (experimental: OFF)
- port some forgotten goodies from branch-1.3 to master
- merge and improve macro 'create_example' (WIP)
- remove "temporary" options and code for older CMake versions
- include and use 'GenerateExportHeader' (experimental, WIP: OFF)
  - note: created header files are not yet used
- build only *one* DLL with Visual Studio (tested, works)
  - similar to the bundled IDE projects in 1.3.x
- add some dynamically linked test/demo programs ('*-shared')
  if shared libraries are built (WIP)
- split 'macros.cmake': use one file per macro
2020-07-15 00:34:53 +02:00
Albrecht Schlosser
58296c373a Fix old URL's and forum/newsgroup names
- fltk.development has been renamed to fltk.coredev
- all FLTK URL's are now of the form https://www.fltk.org/
2020-07-14 15:16:05 +02:00
Duncan Gibson
7038559338 add resize documentation as per STR3433
add resize chapter to documentation, plus images,
based on Article #415: How does resizing work?
https://www.fltk.org/articles.php?L415

see also https://www.fltk.org/str.php?L3433
2020-07-13 23:12:54 +02:00
Albrecht Schlosser
f09e17c3c5 Remove $Id$ tags, update URL's, and more
- remove obsolete svn '$Id$' tags from all source files
- update .fl files and generated files accordingly
- replace 'http://www.fltk.org' URL's with 'https://...'
- replace bug report URL 'str.php' with 'bugs.php'
- remove trailing whitespace
- fix other whitespace errors flagged by Git
- add and/or fix missing or wrong standard headers
- convert tabs to spaces in all source files

The only relevant code changes are in the fluid/ folder where
some .fl files and other source files were used to generate
the '$Id' headers and footers.
2020-07-06 20:28:20 +02:00
Albrecht Schlosser
70ce08e0cb Improve fluid documentation
- remove trailing whitespace
- reformat for better readability
- fix typos
2020-05-08 12:31:26 +02:00
ManoloFLTK
d503f5d392 Fix small typo. 2020-04-05 10:04:24 +02:00
Albrecht Schlosser
09352ddab0 Update documentation, fix typos 2020-03-26 14:21:33 +01:00
ManoloFLTK
89449280dc Doc: more details about initialisation of display scale factors. 2020-03-26 06:29:25 +01:00
ManoloFLTK
812052e458 FLTK doc: Use Unicode character ⌘ (U+2318) in a macOS-specific context. 2020-03-09 13:21:52 +01:00
Albrecht Schlosser
c0b4fed619 Documentation: update cairo_test screenshot 2020-02-05 19:12:58 +01:00
Albrecht Schlosser
d2cb11369c Improve migration docs on Fl_Preferences 2020-01-26 15:11:40 +01:00
Albrecht Schlosser
30a868dc0f Improve Unicode / UTF-8 documentation 2020-01-26 15:10:53 +01:00
Albrecht Schlosser
f3724f7488 [CMake] Remove unnecessary dependency
Building the documentation need not depend on building the library.
This change can speed up changing, building, and viewing modified
docs.
2020-01-26 15:07:15 +01:00
Albrecht Schlosser
3f1f871585 Drop 1.0 compatibility; document 1.4 migration
The FLTK 1.0 compatibility support by defining macro 'FLTK_1_0_COMPAT'
did no longer work since FLTK 1.3.x and nobody complained. Hence we
can safely remove this "feature".

Documentation changes:

 - Drop chapter 'Migrating Code from FLTK 1.0 to 1.1'
 - Drop chapter 'Migrating Code from FLTK 1.1 to 1.3'
 - Add  chapter 'Migrating Code from FLTK 1.3 to 1.4'

The removed chapters are still available in FLTK 1.3 docs.
2020-01-08 18:41:50 +01:00
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