blob: 4ff3ae442404b0a85c904ed654531203fcaed7b3 [file] [log] [blame]
DRC2ff39b82011-07-28 08:38:59 +00001//
2// "$Id: Fl_Pack.H 7903 2010-11-28 21:06:39Z matt $"
3//
4// Pack header file for the Fast Light Tool Kit (FLTK).
5//
6// Copyright 1998-2010 by Bill Spitzak and others.
7//
8// This library is free software; you can redistribute it and/or
9// modify it under the terms of the GNU Library General Public
10// License as published by the Free Software Foundation; either
11// version 2 of the License, or (at your option) any later version.
12//
13// This library is distributed in the hope that it will be useful,
14// but WITHOUT ANY WARRANTY; without even the implied warranty of
15// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16// Library General Public License for more details.
17//
18// You should have received a copy of the GNU Library General Public
19// License along with this library; if not, write to the Free Software
20// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
21// USA.
22//
23// Please report all bugs and problems on the following page:
24//
25// http://www.fltk.org/str.php
26//
27
28/* \file
29 Fl_Pack widget . */
30
31#ifndef Fl_Pack_H
32#define Fl_Pack_H
33
34#include <FL/Fl_Group.H>
35
36/**
37 This widget was designed to add the functionality of compressing and
38 aligning widgets.
39 <P>If type() is Fl_Pack::HORIZONTAL all the children are
40 resized to the height of the Fl_Pack, and are moved next to
41 each other horizontally. If type() is not Fl_Pack::HORIZONTAL
42 then the children are resized to the width and are stacked below each
43 other. Then the Fl_Pack resizes itself to surround the child
44 widgets.
45 <P>This widget is needed for the Fl_Tabs.
46 In addition you may want to put the Fl_Pack inside an
47 Fl_Scroll.
48
49 <P>The resizable for Fl_Pack is set to NULL by default.</p>
50 <P>See also: Fl_Group::resizable()
51*/
52class FL_EXPORT Fl_Pack : public Fl_Group {
53 int spacing_;
54
55public:
56 enum { // values for type(int)
57 VERTICAL = 0,
58 HORIZONTAL = 1
59 };
60
61protected:
62 void draw();
63
64public:
65 Fl_Pack(int x,int y,int w ,int h,const char *l = 0);
66 /**
67 Gets the number of extra pixels of blank space that are added
68 between the children.
69 */
70 int spacing() const {return spacing_;}
71 /**
72 Sets the number of extra pixels of blank space that are added
73 between the children.
74 */
75 void spacing(int i) {spacing_ = i;}
76 /** Same as Fl_Group::type() */
77 uchar horizontal() const {return type();}
78};
79
80#endif
81
82//
83// End of "$Id: Fl_Pack.H 7903 2010-11-28 21:06:39Z matt $".
84//