Commit Graph

56 Commits

Author SHA1 Message Date
Albrecht Schlosser
b2979b6425 Reformat to FLTK style, improve documentation
No code changes.

Replace '#define fl_clip ..' with an inline method.
2021-11-16 00:02:16 +01:00
Albrecht Schlosser
d7af409f42 Remove "Figure x.y: " from html image captions
... as discussed in fltk.coredev for easier maintenance.

Also edit some minor issues.
2021-01-13 22:52:33 +01:00
Albrecht Schlosser
3d53548cfb Documentation: enhance chapter "FLTK Basics"
basics.dox: Some minor edits, clarifications and reordering for
  better readability.

drawing.dox: minor edits, remove "Figure x.y:" etc. (to be continued)

enumerations.dox: change chapter title
2021-01-13 21:15:10 +01:00
Albrecht Schlosser
a03ab3b498 Clarify offscreen drawing documentation
... and rename drawing chapters (sections + subsections) according
to our documentation conventions (prefix "drawing_").

documentation/make_pdf: fix copyright year.
2020-11-08 15:43:34 +01: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
ManoloFLTK
d503f5d392 Fix small typo. 2020-04-05 10:04:24 +02: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
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
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
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
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
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
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
Manolo Gouy
461750c38e X11 platform: Add optional use of the pango library to draw text, gaining 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-12-21 15:05:02 +00:00
Albrecht Schlosser
a633de6461 Doc changes: set fl_font before fl_measure() (STR #3243)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3-porting@11848 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2016-07-24 08:55:02 +00:00
Manolo Gouy
6ea2b8baea More detailed documentation about drawing to other surfaces than the computer display.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10651 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2015-03-24 14:20:38 +00:00
Albrecht Schlosser
1cfefc2e1a Improve and fix image drawing docs.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10603 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2015-03-02 12:39:42 +00:00
Greg Ercolano
a6369a4234 Small mod to fix problem with color chip image not showing up in doxygen docs.
Oddly, leading white space on the two \image commands caused them to appear
as literal text inside a code box, similar to as if they were embedded in a
\code - \endcode block -- not sure why.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10445 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2014-11-10 20:31:42 +00:00
Albrecht Schlosser
267ba82aa5 Fix documentation.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10286 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2014-09-06 23:42:18 +00:00
Manolo Gouy
c44e6122d4 Modified doc following closure of STR#2990.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10125 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2014-04-01 09:12:02 +00:00
Manolo Gouy
2c5b268859 Fix for STR #2947: A couple of minor glitches in the 1.3.2 docs.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9868 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2013-04-09 15:10:25 +00:00
Greg Ercolano
5e2bdbdeef Followup: small color docs mod
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9857 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2013-04-02 16:51:56 +00:00
Greg Ercolano
ba0c61b961 Small color documentation clarification/improvements:
o Added some references to the FLTK colormap diagram in obvious places (Fl_Color docs)
    o Added info regarding the 'reserved' colors
    o Added quotes to clarify RGBI description: "RGB" and "I"



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9856 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2013-04-02 16:47:57 +00:00
Greg Ercolano
b879b0673a Added some descriptions to colors, switched jpg -> png.
(jpeg was 2x larger)


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9524 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2012-05-17 23:34:17 +00:00
Greg Ercolano
7dcf31ff36 Added colormap with index numbers in the legends to the "Colors"
section of the 'Drawing Things in FLTK' section. This should make it easy
to quickly identify the color numbers of the default FLTK colormap entries.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9521 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2012-05-17 22:42:26 +00:00
Greg Ercolano
ebf71d633b Documentation improvements:
o Added fl_text_extents() to the 'Drawing things in FLTK' section
	o Added 'see also' sections to all the text measuring functions in that section
	o Added detail to fl_text_extents() docs regarding it not handling FLTK symbols,
	  as non-public comment for that method indicates.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9463 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2012-05-08 16:15:34 +00:00
Albrecht Schlosser
86e58bc0d8 Fixed "Index" link on documentation pages.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8651 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2011-05-11 15:49:30 +00:00
Albrecht Schlosser
06e17886ed Documentation fixes and a few indent corrections.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8621 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2011-04-23 15:46:30 +00:00
Matthias Melcher
8074cb6f82 A bunch of documentation updates. Not sure if I found everything. The Unicode section needs some love.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8151 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2011-01-01 04:42:56 +00:00
engelsman
efd349ddce updated documentation for color handling - see STR #2226
- added text about color(0xRRGGBBII) call to common.dox and drawing.dox
- added doxygen comments for fl_show_chooser(), including image.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7770 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-10-29 22:14:59 +00:00
engelsman
fc1a878290 reworked color documentation as suggested in STR #2373
part of the confusion was the main page link to
Common Widgets and Attributes/Colors actually went to
Drawing Things in FLTK/Colors therefore making it harder
to find information.

Common Widgets and Attribute/Colors now simplified

Drawing Things in FLTK/Colors now expanded

FLTK Enumerations/Colors now simplified



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7762 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-10-27 22:07:55 +00:00
Manolo Gouy
5c55379301 Added Doxygen doc to offscreen drawing functions.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7720 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-10-12 12:34:19 +00:00
Albrecht Schlosser
06f5899980 Fix for documentation typos provided by Josef Vitu. Thanks.
Added Josef Vitu to CREDITS.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6946 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-11-29 11:14:42 +00:00
engelsman
7f18e1002f simplified old HTML anchors with name= and href= in all *.dox files.
removed "old html link" section from development.dox



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6799 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-06-27 20:40:48 +00:00
engelsman
8bb63644d2 converted more html tags to doxygen commands in drawing.dox
most of the function names used as indented paragraph titles
are now recognised properly and are shown as links. However,
I was forced to "downgrade" many function() references in the
text so that the unwary user isn't unexpectedly teleported off
the tutorial pages. It reduces the link spaghetti a lot,

tweaked Enumerations.H and fl_draw.cxx to get doxygen to recognise
more function names used in drawing.dox. only fl_scroll(...)
and the offscreen drawing functions still needed for drawing.dox



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6735 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-04-01 22:11:57 +00:00
engelsman
12318a5d25 started changing html href calls to doxygen \ref commands
in basics.dox, common.dox and drawing.dox, and other cleaning up



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6729 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-30 20:41:22 +00:00
engelsman
76e418dccd converted page footer navigation bars to three-cell tables in all *.dox
also relaxed table widths in intro.dox to use 100% instead of 700 pixels
to fit with doxygen header rule and new footer navigation bars



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6724 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-26 22:58:23 +00:00
engelsman
c95505b462 removed numbering from doxygen chapters and navigation bars,
moved class/function reference pages to end of index table,
swapped editor/drawing chapters in Doxybook for PDF version



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6721 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-25 23:12:48 +00:00
Fabien Costantini
15489bda1b Major documentation update including: now html doc API is sorted, navigation problems/side effects fixed, html tags replaced by proper doxygen commands, parameters command switched from a to p. Includes a pdf update.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6716 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-24 01:40:44 +00:00
engelsman
4bcf3e5311 added doxygen comments for more functions in fl_draw.H
FL/fl_draw.H: see below
src/fl_cursor.cxx: fl_cursor()
src/fl_scroll_area.cxx: fl_scroll()
src/fl_overlay.cxx: fl_overlay_clear(), fl_overlay_rect()
documentation/src/drawing.dox: updated paragraph tag links



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6690 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-15 20:52:46 +00:00