FLTK 1.3.2
Fl_Widget.H
Go to the documentation of this file.
1 //
2 // "$Id: Fl_Widget.H 9388 2012-04-23 20:12:06Z matt $"
3 //
4 // Widget header file for the Fast Light Tool Kit (FLTK).
5 //
6 // Copyright 1998-2012 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 
22 #ifndef Fl_Widget_H
23 #define Fl_Widget_H
24 
25 #include "Enumerations.H"
26 
30 #ifdef _WIN64
31 #ifdef __GNUC__
32 #include <stdint.h>
33 #else
34 #include <stddef.h> // M$VC
35 #endif
36 typedef intptr_t fl_intptr_t;
37 typedef uintptr_t fl_uintptr_t;
38 #else
39 typedef long fl_intptr_t;
40 typedef unsigned long fl_uintptr_t;
41 #endif
42 
43 class Fl_Widget;
44 class Fl_Window;
45 class Fl_Group;
46 class Fl_Image;
47 
49 typedef void (Fl_Callback )(Fl_Widget*, void*);
51 typedef Fl_Callback* Fl_Callback_p; // needed for BORLAND
53 typedef void (Fl_Callback0)(Fl_Widget*);
55 typedef void (Fl_Callback1)(Fl_Widget*, long);
56 
64 struct FL_EXPORT Fl_Label {
66  const char* value;
81 
83  void draw(int,int,int,int, Fl_Align) const ;
84  void measure(int &w, int &h) const ;
85 };
86 
87 
100 class FL_EXPORT Fl_Widget {
101  friend class Fl_Group;
102 
103  Fl_Group* parent_;
104  Fl_Callback* callback_;
105  void* user_data_;
106  int x_,y_,w_,h_;
107  Fl_Label label_;
108  unsigned int flags_;
109  Fl_Color color_;
110  Fl_Color color2_;
111  uchar type_;
112  uchar damage_;
113  uchar box_;
114  uchar when_;
115 
116  const char *tooltip_;
117 
119  Fl_Widget(const Fl_Widget &);
121  Fl_Widget& operator=(const Fl_Widget &);
122 
123 protected:
124 
135  Fl_Widget(int x, int y, int w, int h, const char *label=0L);
136 
138  void x(int v) {x_ = v;}
140  void y(int v) {y_ = v;}
142  void w(int v) {w_ = v;}
144  void h(int v) {h_ = v;}
146  unsigned int flags() const {return flags_;}
148  void set_flag(unsigned int c) {flags_ |= c;}
150  void clear_flag(unsigned int c) {flags_ &= ~c;}
154  enum {
155  INACTIVE = 1<<0,
156  INVISIBLE = 1<<1,
157  OUTPUT = 1<<2,
158  NOBORDER = 1<<3,
159  FORCE_POSITION = 1<<4,
160  NON_MODAL = 1<<5,
161  SHORTCUT_LABEL = 1<<6,
162  CHANGED = 1<<7,
163  OVERRIDE = 1<<8,
164  VISIBLE_FOCUS = 1<<9,
165  COPIED_LABEL = 1<<10,
166  CLIP_CHILDREN = 1<<11,
167  MENU_WINDOW = 1<<12,
168  TOOLTIP_WINDOW = 1<<13,
169  MODAL = 1<<14,
170  NO_OVERLAY = 1<<15,
171  GROUP_RELATIVE = 1<<16,
172  COPIED_TOOLTIP = 1<<17,
173  FULLSCREEN = 1<<18,
174  // (space for more flags)
175  USERFLAG3 = 1<<29,
176  USERFLAG2 = 1<<30,
177  USERFLAG1 = 1<<31
178  };
179  void draw_box() const;
180  void draw_box(Fl_Boxtype t, Fl_Color c) const;
181  void draw_box(Fl_Boxtype t, int x,int y,int w,int h, Fl_Color c) const;
182  void draw_backdrop() const;
184  void draw_focus() {draw_focus(box(),x(),y(),w(),h());}
185  void draw_focus(Fl_Boxtype t, int x,int y,int w,int h) const;
186  void draw_label() const;
187  void draw_label(int, int, int, int) const;
188 
189 public:
190 
199  virtual ~Fl_Widget();
200 
217  virtual void draw() = 0;
218 
235  virtual int handle(int event);
236 
242  Fl_Group* parent() const {return parent_;}
243 
252  void parent(Fl_Group* p) {parent_ = p;} // for hacks only, use Fl_Group::add()
253 
262  uchar type() const {return type_;}
263 
267  void type(uchar t) {type_ = t;}
268 
272  int x() const {return x_;}
273 
277  int y() const {return y_;}
278 
282  int w() const {return w_;}
283 
287  int h() const {return h_;}
288 
308  virtual void resize(int x, int y, int w, int h);
309 
311  int damage_resize(int,int,int,int);
312 
320  void position(int X,int Y) {resize(X,Y,w_,h_);}
321 
329  void size(int W,int H) {resize(x_,y_,W,H);}
330 
336  Fl_Align align() const {return label_.align_;}
337 
345  void align(Fl_Align alignment) {label_.align_ = alignment;}
346 
351  Fl_Boxtype box() const {return (Fl_Boxtype)box_;}
352 
360  void box(Fl_Boxtype new_box) {box_ = new_box;}
361 
366  Fl_Color color() const {return color_;}
367 
378  void color(Fl_Color bg) {color_ = bg;}
379 
384  Fl_Color selection_color() const {return color2_;}
385 
394  void selection_color(Fl_Color a) {color2_ = a;}
395 
403  void color(Fl_Color bg, Fl_Color sel) {color_=bg; color2_=sel;}
404 
409  const char* label() const {return label_.value;}
410 
421  void label(const char* text);
422 
433  void copy_label(const char *new_label);
434 
438  void label(Fl_Labeltype a, const char* b) {label_.type = a; label_.value = b;}
439 
444  Fl_Labeltype labeltype() const {return (Fl_Labeltype)label_.type;}
445 
454  void labeltype(Fl_Labeltype a) {label_.type = a;}
455 
460  Fl_Color labelcolor() const {return label_.color;}
461 
466  void labelcolor(Fl_Color c) {label_.color=c;}
467 
475  Fl_Font labelfont() const {return label_.font;}
476 
484  void labelfont(Fl_Font f) {label_.font=f;}
485 
490  Fl_Fontsize labelsize() const {return label_.size;}
491 
496  void labelsize(Fl_Fontsize pix) {label_.size=pix;}
497 
502  Fl_Image* image() {return label_.image;}
503  const Fl_Image* image() const {return label_.image;}
504 
509  void image(Fl_Image* img) {label_.image=img;}
510 
515  void image(Fl_Image& img) {label_.image=&img;}
516 
521  Fl_Image* deimage() {return label_.deimage;}
522  const Fl_Image* deimage() const {return label_.deimage;}
523 
528  void deimage(Fl_Image* img) {label_.deimage=img;}
529 
534  void deimage(Fl_Image& img) {label_.deimage=&img;}
535 
540  const char *tooltip() const {return tooltip_;}
541 
542  void tooltip(const char *text); // see Fl_Tooltip
543  void copy_tooltip(const char *text); // see Fl_Tooltip
544 
549  Fl_Callback_p callback() const {return callback_;}
550 
556  void callback(Fl_Callback* cb, void* p) {callback_=cb; user_data_=p;}
557 
562  void callback(Fl_Callback* cb) {callback_=cb;}
563 
568  void callback(Fl_Callback0*cb) {callback_=(Fl_Callback*)cb;}
569 
575  void callback(Fl_Callback1*cb, long p=0) {callback_=(Fl_Callback*)cb; user_data_=(void*)p;}
576 
581  void* user_data() const {return user_data_;}
582 
587  void user_data(void* v) {user_data_ = v;}
588 
591  long argument() const {return (long)(fl_intptr_t)user_data_;}
592 
597  void argument(long v) {user_data_ = (void*)v;}
598 
607  Fl_When when() const {return (Fl_When)when_;}
608 
640  void when(uchar i) {when_ = i;}
641 
646  unsigned int visible() const {return !(flags_&INVISIBLE);}
647 
652  int visible_r() const;
653 
671  virtual void show();
672 
676  virtual void hide();
677 
682  void set_visible() {flags_ &= ~INVISIBLE;}
683 
688  void clear_visible() {flags_ |= INVISIBLE;}
689 
694  unsigned int active() const {return !(flags_&INACTIVE);}
695 
700  int active_r() const;
701 
707  void activate();
708 
723  void deactivate();
724 
733  unsigned int output() const {return (flags_&OUTPUT);}
734 
738  void set_output() {flags_ |= OUTPUT;}
739 
743  void clear_output() {flags_ &= ~OUTPUT;}
744 
750  unsigned int takesevents() const {return !(flags_&(INACTIVE|INVISIBLE|OUTPUT));}
751 
767  unsigned int changed() const {return flags_&CHANGED;}
768 
772  void set_changed() {flags_ |= CHANGED;}
773 
777  void clear_changed() {flags_ &= ~CHANGED;}
778 
786  int take_focus();
787 
794  void set_visible_focus() { flags_ |= VISIBLE_FOCUS; }
795 
800  void clear_visible_focus() { flags_ &= ~VISIBLE_FOCUS; }
801 
806  void visible_focus(int v) { if (v) set_visible_focus(); else clear_visible_focus(); }
807 
812  unsigned int visible_focus() { return flags_ & VISIBLE_FOCUS; }
813 
821  static void default_callback(Fl_Widget *cb, void *d);
822 
827  void do_callback() {do_callback(this,user_data_);}
828 
835  void do_callback(Fl_Widget* o,long arg) {do_callback(o,(void*)arg);}
836 
837  // Causes a widget to invoke its callback function with arbitrary arguments.
838  // Documentation and implementation in Fl_Widget.cxx
839  void do_callback(Fl_Widget* o,void* arg=0);
840 
841  /* Internal use only. */
842  int test_shortcut();
843  /* Internal use only. */
844  static unsigned int label_shortcut(const char *t);
845  /* Internal use only. */
846  static int test_shortcut(const char*, const bool require_alt = false);
847  /* Internal use only. */
848  void _set_fullscreen() {flags_ |= FULLSCREEN;}
849  void _clear_fullscreen() {flags_ &= ~FULLSCREEN;}
850 
856  int contains(const Fl_Widget *w) const ;
857 
864  int inside(const Fl_Widget* wgt) const {return wgt ? wgt->contains(this) : 0;}
865 
869  void redraw();
870 
875  void redraw_label();
876 
883  uchar damage() const {return damage_;}
884 
897  void clear_damage(uchar c = 0) {damage_ = c;}
898 
904  void damage(uchar c);
905 
912  void damage(uchar c, int x, int y, int w, int h);
913 
914  void draw_label(int, int, int, int, Fl_Align) const;
915 
919  void measure_label(int& ww, int& hh) const {label_.measure(ww, hh);}
920 
926  Fl_Window* window() const ;
927 
951  virtual Fl_Group* as_group() {return 0;}
952 
965  virtual Fl_Window* as_window() {return 0;}
966 
977  virtual class Fl_Gl_Window* as_gl_window() {return 0;}
978 
982  Fl_Color color2() const {return (Fl_Color)color2_;}
983 
987  void color2(unsigned a) {color2_ = a;}
988 };
989 
995 #define FL_RESERVED_TYPE 100
996 
997 #endif
998 
999 //
1000 // End of "$Id: Fl_Widget.H 9388 2012-04-23 20:12:06Z matt $".
1001 //