FLTK 1.3.2
Fl.H
Go to the documentation of this file.
1 //
2 // "$Id: Fl.H 9701 2012-10-18 12:56:31Z manolo $"
3 //
4 // Main 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 
23 #ifndef Fl_H
24 # define Fl_H
25 
26 #ifdef FLTK_HAVE_CAIRO
27 # include <FL/Fl_Cairo.H>
28 #endif
29 
30 # include "fl_utf8.h"
31 # include "Enumerations.H"
32 # ifndef Fl_Object
33 # define Fl_Object Fl_Widget
34 # endif
35 
36 # ifdef check
37 # undef check
38 # endif
39 
40 
41 class Fl_Widget;
42 class Fl_Window;
43 class Fl_Image;
44 struct Fl_Label;
45 
46 // Keep avoiding having the socket deps at that level but mke sure it will work in both 32 & 64 bit builds
47 #if defined(WIN32) && !defined(__CYGWIN__)
48 # if defined(_WIN64)
49 # define FL_SOCKET unsigned __int64
50 # else
51 # define FL_SOCKET int
52 # endif
53 #else
54 # define FL_SOCKET int
55 #endif
56 
73 typedef void (Fl_Label_Draw_F)(const Fl_Label *label, int x, int y, int w, int h, Fl_Align align);
74 
76 typedef void (Fl_Label_Measure_F)(const Fl_Label *label, int &width, int &height);
77 
79 typedef void (Fl_Box_Draw_F)(int x, int y, int w, int h, Fl_Color color);
80 
82 typedef void (*Fl_Timeout_Handler)(void *data);
83 
85 typedef void (*Fl_Awake_Handler)(void *data);
86 
88 typedef void (*Fl_Idle_Handler)(void *data);
89 
91 typedef void (*Fl_Old_Idle_Handler)();
92 
94 typedef void (*Fl_FD_Handler)(FL_SOCKET fd, void *data);
95 
97 typedef int (*Fl_Event_Handler)(int event);
98 
100 typedef void (*Fl_Abort_Handler)(const char *format,...);
101 
103 typedef void (*Fl_Atclose_Handler)(Fl_Window *window, void *data);
104 
106 typedef int (*Fl_Args_Handler)(int argc, char **argv, int &i);
107 
110 typedef int (*Fl_Event_Dispatch)(int event, Fl_Window *w);
111  /* group callback_functions */
113 
114 
119 class FL_EXPORT Fl {
120  Fl() {}; // no constructor!
121 
122 public: // should be private!
123 #ifndef FL_DOXYGEN
124  static int e_number;
125  static int e_x;
126  static int e_y;
127  static int e_x_root;
128  static int e_y_root;
129  static int e_dx;
130  static int e_dy;
131  static int e_state;
132  static int e_clicks;
133  static int e_is_click;
134  static int e_keysym;
135  static char* e_text;
136  static int e_length;
137  static Fl_Event_Dispatch e_dispatch;
138  static Fl_Widget* belowmouse_;
139  static Fl_Widget* pushed_;
140  static Fl_Widget* focus_;
141  static int damage_;
142  static Fl_Widget* selection_owner_;
143  static Fl_Window* modal_;
144  static Fl_Window* grab_;
145  static int compose_state;
146  static void call_screen_init(); // recompute screen number and dimensions
147 #endif
148 
151  static void damage(int d) {damage_ = d;}
152 
153 public:
160  typedef enum {
165  OPTION_ARROW_FOCUS = 0,
166  // When switched on, FLTK will use the file chooser dialog that comes
167  // with your operating system whenever possible. When switched off, FLTK
168  // will present its own file chooser.
169  // \todo implement me
170  // OPTION_NATIVE_FILECHOOSER,
171  // When Filechooser Preview is enabled, the FLTK or native file chooser
172  // will show a preview of a selected file (if possible) before the user
173  // decides to choose the file.
174  // \todo implement me
175  //OPTION_FILECHOOSER_PREVIEW,
189  // don't change this, leave it always as the last element
191  OPTION_LAST
192  } Fl_Option;
193 
194 private:
195  static unsigned char options_[OPTION_LAST];
196  static unsigned char options_read_;
197 
198 public:
199  /*
200  Return a global setting for all FLTK applications, possibly overridden
201  by a setting specifically for this application.
202  */
203  static bool option(Fl_Option opt);
204 
205  /*
206  Override an option while the application is running.
207  */
208  static void option(Fl_Option opt, bool val);
209 
217  static void (*idle)();
218 
219 #ifndef FL_DOXYGEN
220  static Fl_Awake_Handler *awake_ring_;
221  static void **awake_data_;
222  static int awake_ring_size_;
223  static int awake_ring_head_;
224  static int awake_ring_tail_;
225  static const char* scheme_;
226  static Fl_Image* scheme_bg_;
227 
228  static int e_original_keysym; // late addition
229  static int scrollbar_size_;
230 #endif
231 
232 
233  static int add_awake_handler_(Fl_Awake_Handler, void*);
234  static int get_awake_handler_(Fl_Awake_Handler&, void*&);
235 
236 public:
237 
238  // API version number
239  static double version();
240 
241  // argument parsers:
242  static int arg(int argc, char **argv, int& i);
243  static int args(int argc, char **argv, int& i, Fl_Args_Handler cb = 0);
244  static void args(int argc, char **argv);
249  static const char* const help;
250 
251  // things called by initialization:
252  static void display(const char*);
253  static int visual(int);
263  static int gl_visual(int, int *alist=0); // platform dependent
264  static void own_colormap();
265  static void get_system_colors();
266  static void foreground(uchar, uchar, uchar);
267  static void background(uchar, uchar, uchar);
268  static void background2(uchar, uchar, uchar);
269 
270  // schemes:
271  static int scheme(const char*);
273  static const char* scheme() {return scheme_;}
279  static int reload_scheme(); // platform dependent
280  static int scrollbar_size();
281  static void scrollbar_size(int W);
282 
283  // execution:
284  static int wait();
285  static double wait(double time);
286  static int check();
287  static int ready();
288  static int run();
289  static Fl_Widget* readqueue();
316  static void add_timeout(double t, Fl_Timeout_Handler,void* = 0); // platform dependent
337  static void repeat_timeout(double t, Fl_Timeout_Handler, void* = 0); // platform dependent
338  static int has_timeout(Fl_Timeout_Handler, void* = 0);
339  static void remove_timeout(Fl_Timeout_Handler, void* = 0);
340  static void add_check(Fl_Timeout_Handler, void* = 0);
341  static int has_check(Fl_Timeout_Handler, void* = 0);
342  static void remove_check(Fl_Timeout_Handler, void* = 0);
362  static void add_fd(int fd, int when, Fl_FD_Handler cb, void* = 0); // platform dependent
364  static void add_fd(int fd, Fl_FD_Handler cb, void* = 0); // platform dependent
366  static void remove_fd(int, int when); // platform dependent
368  static void remove_fd(int); // platform dependent
369 
370  static void add_idle(Fl_Idle_Handler cb, void* data = 0);
371  static int has_idle(Fl_Idle_Handler cb, void* data = 0);
372  static void remove_idle(Fl_Idle_Handler cb, void* data = 0);
374  static int damage() {return damage_;}
375  static void redraw();
376  static void flush();
397  static void (*warning)(const char*, ...);
412  static void (*error)(const char*, ...);
429  static void (*fatal)(const char*, ...);
435  static Fl_Window* first_window();
436  static void first_window(Fl_Window*);
437  static Fl_Window* next_window(const Fl_Window*);
438 
448  static Fl_Window* modal() {return modal_;}
454  static Fl_Window* grab() {return grab_;}
479  static void grab(Fl_Window*); // platform dependent
486  // event information:
492  static int event() {return e_number;}
497  static int event_x() {return e_x;}
502  static int event_y() {return e_y;}
509  static int event_x_root() {return e_x_root;}
516  static int event_y_root() {return e_y_root;}
521  static int event_dx() {return e_dx;}
526  static int event_dy() {return e_dy;}
535  static void get_mouse(int &,int &); // platform dependent
544  static int event_clicks() {return e_clicks;}
552  static void event_clicks(int i) {e_clicks = i;}
560  static int event_is_click() {return e_is_click;}
567  static void event_is_click(int i) {e_is_click = i;}
574  static int event_button() {return e_keysym-FL_Button;}
598  static int event_state() {return e_state;}
600  static int event_state(int i) {return e_state&i;}
612  static int event_key() {return e_keysym;}
621  static int event_original_key(){return e_original_keysym;}
660  static int event_key(int key);
666  static int get_key(int key); // platform dependent
681  static const char* event_text() {return e_text;}
688  static int event_length() {return e_length;}
689 
690  static int compose(int &del);
691  static void compose_reset();
692  static int event_inside(int,int,int,int);
693  static int event_inside(const Fl_Widget*);
694  static int test_shortcut(Fl_Shortcut);
695 
696  // event destinations:
697  static int handle(int, Fl_Window*);
698  static int handle_(int, Fl_Window*);
701  static Fl_Widget* belowmouse() {return belowmouse_;}
702  static void belowmouse(Fl_Widget*);
705  static Fl_Widget* pushed() {return pushed_;}
706  static void pushed(Fl_Widget*);
708  static Fl_Widget* focus() {return focus_;}
709  static void focus(Fl_Widget*);
710  static void add_handler(Fl_Event_Handler h);
711  static void remove_handler(Fl_Event_Handler h);
712  static void event_dispatch(Fl_Event_Dispatch d);
713  static Fl_Event_Dispatch event_dispatch();
719  // cut/paste:
729  static void copy(const char* stuff, int len, int destination = 0); // platform dependent
747  static void paste(Fl_Widget &receiver, int source /*=0*/); // platform dependent
757  static int dnd(); // platform dependent
758 
759  // These are for back-compatibility only:
762  static Fl_Widget* selection_owner() {return selection_owner_;}
763  static void selection_owner(Fl_Widget*);
764  static void selection(Fl_Widget &owner, const char*, int len);
765  static void paste(Fl_Widget &receiver);
770  // screen size:
772  static int x(); // platform dependent
774  static int y(); // platform dependent
776  static int w(); // platform dependent
778  static int h(); // platform dependent
779 
780  // multi-head support:
781  static int screen_count();
787  static void screen_xywh(int &X, int &Y, int &W, int &H) {
788  int x, y;
789  Fl::get_mouse(x, y);
790  screen_xywh(X, Y, W, H, x, y);
791  }
792  static void screen_xywh(int &X, int &Y, int &W, int &H, int mx, int my);
793  static void screen_xywh(int &X, int &Y, int &W, int &H, int n);
794  static void screen_xywh(int &X, int &Y, int &W, int &H, int mx, int my, int mw, int mh);
795  static void screen_dpi(float &h, float &v, int n=0);
796  static void screen_work_area(int &X, int &Y, int &W, int &H, int mx, int my);
797  static void screen_work_area(int &X, int &Y, int &W, int &H, int n);
803  static void screen_work_area(int &X, int &Y, int &W, int &H) {
804  int x, y;
805  Fl::get_mouse(x, y);
806  screen_work_area(X, Y, W, H, x, y);
807  }
808 
816  // color map:
817  static void set_color(Fl_Color, uchar, uchar, uchar);
822  static void set_color(Fl_Color i, unsigned c); // platform dependent
823  static unsigned get_color(Fl_Color i);
824  static void get_color(Fl_Color i, uchar &red, uchar &green, uchar &blue);
830  static void free_color(Fl_Color i, int overlay = 0); // platform dependent
831 
832  // fonts:
833  static const char* get_font(Fl_Font);
846  static const char* get_font_name(Fl_Font, int* attributes = 0);
858  static int get_font_sizes(Fl_Font, int*& sizep);
859  static void set_font(Fl_Font, const char*);
860  static void set_font(Fl_Font, Fl_Font);
879  static Fl_Font set_fonts(const char* = 0); // platform dependent
880 
887  // <Hack to re-order the 'Drawing functions' group>
890  // labeltypes:
891  static void set_labeltype(Fl_Labeltype,Fl_Label_Draw_F*,Fl_Label_Measure_F*);
893  static void set_labeltype(Fl_Labeltype, Fl_Labeltype from); // is it defined ?
894 
895  // boxtypes:
896  static Fl_Box_Draw_F *get_boxtype(Fl_Boxtype);
897  static void set_boxtype(Fl_Boxtype, Fl_Box_Draw_F*,uchar,uchar,uchar,uchar);
898  static void set_boxtype(Fl_Boxtype, Fl_Boxtype from);
899  static int box_dx(Fl_Boxtype);
900  static int box_dy(Fl_Boxtype);
901  static int box_dw(Fl_Boxtype);
902  static int box_dh(Fl_Boxtype);
903  static int draw_box_active();
904 
905  // back compatibility:
909  static void set_abort(Fl_Abort_Handler f) {fatal = f;}
910  static void (*atclose)(Fl_Window*,void*);
911  static void default_atclose(Fl_Window*,void*);
915  static void set_atclose(Fl_Atclose_Handler f) {atclose = f;}
921  static int event_shift() {return e_state&FL_SHIFT;}
923  static int event_ctrl() {return e_state&FL_CTRL;}
925  static int event_command() {return e_state&FL_COMMAND;}
927  static int event_alt() {return e_state&FL_ALT;}
936  static int event_buttons() {return e_state&0x7f000000;}
941  static int event_button1() {return e_state&FL_BUTTON1;}
946  static int event_button2() {return e_state&FL_BUTTON2;}
951  static int event_button3() {return e_state&FL_BUTTON3;}
959  static void set_idle(Fl_Old_Idle_Handler cb) {idle = cb;}
961  static void grab(Fl_Window& win) {grab(&win);}
965  static void release() {grab(0);}
966 
967  // Visible focus methods...
973  static void visible_focus(int v) { option(OPTION_VISIBLE_FOCUS, (v!=0)); }
979  static int visible_focus() { return option(OPTION_VISIBLE_FOCUS); }
980 
981  // Drag-n-drop text operation methods...
988  static void dnd_text_ops(int v) { option(OPTION_DND_TEXT, (v!=0)); }
995  static int dnd_text_ops() { return option(OPTION_DND_TEXT); }
1000  // Multithreading support:
1001  static int lock();
1002  static void unlock();
1003  static void awake(void* message = 0);
1005  static int awake(Fl_Awake_Handler cb, void* message = 0);
1012  static void* thread_message(); // platform dependent
1044  // Widget deletion:
1045  static void delete_widget(Fl_Widget *w);
1046  static void do_widget_deletion();
1047  static void watch_widget_pointer(Fl_Widget *&w);
1048  static void release_widget_pointer(Fl_Widget *&w);
1049  static void clear_widget_pointer(Fl_Widget const *w);
1052 #ifdef FLTK_HAVE_CAIRO
1053 
1056 public:
1057  // Cairo support API
1058  static cairo_t * cairo_make_current(Fl_Window* w);
1073  static void cairo_autolink_context(bool alink) {cairo_state_.autolink(alink);}
1081  static bool cairo_autolink_context() {return cairo_state_.autolink();}
1083  static cairo_t * cairo_cc() { return cairo_state_.cc(); }
1088  static void cairo_cc(cairo_t * c, bool own=false){ cairo_state_.cc(c, own); }
1089 
1090 private:
1091  static cairo_t * cairo_make_current(void* gc);
1092  static cairo_t * cairo_make_current(void* gc, int W, int H);
1093  static Fl_Cairo_State cairo_state_;
1094 public:
1097 #endif // FLTK_HAVE_CAIRO
1098 
1099 };
1100 
1141 class FL_EXPORT Fl_Widget_Tracker {
1142 
1143  Fl_Widget* wp_;
1144 
1145 public:
1146 
1148  ~Fl_Widget_Tracker();
1149 
1155  Fl_Widget *widget() {return wp_;}
1156 
1166  int deleted() {return wp_ == 0;}
1167 
1177  int exists() {return wp_ != 0;}
1178 
1179 };
1180 
1186 #endif // !Fl_H
1187 
1188 //
1189 // End of "$Id: Fl.H 9701 2012-10-18 12:56:31Z manolo $".
1190 //