summaryrefslogtreecommitdiff
path: root/FL/Fl_Box.H
diff options
context:
space:
mode:
authorFabien Costantini <fabien@onepost.net>2008-09-15 08:41:54 +0000
committerFabien Costantini <fabien@onepost.net>2008-09-15 08:41:54 +0000
commitb9ca1333769f87c029430a9d14a7a9937d400f93 (patch)
tree61b8043afc286a950b7624004ed549f84531fdb3 /FL/Fl_Box.H
parentfdcfef214e67b0b1162ef4098ba960efd7049523 (diff)
Doxygen documentation WP8 Done. Reserved WP9, WP10. Will now check WP3 from engelsman and integrates it.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6250 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'FL/Fl_Box.H')
-rw-r--r--FL/Fl_Box.H18
1 files changed, 16 insertions, 2 deletions
diff --git a/FL/Fl_Box.H b/FL/Fl_Box.H
index 3f6df7113..b6a1475fd 100644
--- a/FL/Fl_Box.H
+++ b/FL/Fl_Box.H
@@ -32,13 +32,27 @@
#include "Fl_Widget.H"
#endif
+/**
+ This widget simply draws its box, and possibly it's label. Putting it
+ before some other widgets and making it big enough to surround them
+ will let you draw a frame around them.
+*/
class FL_EXPORT Fl_Box : public Fl_Widget {
protected:
void draw();
public:
- Fl_Box(int X, int Y, int W, int H, const char *l=0)
+ /**
+ The first constructor sets box() to FL_NO_BOX, which
+ means it is invisible. However such widgets are useful as placeholders
+ or Fl_Group::resizable()
+ values. To change the box to something visible, use box(n).
+ <P>The second form of the constructor sets the box to the specified box
+ type.
+ */
+ Fl_Box(int X, int Y, int W, int H, const char *l=0)
: Fl_Widget(X,Y,W,H,l) {}
- Fl_Box(Fl_Boxtype b, int X, int Y, int W, int H, const char *l)
+ /** See Fl_Box::Fl_Box(int x, int y, int w, int h, const char * = 0) */
+ Fl_Box(Fl_Boxtype b, int X, int Y, int W, int H, const char *l)
: Fl_Widget(X,Y,W,H,l) {box(b);}
virtual int handle(int);