FLTK 1.3.0
Fl_Box Class Reference

This widget simply draws its box, and possibly its label. More...

#include <Fl_Box.H>

Inheritance diagram for Fl_Box:
Fl_Widget

List of all members.

Public Member Functions

 Fl_Box (int X, int Y, int W, int H, const char *l=0)
 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)
virtual int handle (int)
 Handles the specified event.

Protected Member Functions

void draw ()
 Draws the widget.

Detailed Description

This widget simply draws its box, and possibly its label.

Putting it before some other widgets and making it big enough to surround them will let you draw a frame around them.


Constructor & Destructor Documentation

Fl_Box::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).
  • The second form of the constructor sets the box to the specified box type.

The destructor removes the box.


Member Function Documentation

void Fl_Box::draw ( ) [protected, virtual]

Draws the widget.

Never call this function directly. FLTK will schedule redrawing whenever needed. If your widget must be redrawn as soon as possible, call redraw() instead.

Override this function to draw your own widgets.

If you ever need to call another widget's draw method from within your own draw() method, e.g. for an embedded scrollbar, you can do it (because draw() is virtual) like this:

        Fl_Widget *s = &scroll;         // scroll is an embedded Fl_Scrollbar
        s->draw();                      // calls Fl_Scrollbar::draw()

Implements Fl_Widget.

int Fl_Box::handle ( int  event) [virtual]

Handles the specified event.

You normally don't call this method directly, but instead let FLTK do it when the user interacts with the widget.

When implemented in a widget, this function must return 0 if the widget does not use the event or 1 otherwise.

Most of the time, you want to call the inherited handle() method in your overridden method so that you don't short-circuit events that you don't handle. In this last case you should return the callee retval.

Parameters:
[in]eventthe kind of event received
Return values:
0if the event was not used or understood
1if the event was used and can be deleted
See also:
Fl_Event

Reimplemented from Fl_Widget.


The documentation for this class was generated from the following files: