FLTK 1.3.4
Fl_Group.H
1 //
2 // "$Id: Fl_Group.H 10446 2014-11-10 22:09:11Z AlbrechtS $"
3 //
4 // Group 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. Distribution and use rights are outlined in
9 // the file "COPYING" which should have been included with this file. If this
10 // file is missing or damaged, see the license at:
11 //
12 // http://www.fltk.org/COPYING.php
13 //
14 // Please report all bugs and problems on the following page:
15 //
16 // http://www.fltk.org/str.php
17 //
18 
19 /* \file
20  Fl_Group, Fl_End classes . */
21 
22 #ifndef Fl_Group_H
23 #define Fl_Group_H
24 
25 #ifndef Fl_Widget_H
26 #include "Fl_Widget.H"
27 #endif
28 
41 class FL_EXPORT Fl_Group : public Fl_Widget {
42 
43  Fl_Widget** array_;
44  Fl_Widget* savedfocus_;
45  Fl_Widget* resizable_;
46  int children_;
47  int *sizes_; // remembered initial sizes of children
48 
49  int navigation(int);
50  static Fl_Group *current_;
51 
52  // unimplemented copy ctor and assignment operator
53  Fl_Group(const Fl_Group&);
54  Fl_Group& operator=(const Fl_Group&);
55 
56 protected:
57  void draw();
58  void draw_child(Fl_Widget& widget) const;
59  void draw_children();
60  void draw_outside_label(const Fl_Widget& widget) const ;
61  void update_child(Fl_Widget& widget) const;
62  int *sizes();
63 
64 public:
65 
66  int handle(int);
67  void begin();
68  void end();
69  static Fl_Group *current();
70  static void current(Fl_Group *g);
71 
75  int children() const {return children_;}
79  Fl_Widget* child(int n) const {return array()[n];}
80  int find(const Fl_Widget*) const;
84  int find(const Fl_Widget& o) const {return find(&o);}
85  Fl_Widget* const* array() const;
86 
87  void resize(int,int,int,int);
92  Fl_Group(int,int,int,int, const char * = 0);
93  virtual ~Fl_Group();
94  void add(Fl_Widget&);
98  void add(Fl_Widget* o) {add(*o);}
99  void insert(Fl_Widget&, int i);
104  void insert(Fl_Widget& o, Fl_Widget* before) {insert(o,find(before));}
105  void remove(int index);
106  void remove(Fl_Widget&);
111  void remove(Fl_Widget* o) {remove(*o);}
112  void clear();
113 
117  void resizable(Fl_Widget& o) {resizable_ = &o;}
148  void resizable(Fl_Widget* o) {resizable_ = o;}
152  Fl_Widget* resizable() const {return resizable_;}
156  void add_resizable(Fl_Widget& o) {resizable_ = &o; add(o);}
157  void init_sizes();
158 
168  void clip_children(int c) { if (c) set_flag(CLIP_CHILDREN); else clear_flag(CLIP_CHILDREN); }
176  unsigned int clip_children() { return (flags() & CLIP_CHILDREN) != 0; }
177 
178  // Note: Doxygen docs in Fl_Widget.H to avoid redundancy.
179  virtual Fl_Group* as_group() { return this; }
180 
181  // back compatibility functions:
182 
188  void focus(Fl_Widget* W) {W->take_focus();}
189 
191  Fl_Widget* & _ddfdesign_kludge() {return resizable_;}
192 
194  void forms_end();
195 };
196 
197 // dummy class used to end child groups in constructors for complex
198 // subclasses of Fl_Group:
218 class FL_EXPORT Fl_End {
219 public:
222 };
223 
224 #endif
225 
226 //
227 // End of "$Id: Fl_Group.H 10446 2014-11-10 22:09:11Z AlbrechtS $".
228 //
Fl_Widget * resizable() const
See void Fl_Group::resizable(Fl_Widget *box)
Definition: Fl_Group.H:152
Fl_Widget is the base class for all widgets in FLTK.
Definition: Fl_Widget.H:101
void add_resizable(Fl_Widget &o)
Adds a widget to the group and makes it the resizable widget.
Definition: Fl_Group.H:156
virtual int handle(int event)
Handles the specified event.
Definition: Fl_Widget.cxx:112
int find(const Fl_Widget &o) const
See int Fl_Group::find(const Fl_Widget *w) const.
Definition: Fl_Group.H:84
virtual void draw()=0
Draws the widget.
This is a dummy class that allows you to end a Fl_Group in a constructor list of a class: ...
Definition: Fl_Group.H:218
Fl_Widget * child(int n) const
Returns array()[n].
Definition: Fl_Group.H:79
void end()
Exactly the same as current(this->parent()).
Definition: Fl_Group.cxx:75
int take_focus()
Gives the widget the keyboard focus.
Definition: Fl_Widget.cxx:162
virtual Fl_Group * as_group()
Returns an Fl_Group pointer if this widget is an Fl_Group.
Definition: Fl_Group.H:179
void insert(Fl_Widget &o, Fl_Widget *before)
This does insert(w, find(before)).
Definition: Fl_Group.H:104
virtual void resize(int x, int y, int w, int h)
Changes the size or position of the widget.
Definition: Fl_Widget.cxx:150
The Fl_Group class is the FLTK container widget.
Definition: Fl_Group.H:41
void clear_flag(unsigned int c)
Clears a flag in the flags mask.
Definition: Fl_Widget.H:151
Fl_Widget, Fl_Label classes .
void resizable(Fl_Widget &o)
See void Fl_Group::resizable(Fl_Widget *box)
Definition: Fl_Group.H:117
int children() const
Returns how many child widgets the group has.
Definition: Fl_Group.H:75
unsigned int clip_children()
Returns the current clipping mode.
Definition: Fl_Group.H:176
void focus(Fl_Widget *W)
Definition: Fl_Group.H:188
void add(Fl_Widget *o)
See void Fl_Group::add(Fl_Widget &w)
Definition: Fl_Group.H:98
void set_flag(unsigned int c)
Sets a flag in the flags mask.
Definition: Fl_Widget.H:149
Fl_End()
All it does is calling Fl_Group::current()->end()
Definition: Fl_Group.H:221
void clip_children(int c)
Controls whether the group widget clips the drawing of child widgets to its bounding box...
Definition: Fl_Group.H:168
unsigned int flags() const
Gets the widget flags mask.
Definition: Fl_Widget.H:147
Fl_Widget *& _ddfdesign_kludge()
This is for forms compatibility only.
Definition: Fl_Group.H:191
static Fl_Group * current()
Returns the currently active group.
Definition: Fl_Group.cxx:84
void resizable(Fl_Widget *o)
The resizable widget defines the resizing box for the group.
Definition: Fl_Group.H:148