summaryrefslogtreecommitdiff
path: root/FL
diff options
context:
space:
mode:
authorKevin Routley <lifeattickville@gmail.com>2022-02-21 10:42:08 -0500
committerGitHub <noreply@github.com>2022-02-21 16:42:08 +0100
commit2de8f8579cdaa66c930381bcc2e894ff8cbece69 (patch)
tree1b629f06705430ad8302dbd2e786116823fac40d /FL
parent72fe8c6035efa7c35ea824005ba65df05cca3037 (diff)
DOC: Provide a link to the "FLTK Standard Box Types" image (#397)
* Provide a link to the "FLTK standard box types" image The doc for Box Types has the text "see figure 1" which does not exist! [It is figure 5.3 in PDF, no number in HTML]. This change provides a hyperlink which allows the reader to actually navigate to the cited figure. Confirmed to work as desired in HTML; I don't have LATEX so cannot confirm the PDF. * Add figure title "Standard Box Types" (#397) Co-authored-by: Albrecht Schlosser <albrechts.fltk@online.de>
Diffstat (limited to 'FL')
-rw-r--r--FL/Enumerations.H57
1 files changed, 29 insertions, 28 deletions
diff --git a/FL/Enumerations.H b/FL/Enumerations.H
index 91a3d559e..b9e5e0cbb 100644
--- a/FL/Enumerations.H
+++ b/FL/Enumerations.H
@@ -573,6 +573,7 @@ enum Fl_When { // Fl_Widget::when():
leaving the interior unchanged. The blue color in the image below
is the area that is not drawn by the frame types.
+ \anchor boxTypesImage
\image html boxtypes.png "FLTK Standard Box Types"
\image latex boxtypes.png "FLTK Standard Box Types" width=12cm
@@ -598,34 +599,34 @@ enum Fl_Boxtype { // boxtypes (if you change these you must also change fl_boxty
FL_NO_BOX = 0, ///< nothing is drawn at all, this box is invisible
FL_FLAT_BOX, ///< a flat box
- FL_UP_BOX, ///< see figure 1
- FL_DOWN_BOX, ///< see figure 1
- FL_UP_FRAME, ///< see figure 1
- FL_DOWN_FRAME, ///< see figure 1
- FL_THIN_UP_BOX, ///< see figure 1
- FL_THIN_DOWN_BOX, ///< see figure 1
- FL_THIN_UP_FRAME, ///< see figure 1
- FL_THIN_DOWN_FRAME, ///< see figure 1
- FL_ENGRAVED_BOX, ///< see figure 1
- FL_EMBOSSED_BOX, ///< see figure 1
- FL_ENGRAVED_FRAME, ///< see figure 1
- FL_EMBOSSED_FRAME, ///< see figure 1
- FL_BORDER_BOX, ///< see figure 1
- _FL_SHADOW_BOX, ///< see figure 1, use FL_SHADOW_BOX
- FL_BORDER_FRAME, ///< see figure 1
- _FL_SHADOW_FRAME, ///< see figure 1, use FL_SHADOW_FRAME
- _FL_ROUNDED_BOX, ///< see figure 1, use FL_ROUNDED_BOX
- _FL_RSHADOW_BOX, ///< see figure 1, use FL_RSHADOW_BOX
- _FL_ROUNDED_FRAME, ///< see figure 1, use FL_ROUNDED_FRAME
- _FL_RFLAT_BOX, ///< see figure 1, use FL_RFLAT_BOX
- _FL_ROUND_UP_BOX, ///< see figure 1, use FL_ROUND_UP_BOX
- _FL_ROUND_DOWN_BOX, ///< see figure 1, use FL_ROUND_DOWN_BOX
- _FL_DIAMOND_UP_BOX, ///< see figure 1, use FL_DIAMOND_UP_BOX
- _FL_DIAMOND_DOWN_BOX, ///< see figure 1, use FL_DIAMOND_DOWN_BOX
- _FL_OVAL_BOX, ///< see figure 1, use FL_OVAL_BOX
- _FL_OSHADOW_BOX, ///< see figure 1, use FL_OSHADOW_BOX
- _FL_OVAL_FRAME, ///< see figure 1, use FL_OVAL_FRAME
- _FL_OFLAT_BOX, ///< see figure 1, use FL_OFLAT_BOX
+ FL_UP_BOX, ///< see figure [Standard Box Types](@ref boxTypesImage)
+ FL_DOWN_BOX, ///< see figure [Standard Box Types](@ref boxTypesImage)
+ FL_UP_FRAME, ///< see figure [Standard Box Types](@ref boxTypesImage)
+ FL_DOWN_FRAME, ///< see figure [Standard Box Types](@ref boxTypesImage)
+ FL_THIN_UP_BOX, ///< see figure [Standard Box Types](@ref boxTypesImage)
+ FL_THIN_DOWN_BOX, ///< see figure [Standard Box Types](@ref boxTypesImage)
+ FL_THIN_UP_FRAME, ///< see figure [Standard Box Types](@ref boxTypesImage)
+ FL_THIN_DOWN_FRAME, ///< see figure [Standard Box Types](@ref boxTypesImage)
+ FL_ENGRAVED_BOX, ///< see figure [Standard Box Types](@ref boxTypesImage)
+ FL_EMBOSSED_BOX, ///< see figure [Standard Box Types](@ref boxTypesImage)
+ FL_ENGRAVED_FRAME, ///< see figure [Standard Box Types](@ref boxTypesImage)
+ FL_EMBOSSED_FRAME, ///< see figure [Standard Box Types](@ref boxTypesImage)
+ FL_BORDER_BOX, ///< see figure [Standard Box Types](@ref boxTypesImage)
+ _FL_SHADOW_BOX, ///< see figure [Standard Box Types](@ref boxTypesImage), use FL_SHADOW_BOX
+ FL_BORDER_FRAME, ///< see figure [Standard Box Types](@ref boxTypesImage)
+ _FL_SHADOW_FRAME, ///< see figure [Standard Box Types](@ref boxTypesImage), use FL_SHADOW_FRAME
+ _FL_ROUNDED_BOX, ///< see figure [Standard Box Types](@ref boxTypesImage), use FL_ROUNDED_BOX
+ _FL_RSHADOW_BOX, ///< see figure [Standard Box Types](@ref boxTypesImage), use FL_RSHADOW_BOX
+ _FL_ROUNDED_FRAME, ///< see figure [Standard Box Types](@ref boxTypesImage), use FL_ROUNDED_FRAME
+ _FL_RFLAT_BOX, ///< see figure [Standard Box Types](@ref boxTypesImage), use FL_RFLAT_BOX
+ _FL_ROUND_UP_BOX, ///< see figure [Standard Box Types](@ref boxTypesImage), use FL_ROUND_UP_BOX
+ _FL_ROUND_DOWN_BOX, ///< see figure [Standard Box Types](@ref boxTypesImage), use FL_ROUND_DOWN_BOX
+ _FL_DIAMOND_UP_BOX, ///< see figure [Standard Box Types](@ref boxTypesImage), use FL_DIAMOND_UP_BOX
+ _FL_DIAMOND_DOWN_BOX, ///< see figure [Standard Box Types](@ref boxTypesImage), use FL_DIAMOND_DOWN_BOX
+ _FL_OVAL_BOX, ///< see figure [Standard Box Types](@ref boxTypesImage), use FL_OVAL_BOX
+ _FL_OSHADOW_BOX, ///< see figure [Standard Box Types](@ref boxTypesImage), use FL_OSHADOW_BOX
+ _FL_OVAL_FRAME, ///< see figure [Standard Box Types](@ref boxTypesImage), use FL_OVAL_FRAME
+ _FL_OFLAT_BOX, ///< see figure [Standard Box Types](@ref boxTypesImage), use FL_OFLAT_BOX
_FL_PLASTIC_UP_BOX, ///< plastic version of FL_UP_BOX, use FL_PLASTIC_UP_BOX
_FL_PLASTIC_DOWN_BOX, ///< plastic version of FL_DOWN_BOX, use FL_PLASTIC_DOWN_BOX
_FL_PLASTIC_UP_FRAME, ///< plastic version of FL_UP_FRAME, use FL_PLASTIC_UP_FRAME