FLTK 1.4.0
Fl.H
Go to the documentation of this file.
1 //
2 // Main header file for the Fast Light Tool Kit (FLTK).
3 //
4 // Copyright 1998-2022 by Bill Spitzak and others.
5 //
6 // This library is free software. Distribution and use rights are outlined in
7 // the file "COPYING" which should have been included with this file. If this
8 // file is missing or damaged, see the license at:
9 //
10 // https://www.fltk.org/COPYING.php
11 //
12 // Please see the following page on how to report bugs and issues:
13 //
14 // https://www.fltk.org/bugs.php
15 //
16 
21 #ifndef Fl_H
22 # define Fl_H
23 
24 #include <FL/fl_config.h> // build configuration
25 #include <FL/Fl_Export.H>
26 #include <FL/platform_types.h> // for FL_SOCKET
27 #include <FL/fl_casts.H> // experimental
28 
29 #ifdef FLTK_HAVE_CAIRO
30 # include <FL/Fl_Cairo.H>
31 #endif
32 
33 # include "fl_utf8.h"
34 # include "Enumerations.H"
35 # ifndef Fl_Object
36 # define Fl_Object Fl_Widget
37 # endif
38 
39 # ifdef check
40 # undef check
41 # endif
42 
43 # ifdef BSD
44 # undef BSD
45 # endif
46 
47 #include <string.h> // FIXME: Fl::is_scheme(): strcmp needs string.h
48 
49 class Fl_Widget;
50 class Fl_Window;
51 class Fl_Image;
52 struct Fl_Label;
53 class Fl_Screen_Driver;
54 class Fl_System_Driver;
55 
56 // Pointers you can use to change FLTK to another language.
57 // Note: Similar pointers are defined in FL/fl_ask.H and src/fl_ask.cxx
58 
59 extern FL_EXPORT const char* fl_local_alt;
60 extern FL_EXPORT const char* fl_local_ctrl;
61 extern FL_EXPORT const char* fl_local_meta;
62 extern FL_EXPORT const char* fl_local_shift;
63 
83 typedef void (Fl_Label_Draw_F)(const Fl_Label *label, int x, int y, int w, int h, Fl_Align align);
84 
86 typedef void (Fl_Label_Measure_F)(const Fl_Label *label, int &width, int &height);
87 
89 typedef void (Fl_Box_Draw_F)(int x, int y, int w, int h, Fl_Color color);
90 
94 typedef void (*Fl_Timeout_Handler)(void *data);
95 
97 typedef void (*Fl_Awake_Handler)(void *data);
98 
100 typedef void (*Fl_Idle_Handler)(void *data);
101 
103 typedef void (*Fl_Old_Idle_Handler)();
104 
106 typedef void (*Fl_FD_Handler)(FL_SOCKET fd, void *data);
107 
109 typedef int (*Fl_Event_Handler)(int event);
110 
112 typedef int (*Fl_System_Handler)(void *event, void *data);
113 
115 typedef void (*Fl_Abort_Handler)(const char *format,...);
116 
118 typedef void (*Fl_Atclose_Handler)(Fl_Window *window, void *data);
119 
121 typedef int (*Fl_Args_Handler)(int argc, char **argv, int &i);
122 
125 typedef int (*Fl_Event_Dispatch)(int event, Fl_Window *w);
126 
128 typedef void (*Fl_Clipboard_Notify_Handler)(int source, void *data);
129  /* group callback_functions */
131 
132 
137 class FL_EXPORT Fl {
138  Fl() {} // no constructor!
139 
140 private:
141 
142  static int use_high_res_GL_;
143  static int draw_GL_text_with_textures_;
144  static int box_shadow_width_;
145  static int box_border_radius_max_;
146 
147 public:
148 
149  static Fl_Screen_Driver *screen_driver();
150  static Fl_System_Driver *system_driver();
151 #ifdef __APPLE__ // deprecated in 1.4 - only for compatibility with 1.3
152  static void reset_marked_text();
153  static void insertion_point_location(int x, int y, int height);
154 #endif
155 
156 
160  static int box_shadow_width() { return box_shadow_width_; }
165  static void box_shadow_width(int W) { box_shadow_width_ = W < 1 ? 1 : W; }
166 
170  static int box_border_radius_max() { return box_border_radius_max_; }
183  static void box_border_radius_max(int R) { box_border_radius_max_ = R < 5 ? 5 : R; }
184 
185 public: // should be private!
186 
187 #ifndef FL_DOXYGEN
188  static int e_number;
189  static int e_x;
190  static int e_y;
191  static int e_x_root;
192  static int e_y_root;
193  static int e_dx;
194  static int e_dy;
195  static int e_state;
196  static int e_clicks;
197  static int e_is_click;
198  static int e_keysym;
199  static char* e_text;
200  static int e_length;
201  static void *e_clipboard_data;
202  static const char *e_clipboard_type;
203  static Fl_Event_Dispatch e_dispatch;
204  static Fl_Widget* belowmouse_;
205  static Fl_Widget* pushed_;
206  static Fl_Widget* focus_;
207  static int damage_;
208  static Fl_Widget* selection_owner_;
209  static Fl_Window* modal_;
210  static Fl_Window* grab_;
211  static int compose_state; // used for dead keys (Windows) or marked text (MacOS)
212  static void call_screen_init(); // recompute screen number and dimensions
213 #endif // FL_DOXYGEN
214 
215 
219  static void damage(int d) {damage_ = d;}
220 
221 public:
228  typedef enum {
238  OPTION_ARROW_FOCUS = 0,
239  // When switched on, FLTK will use the file chooser dialog that comes
240  // with your operating system whenever possible. When switched off, FLTK
241  // will present its own file chooser.
242  // \todo implement me
243  // OPTION_NATIVE_FILECHOOSER,
244  // When Filechooser Preview is enabled, the FLTK or native file chooser
245  // will show a preview of a selected file (if possible) before the user
246  // decides to choose the file.
247  // \todo implement me
248  //OPTION_FILECHOOSER_PREVIEW,
274  // don't change this, leave it always as the last element
276  OPTION_LAST
277  } Fl_Option;
278 
279 private:
280  static unsigned char options_[OPTION_LAST];
281  static unsigned char options_read_;
282  static int program_should_quit_; // non-zero means the program was asked to cleanly terminate
283 
284 public:
285  /*
286  Return a global setting for all FLTK applications, possibly overridden
287  by a setting specifically for this application.
288  */
289  static bool option(Fl_Option opt);
290 
291  /*
292  Override an option while the application is running.
293  */
294  static void option(Fl_Option opt, bool val);
295 
303  static void (*idle)();
304 
305 #ifndef FL_DOXYGEN
306  static Fl_Awake_Handler *awake_ring_;
307  static void **awake_data_;
308  static int awake_ring_size_;
309  static int awake_ring_head_;
310  static int awake_ring_tail_;
311  static const char* scheme_;
312  static Fl_Image* scheme_bg_;
313 
314  static int e_original_keysym; // late addition
315  static int scrollbar_size_;
316  static int menu_linespacing_; // STR #2927
317 #endif
318 
319 
320  static int add_awake_handler_(Fl_Awake_Handler, void*);
321  static int get_awake_handler_(Fl_Awake_Handler&, void*&);
322 
323 public:
324 
325  // API version number
326  static double version();
327  static int api_version();
328 
329  // ABI version number
330  static int abi_version();
331 
354  static inline int abi_check(const int val = FL_ABI_VERSION) {
355  return val == abi_version();
356  }
357 
358  // argument parsers:
359  static int arg(int argc, char **argv, int& i);
360  static int args(int argc, char **argv, int& i, Fl_Args_Handler cb = 0);
361  static void args(int argc, char **argv);
366  static const char* const help;
367 
368  // things called by initialization:
369  static void display(const char*);
370  static int visual(int);
380  static int gl_visual(int, int *alist=0); // platform dependent
381  static void own_colormap();
382  static void get_system_colors();
383  static void foreground(uchar, uchar, uchar);
384  static void background(uchar, uchar, uchar);
385  static void background2(uchar, uchar, uchar);
386 
387  // schemes:
388  static int scheme(const char *name);
390  static const char* scheme() {return scheme_;}
391 
419  static int is_scheme(const char *name) {
420  return (scheme_ && name && !strcmp(name,scheme_));
421  }
427  static int reload_scheme(); // platform dependent
428  static int scrollbar_size();
429  static void scrollbar_size(int W);
430  static int menu_linespacing();
431  static void menu_linespacing(int H);
432 
433  // execution:
434  static int wait();
435  static double wait(double time);
436  static int check();
437  static int ready();
438  static int run();
445  static int program_should_quit() {return program_should_quit_;}
451  static void program_should_quit(int should_i) { program_should_quit_ = should_i; }
452 
453  static Fl_Widget* readqueue();
454 
455  //
456  // cross-platform timer support
457  //
458 
459  static void add_timeout(double t, Fl_Timeout_Handler cb, void *data = 0);
460  static void repeat_timeout(double t, Fl_Timeout_Handler cb, void *data = 0);
461  static int has_timeout(Fl_Timeout_Handler cb, void *data = 0);
462  static void remove_timeout(Fl_Timeout_Handler cb, void *data = 0);
463 
464  static void add_check(Fl_Timeout_Handler, void* = 0);
465  static int has_check(Fl_Timeout_Handler, void* = 0);
466  static void remove_check(Fl_Timeout_Handler, void* = 0);
467  // private
468  static void run_idle();
469  static void run_checks();
470  static void add_fd(int fd, int when, Fl_FD_Handler cb, void* = 0); // platform dependent
471  static void add_fd(int fd, Fl_FD_Handler cb, void* = 0); // platform dependent
473  static void remove_fd(int, int when); // platform dependent
475  static void remove_fd(int); // platform dependent
476 
477  static void add_idle(Fl_Idle_Handler cb, void* data = 0);
478  static int has_idle(Fl_Idle_Handler cb, void* data = 0);
479  static void remove_idle(Fl_Idle_Handler cb, void* data = 0);
481  static int damage() {return damage_;}
482  static void redraw();
483  static void flush();
504  static void (*warning)(const char*, ...);
519  static void (*error)(const char*, ...);
536  static void (*fatal)(const char*, ...);
542  static Fl_Window* first_window();
543  static void first_window(Fl_Window*);
544  static Fl_Window* next_window(const Fl_Window*);
545 
555  static Fl_Window* modal() {return modal_;}
561  static Fl_Window* grab() {return grab_;}
586  static void grab(Fl_Window*); // platform dependent
593  // event information:
599  static int event() {return e_number;}
604  static int event_x() {return e_x;}
609  static int event_y() {return e_y;}
616  static int event_x_root() {return e_x_root;}
623  static int event_y_root() {return e_y_root;}
628  static int event_dx() {return e_dx;}
633  static int event_dy() {return e_dy;}
642  static void get_mouse(int &,int &);
651  static int event_clicks() {return e_clicks;}
659  static void event_clicks(int i) {e_clicks = i;}
667  static int event_is_click() {return e_is_click;}
674  static void event_is_click(int i) {e_is_click = i;}
684  static int event_button() {return e_keysym-FL_Button;}
710  static int event_state() {return e_state;}
711 
717  static int event_state(int mask) {return e_state&mask;}
729  static int event_key() {return e_keysym;}
738  static int event_original_key(){return e_original_keysym;}
778  static int event_key(int key);
784  static int get_key(int key); // platform dependent
799  static const char* event_text() {return e_text;}
806  static int event_length() {return e_length;}
807 
811  static void *event_clipboard() { return e_clipboard_data; }
815  static const char *event_clipboard_type() {return e_clipboard_type; }
816 
817 
818  static int compose(int &del);
819  static void compose_reset();
820  static int event_inside(int,int,int,int);
821  static int event_inside(const Fl_Widget*);
822  static int test_shortcut(Fl_Shortcut);
823 
824  static void enable_im();
825  static void disable_im();
826 
827  // event destinations:
828  static int handle(int, Fl_Window*);
829  static int handle_(int, Fl_Window*);
832  static Fl_Widget* belowmouse() {return belowmouse_;}
833  static void belowmouse(Fl_Widget*);
836  static Fl_Widget* pushed() {return pushed_;}
837  static void pushed(Fl_Widget*);
839  static Fl_Widget* focus() {return focus_;}
840  static void focus(Fl_Widget*);
841  static void add_handler(Fl_Event_Handler h);
842  static void remove_handler(Fl_Event_Handler h);
843  static void add_system_handler(Fl_System_Handler h, void *data);
844  static void remove_system_handler(Fl_System_Handler h);
845  static void event_dispatch(Fl_Event_Dispatch d);
846  static Fl_Event_Dispatch event_dispatch();
852  // cut/paste:
868  static void copy(const char* stuff, int len, int destination = 0, const char *type = Fl::clipboard_plain_text); // platform dependent
869 
912  static void paste(Fl_Widget &receiver, int source, const char *type = Fl::clipboard_plain_text);
913 
935  static void add_clipboard_notify(Fl_Clipboard_Notify_Handler h, void *data = 0);
940  static void remove_clipboard_notify(Fl_Clipboard_Notify_Handler h);
944  static int clipboard_contains(const char *type);
947  static char const * const clipboard_plain_text;
950  static char const * const clipboard_image;
951 
961  static int dnd(); // platform dependent
962 
963  // These are for back-compatibility only:
966  static Fl_Widget* selection_owner() {return selection_owner_;}
967  static void selection_owner(Fl_Widget*);
968  static void selection(Fl_Widget &owner, const char*, int len);
969  static void paste(Fl_Widget &receiver);
989  static int x(); // via screen driver
990  static int y(); // via screen driver
991  static int w(); // via screen driver
992  static int h(); // via screen driver
993 
994  // multi-head support:
995  static int screen_count(); // via screen driver
996  static void screen_xywh(int &X, int &Y, int &W, int &H); // via screen driver
997  static void screen_xywh(int &X, int &Y, int &W, int &H, int mx, int my); // via screen driver
998  static void screen_xywh(int &X, int &Y, int &W, int &H, int n); // via screen driver
999  static void screen_xywh(int &X, int &Y, int &W, int &H, int mx, int my, int mw, int mh); // via screen driver
1000  static int screen_num(int x, int y); // via screen driver
1001  static int screen_num(int x, int y, int w, int h); // via screen driver
1002  static void screen_dpi(float &h, float &v, int n=0); // via screen driver
1003  static void screen_work_area(int &X, int &Y, int &W, int &H, int mx, int my); // via screen driver
1004  static void screen_work_area(int &X, int &Y, int &W, int &H, int n); // via screen driver
1005  static void screen_work_area(int &X, int &Y, int &W, int &H); // via screen driver
1006  static float screen_scale(int n); // via screen driver
1007  static void screen_scale(int n, float factor); // via screen driver
1008  static int screen_scaling_supported();
1009  static void keyboard_screen_scaling(int value);
1010 
1019  // color map:
1020  static void set_color(Fl_Color, uchar, uchar, uchar);
1021  static void set_color(Fl_Color, uchar, uchar, uchar, uchar);
1026  static void set_color(Fl_Color i, unsigned c); // platform dependent
1027  static unsigned get_color(Fl_Color i);
1028  static void get_color(Fl_Color i, uchar &red, uchar &green, uchar &blue);
1029  static void get_color(Fl_Color i, uchar &red, uchar &green, uchar &blue, uchar &alpha);
1035  static void free_color(Fl_Color i, int overlay = 0); // platform dependent
1036 
1037  // fonts:
1038  static const char* get_font(Fl_Font);
1051  static const char* get_font_name(Fl_Font, int* attributes = 0);
1063  static int get_font_sizes(Fl_Font, int*& sizep);
1064  static void set_font(Fl_Font, const char*);
1065  static void set_font(Fl_Font, Fl_Font);
1084  static Fl_Font set_fonts(const char* = 0); // platform dependent
1085 
1092  // <Hack to re-order the 'Drawing functions' group>
1095  // labeltypes:
1096  static void set_labeltype(Fl_Labeltype,Fl_Label_Draw_F*,Fl_Label_Measure_F*);
1098  static void set_labeltype(Fl_Labeltype, Fl_Labeltype from); // is it defined ?
1099 
1100  // boxtypes:
1101  static Fl_Box_Draw_F *get_boxtype(Fl_Boxtype);
1102  static void set_boxtype(Fl_Boxtype, Fl_Box_Draw_F*,uchar,uchar,uchar,uchar);
1103  static void set_boxtype(Fl_Boxtype, Fl_Boxtype from);
1104  static int box_dx(Fl_Boxtype);
1105  static int box_dy(Fl_Boxtype);
1106  static int box_dw(Fl_Boxtype);
1107  static int box_dh(Fl_Boxtype);
1108 
1109  static int draw_box_active();
1110  static Fl_Color box_color(Fl_Color);
1111  static void set_box_color(Fl_Color);
1112 
1113  // back compatibility:
1117  static void set_abort(Fl_Abort_Handler f) {fatal = f;}
1118  static void (*atclose)(Fl_Window*,void*);
1119  static void default_atclose(Fl_Window*,void*);
1123  static void set_atclose(Fl_Atclose_Handler f) {atclose = f;}
1129  static int event_shift() {return e_state&FL_SHIFT;}
1131  static int event_ctrl() {return e_state&FL_CTRL;}
1133  static int event_command() {return e_state&FL_COMMAND;}
1135  static int event_alt() {return e_state&FL_ALT;}
1144  static int event_buttons() {return e_state&0x7f000000;}
1149  static int event_button1() {return e_state&FL_BUTTON1;}
1154  static int event_button2() {return e_state&FL_BUTTON2;}
1159  static int event_button3() {return e_state&FL_BUTTON3;}
1167  static void set_idle(Fl_Old_Idle_Handler cb) {idle = cb;}
1169  static void grab(Fl_Window& win) {grab(&win);}
1173  static void release() {grab(0);}
1174 
1175  // Visible focus methods...
1181  static void visible_focus(int v) { option(OPTION_VISIBLE_FOCUS, (v!=0)); }
1187  static int visible_focus() { return option(OPTION_VISIBLE_FOCUS); }
1188 
1189  // Drag-n-drop text operation methods...
1196  static void dnd_text_ops(int v) { option(OPTION_DND_TEXT, (v!=0)); }
1203  static int dnd_text_ops() { return option(OPTION_DND_TEXT); }
1208  // Multithreading support:
1209  static int lock();
1210  static void unlock();
1211  static void awake(void* message = 0);
1213  static int awake(Fl_Awake_Handler cb, void* message = 0);
1220  static void* thread_message(); // platform dependent
1252  // Widget deletion:
1253  static void delete_widget(Fl_Widget *w);
1254  static void do_widget_deletion();
1255  static void watch_widget_pointer(Fl_Widget *&w);
1256  static void release_widget_pointer(Fl_Widget *&w);
1257  static void clear_widget_pointer(Fl_Widget const *w);
1264  static void use_high_res_GL(int val) { use_high_res_GL_ = val; }
1270  static int use_high_res_GL() { return use_high_res_GL_; }
1271 
1283  static void draw_GL_text_with_textures(int val) { draw_GL_text_with_textures_ = val; }
1284 
1290  static int draw_GL_text_with_textures() { return draw_GL_text_with_textures_; }
1291 
1292  static int system(const char *command);
1293 
1294 #ifdef FLTK_HAVE_CAIRO
1298 public:
1299  // Cairo support API
1300  static cairo_t * cairo_make_current(Fl_Window* w);
1315  static void cairo_autolink_context(bool alink) {cairo_state_.autolink(alink);}
1323  static bool cairo_autolink_context() {return cairo_state_.autolink();}
1325  static cairo_t * cairo_cc() { return cairo_state_.cc(); }
1330  static void cairo_cc(cairo_t * c, bool own=false){ cairo_state_.cc(c, own); }
1331 
1332 private:
1333  static cairo_t * cairo_make_current(void* gc);
1334  static cairo_t * cairo_make_current(void* gc, int W, int H);
1335  static Fl_Cairo_State cairo_state_;
1336 public:
1339 #endif // FLTK_HAVE_CAIRO
1340 
1341 };
1342 
1385 class FL_EXPORT Fl_Widget_Tracker {
1386 
1387  Fl_Widget* wp_;
1388 
1389 public:
1390 
1392  ~Fl_Widget_Tracker();
1393 
1399  Fl_Widget *widget() {return wp_;}
1400 
1410  int deleted() {return wp_ == 0;}
1411 
1421  int exists() {return wp_ != 0;}
1422 
1423 };
1424 
1430 #endif // !Fl_H
This file contains type definitions and general enumerations.
#define FL_BUTTON2
Mouse button 2 is pushed.
Definition: Enumerations.H:550
#define FL_Button
A mouse button; use Fl_Button + n for mouse button n.
Definition: Enumerations.H:449
#define FL_CTRL
One of the ctrl keys is down.
Definition: Enumerations.H:541
int Fl_Font
A font number is an index into the internal font table.
Definition: Enumerations.H:985
unsigned Fl_Align
FLTK type for alignment control.
Definition: Enumerations.H:908
#define FL_ALT
One of the alt keys is down.
Definition: Enumerations.H:542
#define FL_ABI_VERSION
The FLTK ABI (Application Binary Interface) version number as an int.
Definition: Enumerations.H:171
unsigned int Fl_Color
An FLTK color value; see also Colors
Definition: Enumerations.H:1042
#define FL_BUTTON3
Mouse button 3 is pushed.
Definition: Enumerations.H:551
#define FL_SHIFT
One of the shift keys is down.
Definition: Enumerations.H:539
Fl_Labeltype
The labeltype() method sets the type of the label.
Definition: Enumerations.H:757
Fl_Boxtype
FLTK standard box types.
Definition: Enumerations.H:598
#define FL_BUTTON1
Mouse button 1 is pushed.
Definition: Enumerations.H:549
FL_EXPORT const char * fl_local_meta
string pointer used in shortcuts, you can change it to another language
Definition: Fl.cxx:2215
FL_EXPORT const char * fl_local_shift
string pointer used in shortcuts, you can change it to another language
Definition: Fl.cxx:2214
FL_EXPORT const char * fl_local_ctrl
string pointer used in shortcuts, you can change it to another language
Definition: Fl.cxx:2217
FL_EXPORT const char * fl_local_alt
string pointer used in shortcuts, you can change it to another language
Definition: Fl.cxx:2216
Contains all the necessary info on the current cairo context.
Definition: Fl_Cairo.H:49
Base class for image caching, scaling and drawing.
Definition: Fl_Image.H:60
This class should be used to control safe widget deletion.
Definition: Fl.H:1385
int exists()
Returns 1, if the watched widget exists (has not been deleted).
Definition: Fl.H:1421
int deleted()
Returns 1, if the watched widget has been deleted.
Definition: Fl.H:1410
Fl_Widget * widget()
Returns a pointer to the watched widget.
Definition: Fl.H:1399
Fl_Widget is the base class for all widgets in FLTK.
Definition: Fl_Widget.H:85
This widget produces an actual window.
Definition: Fl_Window.H:52
The Fl is the FLTK global (static) class containing state information and global methods for the curr...
Definition: Fl.H:137
static int is_scheme(const char *name)
Returns whether the current scheme is the given name.
Definition: Fl.H:419
static int draw_GL_text_with_textures()
returns whether whether OpenGL uses textures to draw all text.
Definition: Fl.H:1290
static int program_should_quit()
Returns non-zero when a request for program termination was received and accepted.
Definition: Fl.H:445
static void use_high_res_GL(int val)
sets whether GL windows should be drawn at high resolution on Apple computers with retina displays
Definition: Fl.H:1264
static int box_border_radius_max()
Get the maximum border radius of all "rounded" boxtypes in pixels.
Definition: Fl.H:170
@ OPTION_FNFC_USES_GTK
When switched on (default), Fl_Native_File_Chooser runs GTK file dialogs if the GTK library is availa...
Definition: Fl.H:265
@ OPTION_DND_TEXT
If text drag-and-drop is enabled (default), the user can select and drag text from any text widget.
Definition: Fl.H:257
@ OPTION_PRINTER_USES_GTK
When switched on (default), Fl_Printer runs the GTK printer dialog if the GTK library is available on...
Definition: Fl.H:269
@ OPTION_SHOW_SCALING
When switched on (default), the library shows in a transient yellow window the zoom factor value.
Definition: Fl.H:273
@ OPTION_VISIBLE_FOCUS
If visible focus is switched on (default), FLTK will draw a dotted rectangle inside the widget that w...
Definition: Fl.H:253
@ OPTION_SHOW_TOOLTIPS
If tooltips are enabled (default), hovering the mouse over a widget with a tooltip text will open a l...
Definition: Fl.H:261
static void damage(int d)
If true then flush() will do something.
Definition: Fl.H:219
static const char * scheme()
See void scheme(const char *name)
Definition: Fl.H:390
static int box_shadow_width()
Get the box shadow width of all "shadow" boxtypes in pixels.
Definition: Fl.H:160
static void dnd_text_ops(int v)
Sets whether drag and drop text operations are supported.
Definition: Fl.H:1196
static const char *const help
Usage string displayed if Fl::args() detects an invalid argument.
Definition: Fl.H:366
static void box_border_radius_max(int R)
Set the maximum border radius of all "rounded" boxtypes in pixels.
Definition: Fl.H:183
static void release()
Releases the current grabbed window, equals grab(0).
Definition: Fl.H:1173
static void set_idle(Fl_Old_Idle_Handler cb)
Sets an idle callback.
Definition: Fl.H:1167
static int gl_visual(int, int *alist=0)
This does the same thing as Fl::visual(int) but also requires OpenGL drawing to work.
static void program_should_quit(int should_i)
Indicate to the FLTK library whether a program termination request was received and accepted.
Definition: Fl.H:451
static int use_high_res_GL()
returns whether GL windows should be drawn at high resolution on Apple computers with retina displays...
Definition: Fl.H:1270
static void draw_GL_text_with_textures(int val)
sets whether OpenGL uses textures to draw all text.
Definition: Fl.H:1283
static int dnd_text_ops()
Gets whether drag and drop text operations are supported.
Definition: Fl.H:1203
static void grab(Fl_Window &win)
See grab(Fl_Window*)
Definition: Fl.H:1169
static int damage()
If true then flush() will do something.
Definition: Fl.H:481
static void box_shadow_width(int W)
Set the box shadow width of all "shadow" boxtypes in pixels.
Definition: Fl.H:165
static void set_labeltype(Fl_Labeltype, Fl_Labeltype from)
Sets the functions to call to draw and measure a specific labeltype.
static void visible_focus(int v)
Gets or sets the visible keyboard focus on buttons and other non-text widgets.
Definition: Fl.H:1181
static int visible_focus()
Gets or sets the visible keyboard focus on buttons and other non-text widgets.
Definition: Fl.H:1187
static int abi_check(const int val=FL_ABI_VERSION)
Returns whether the runtime library ABI version is correct.
Definition: Fl.H:354
unsigned int Fl_Shortcut
16-bit Unicode character + 8-bit indicator for keyboard flags.
Definition: fl_types.h:53
unsigned char uchar
unsigned char
Definition: fl_types.h:28
header for Unicode and UTF-8 character handling
int(* Fl_System_Handler)(void *event, void *data)
Signature of add_system_handler functions passed as parameters.
Definition: Fl.H:112
void(* Fl_Timeout_Handler)(void *data)
Signature of timeout callback functions passed as parameters.
Definition: Fl.H:94
int(* Fl_Event_Handler)(int event)
Signature of add_handler functions passed as parameters.
Definition: Fl.H:109
void(* Fl_Old_Idle_Handler)()
Signature of set_idle callback functions passed as parameters.
Definition: Fl.H:103
void(* Fl_Awake_Handler)(void *data)
Signature of some wakeup callback functions passed as parameters.
Definition: Fl.H:97
void(* Fl_FD_Handler)(FL_SOCKET fd, void *data)
Signature of add_fd functions passed as parameters.
Definition: Fl.H:106
int(* Fl_Event_Dispatch)(int event, Fl_Window *w)
Signature of event_dispatch functions passed as parameters.
Definition: Fl.H:125
void() Fl_Label_Draw_F(const Fl_Label *label, int x, int y, int w, int h, Fl_Align align)
Signature of some label drawing functions passed as parameters.
Definition: Fl.H:83
int(* Fl_Args_Handler)(int argc, char **argv, int &i)
Signature of args functions passed as parameters.
Definition: Fl.H:121
void() Fl_Label_Measure_F(const Fl_Label *label, int &width, int &height)
Signature of some label measurement functions passed as parameters.
Definition: Fl.H:86
void(* Fl_Abort_Handler)(const char *format,...)
Signature of set_abort functions passed as parameters.
Definition: Fl.H:115
void(* Fl_Atclose_Handler)(Fl_Window *window, void *data)
Signature of set_atclose functions passed as parameters.
Definition: Fl.H:118
void(* Fl_Idle_Handler)(void *data)
Signature of add_idle callback functions passed as parameters.
Definition: Fl.H:100
void() Fl_Box_Draw_F(int x, int y, int w, int h, Fl_Color color)
Signature of some box drawing functions passed as parameters.
Definition: Fl.H:89
void(* Fl_Clipboard_Notify_Handler)(int source, void *data)
Signature of add_clipboard_notify functions passed as parameters.
Definition: Fl.H:128
static char const *const clipboard_image
Denotes image data.
Definition: Fl.H:950
static char const *const clipboard_plain_text
Denotes plain textual data.
Definition: Fl.H:947
static Fl_Widget * selection_owner()
back-compatibility only: Gets the widget owning the current selection
Definition: Fl.H:966
static void event_clicks(int i)
Manually sets the number returned by Fl::event_clicks().
Definition: Fl.H:659
static void event_is_click(int i)
Clears the value returned by Fl::event_is_click().
Definition: Fl.H:674
static int event_y()
Returns the mouse position of the event relative to the Fl_Window it was passed to.
Definition: Fl.H:609
static int event_key()
Gets which key on the keyboard was last pushed.
Definition: Fl.H:729
static int event_alt()
Returns non-zero if the Alt key is pressed.
Definition: Fl.H:1135
static int event_length()
Returns the length of the text in Fl::event_text().
Definition: Fl.H:806
static int event_state(int mask)
Returns non-zero if any of the passed event state bits are turned on.
Definition: Fl.H:717
static int event_dy()
Returns the current vertical mouse scrolling associated with the FL_MOUSEWHEEL event.
Definition: Fl.H:633
static const char * event_clipboard_type()
Returns the type of the pasted data during an FL_PASTE event.
Definition: Fl.H:815
static int event_x_root()
Returns the mouse position on the screen of the event.
Definition: Fl.H:616
static void * event_clipboard()
During an FL_PASTE event of non-textual data, returns a pointer to the pasted data.
Definition: Fl.H:811
static Fl_Widget * belowmouse()
Gets the widget that is below the mouse.
Definition: Fl.H:832
static const char * event_text()
Returns the text associated with the current event, including FL_PASTE or FL_DND_RELEASE events.
Definition: Fl.H:799
static int event_button1()
Returns non-zero if mouse button 1 is currently held down.
Definition: Fl.H:1149
static int event_button3()
Returns non-zero if button 3 is currently held down.
Definition: Fl.H:1159
static int event_command()
Returns non-zero if the FL_COMMAND key is pressed, either FL_CTRL or on OSX FL_META.
Definition: Fl.H:1133
static int event_button()
Gets which particular mouse button caused the current event.
Definition: Fl.H:684
static Fl_Widget * focus()
Gets the current Fl::focus() widget.
Definition: Fl.H:839
static int event_x()
Returns the mouse position of the event relative to the Fl_Window it was passed to.
Definition: Fl.H:604
static int event_y_root()
Returns the mouse position on the screen of the event.
Definition: Fl.H:623
static int event_shift()
Returns non-zero if the Shift key is pressed.
Definition: Fl.H:1129
static int event()
Returns the last event that was processed.
Definition: Fl.H:599
static int event_ctrl()
Returns non-zero if the Control key is pressed.
Definition: Fl.H:1131
static int event_button2()
Returns non-zero if button 2 is currently held down.
Definition: Fl.H:1154
static Fl_Widget * pushed()
Gets the widget that is being pushed.
Definition: Fl.H:836
static int event_dx()
Returns the current horizontal mouse scrolling associated with the FL_MOUSEWHEEL event.
Definition: Fl.H:628
static int event_original_key()
Returns the keycode of the last key event, regardless of the NumLock state.
Definition: Fl.H:738
static int event_is_click()
Returns non-zero if the mouse has not moved far enough and not enough time has passed since the last ...
Definition: Fl.H:667
static int event_buttons()
Returns the mouse buttons state bits; if non-zero, then at least one button is pressed now.
Definition: Fl.H:1144
static int event_state()
Returns the keyboard and mouse button states of the last event.
Definition: Fl.H:710
static int event_clicks()
Returns non zero if we had a double click event.
Definition: Fl.H:651
static Fl_Window * grab()
Returns the window that currently receives all events.
Definition: Fl.H:561
static void set_abort(Fl_Abort_Handler f)
For back compatibility, sets the void Fl::fatal handler callback.
Definition: Fl.H:1117
static Fl_Window * modal()
Returns the top-most modal() window currently shown.
Definition: Fl.H:555
static void set_atclose(Fl_Atclose_Handler f)
For back compatibility, sets the Fl::atclose handler callback.
Definition: Fl.H:1123
static void cairo_cc(cairo_t *c, bool own=false)
Sets the current cairo context to c.
Definition: Fl.H:1330
static cairo_t * cairo_cc()
Gets the current cairo context linked with a fltk window.
Definition: Fl.H:1325
static bool cairo_autolink_context()
Gets the current autolink mode for cairo support.
Definition: Fl.H:1323
static void cairo_autolink_context(bool alink)
when FLTK_HAVE_CAIRO is defined and cairo_autolink_context() is true, any current window dc is linked...
Definition: Fl.H:1315
Definitions of platform-dependent types.
#define FL_COMMAND
An alias for FL_CTRL on Windows and X11, or FL_META on MacOS X.
Definition: platform_types.h:65
opaque FL_SOCKET
socket or file descriptor
Definition: platform_types.h:54
This struct stores all information for a text or mixed graphics label.
Definition: Fl_Widget.H:48