summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlbrecht Schlosser <albrechts.fltk@online.de>2022-07-14 20:05:21 +0200
committerAlbrecht Schlosser <albrechts.fltk@online.de>2022-07-14 20:05:21 +0200
commitd73327e18167f00aca8e6a8b62fd6105139914d8 (patch)
treef38cd81bd33ec42770415b40147b1621b03f9c39
parent2327ede74c99a1054d81c72d1b40397f36ed1205 (diff)
Document that Fl_Help_View can't be used with FL_NO_BOX
This widget overrides FL_NO_BOX internally by FL_UP_BOX for all practical purposes, e.g. draw(). This has been this way since its initial release and can't be changed.
-rw-r--r--FL/Fl_Help_View.H4
1 files changed, 4 insertions, 0 deletions
diff --git a/FL/Fl_Help_View.H b/FL/Fl_Help_View.H
index 4df878bf3..32e993aec 100644
--- a/FL/Fl_Help_View.H
+++ b/FL/Fl_Help_View.H
@@ -190,6 +190,10 @@ struct Fl_Help_Target {
- Yacute yacute
- yen Yuml yuml
+ \note You can't effectively set the box() to FL_NO_BOX, this would result
+ in FL_DOWN_BOX being used as the boxtype of the widget. This is unexpected
+ but can't be changed for backwards compatibility. If you don't want a frame
+ around the widget you can use FL_FLAT_BOX instead.
*/
class FL_EXPORT Fl_Help_View : public Fl_Group { // Help viewer widget