FLTK 1.5.0
Loading...
Searching...
No Matches
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-2025 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
49class Fl_Widget;
50class Fl_Window;
51class Fl_Image;
52struct Fl_Label;
53class Fl_Screen_Driver;
54class 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
59extern FL_EXPORT const char* fl_local_alt;
60extern FL_EXPORT const char* fl_local_ctrl;
61extern FL_EXPORT const char* fl_local_meta;
62extern FL_EXPORT const char* fl_local_shift;
63
83typedef void (Fl_Label_Draw_F)(const Fl_Label *label, int x, int y, int w, int h, Fl_Align align);
84
86typedef void (Fl_Label_Measure_F)(const Fl_Label *label, int &width, int &height);
87
89typedef void (Fl_Box_Draw_F)(int x, int y, int w, int h, Fl_Color color);
90
92typedef void (Fl_Box_Draw_Focus_F)(Fl_Boxtype bt, int x, int y, int w, int h, Fl_Color fg, Fl_Color bg);
93
97typedef void (*Fl_Timeout_Handler)(void *data);
98
100typedef void (*Fl_Awake_Handler)(void *data);
101
106typedef void (*Fl_Idle_Handler)(void *data);
107
113typedef void (*Fl_Old_Idle_Handler)();
114
116typedef void (*Fl_FD_Handler)(FL_SOCKET fd, void *data);
117
119typedef int (*Fl_Event_Handler)(int event);
120
122typedef int (*Fl_System_Handler)(void *event, void *data);
123
125typedef void (*Fl_Abort_Handler)(const char *format,...);
126
128typedef void (*Fl_Atclose_Handler)(Fl_Window *window, void *data);
129
131typedef int (*Fl_Args_Handler)(int argc, char **argv, int &i);
132
135typedef int (*Fl_Event_Dispatch)(int event, Fl_Window *w);
136
138typedef void (*Fl_Clipboard_Notify_Handler)(int source, void *data);
139
/* group callback_functions */
141
142
147class FL_EXPORT Fl {
148 friend class Fl_System_Driver;
149 Fl() {} // no constructor!
150
151private:
152
153 static int use_high_res_GL_;
154 static int draw_GL_text_with_textures_;
155 static int box_shadow_width_;
156 static int box_border_radius_max_;
157 static int selection_to_clipboard_;
158
159public:
160
161 static Fl_Screen_Driver *screen_driver();
162 static Fl_System_Driver *system_driver();
163#ifdef __APPLE__ // deprecated in 1.4 - only for compatibility with 1.3
164 static void reset_marked_text();
165 static void insertion_point_location(int x, int y, int height);
166#endif
167
168
172 static int box_shadow_width() { return box_shadow_width_; }
177 static void box_shadow_width(int W) { box_shadow_width_ = W < 1 ? 1 : W; }
178
182 static int box_border_radius_max() { return box_border_radius_max_; }
195 static void box_border_radius_max(int R) { box_border_radius_max_ = R < 5 ? 5 : R; }
196
197public: // should be private!
198
199#ifndef FL_DOXYGEN
200 static int e_number;
201 static int e_x;
202 static int e_y;
203 static int e_x_root;
204 static int e_y_root;
205 static int e_dx;
206 static int e_dy;
207 static int e_state;
208 static int e_clicks;
209 static int e_is_click;
210 static int e_keysym;
211 static char* e_text;
212 static int e_length;
213 static void *e_clipboard_data;
214 static const char *e_clipboard_type;
215 static Fl_Event_Dispatch e_dispatch;
216 static Fl_Callback_Reason callback_reason_;
217 static Fl_Widget* belowmouse_;
218 static Fl_Widget* pushed_;
219 static Fl_Widget* focus_;
220 static int damage_;
221 static Fl_Widget* selection_owner_;
222 static Fl_Window* modal_;
223 static Fl_Window* grab_;
224 static int compose_state; // used for dead keys (Windows) or marked text (MacOS)
225 static void call_screen_init(); // recompute screen number and dimensions
226#endif // FL_DOXYGEN
227
228
232 static void damage(int d) {damage_ = d;}
233
234public:
241 typedef enum {
251 OPTION_ARROW_FOCUS = 0,
252 // When switched on, FLTK will use the file chooser dialog that comes
253 // with your operating system whenever possible. When switched off, FLTK
254 // will present its own file chooser.
255 // \todo implement me
256 // OPTION_NATIVE_FILECHOOSER,
257 // When Filechooser Preview is enabled, the FLTK or native file chooser
258 // will show a preview of a selected file (if possible) before the user
259 // decides to choose the file.
260 // \todo implement me
261 //OPTION_FILECHOOSER_PREVIEW,
266 OPTION_VISIBLE_FOCUS,
270 OPTION_DND_TEXT,
274 OPTION_SHOW_TOOLTIPS,
278 OPTION_FNFC_USES_GTK,
281 OPTION_FNFC_USES_ZENITY,
285 OPTION_FNFC_USES_KDIALOG,
289 OPTION_PRINTER_USES_GTK,
293 OPTION_SHOW_SCALING,
299 OPTION_SIMPLE_ZOOM_SHORTCUT,
300 // don't change this, leave it always as the last element
302 OPTION_LAST
303 } Fl_Option;
304
305private:
306 static unsigned char options_[OPTION_LAST];
307 static unsigned char options_read_;
308 static int program_should_quit_; // non-zero means the program was asked to cleanly terminate
309
310public:
311 /*
312 Return a global setting for all FLTK applications, possibly overridden
313 by a setting specifically for this application.
314 */
315 static bool option(Fl_Option opt);
316
317 /*
318 Override an option while the application is running.
319 */
320 static void option(Fl_Option opt, bool val);
321
322private:
323
331 static void (*idle_)();
332
333public:
346 static bool idle() { return (idle_ != nullptr); }
347
348#ifndef FL_DOXYGEN
349public:
350 static const char* scheme_;
351 static Fl_Image* scheme_bg_;
352
353 static int e_original_keysym; // late addition
354 static int scrollbar_size_;
355 static int menu_linespacing_; // STR #2927
356#endif
357
358public:
359
360 // API version number
361 static double version();
362 static int api_version();
363
364 // ABI version number
365 static int abi_version();
366
389 static inline int abi_check(const int val = FL_ABI_VERSION) {
390 return val == abi_version();
391 }
392
393 // argument parsers:
394 static int arg(int argc, char **argv, int& i);
395 static int args(int argc, char **argv, int& i, Fl_Args_Handler cb = 0);
396 static void args(int argc, char **argv);
401 static const char* const help;
402
403 // things called by initialization:
404 static void display(const char*);
405 static int visual(int);
415 static int gl_visual(int, int *alist=0); // platform dependent
416 static void own_colormap();
417 static void get_system_colors();
418 static void foreground(uchar, uchar, uchar);
419 static void background(uchar, uchar, uchar);
420 static void background2(uchar, uchar, uchar);
421
422 // schemes:
423 static int scheme(const char *name);
425 static const char* scheme() {return scheme_;}
426
454 static int is_scheme(const char *name) {
455 return (scheme_ && name && !strcmp(name,scheme_));
456 }
457
458 static int reload_scheme(); // defined in 'src/Fl_get_system_colors.cxx'
459
460 static int scrollbar_size();
461 static void scrollbar_size(int W);
462 static int menu_linespacing();
463 static void menu_linespacing(int H);
464
465 // execution:
466 static int wait();
467 static double wait(double time);
468 static int check();
469 static int ready();
470 static int run();
477 static int program_should_quit() {return program_should_quit_;}
483 static void program_should_quit(int should_i) { program_should_quit_ = should_i; }
484 static void hide_all_windows();
485
486 static Fl_Widget* readqueue();
487
488 //
489 // cross-platform timer support
490 //
491
492 static void add_timeout(double t, Fl_Timeout_Handler cb, void *data = 0);
493 static void repeat_timeout(double t, Fl_Timeout_Handler cb, void *data = 0);
494 static int has_timeout(Fl_Timeout_Handler cb, void *data = 0);
495 static void remove_timeout(Fl_Timeout_Handler cb, void *data = 0);
496 static int remove_next_timeout(Fl_Timeout_Handler cb, void *data = 0, void **data_return = 0);
497
498 static void add_check(Fl_Timeout_Handler, void* = 0);
499 static int has_check(Fl_Timeout_Handler, void* = 0);
500 static void remove_check(Fl_Timeout_Handler, void* = 0);
501
502 static Fl_Timestamp now(double offset = 0);
503 static double seconds_since(Fl_Timestamp& then);
504 static double seconds_between(Fl_Timestamp& back, Fl_Timestamp& further_back);
505 static long ticks_since(Fl_Timestamp& then);
506 static long ticks_between(Fl_Timestamp& back, Fl_Timestamp& further_back);
507
508private:
509 static void run_idle();
510 static void run_checks();
511public:
512 static void add_fd(int fd, int when, Fl_FD_Handler cb, void* = 0); // platform dependent
513 static void add_fd(int fd, Fl_FD_Handler cb, void* = 0); // platform dependent
515 static void remove_fd(int, int when); // platform dependent
517 static void remove_fd(int); // platform dependent
518
519 static void add_idle(Fl_Idle_Handler cb, void* data = 0);
520 static int has_idle(Fl_Idle_Handler cb, void* data = 0);
521 static void remove_idle(Fl_Idle_Handler cb, void* data = 0);
522 static void add_idle(Fl_Old_Idle_Handler cb);
524 static int damage() {return damage_;}
525 static void redraw();
526 static void flush();
547 static void (*warning)(const char*, ...);
562 static void (*error)(const char*, ...);
579 static void (*fatal)(const char*, ...);
585 static Fl_Window* first_window();
586 static void first_window(Fl_Window*);
587 static Fl_Window* next_window(const Fl_Window*);
588
598 static Fl_Window* modal() {return modal_;}
604 static Fl_Window* grab() {return grab_;}
629 static void grab(Fl_Window*); // platform dependent
636 // event information:
642 static int event() {return e_number;}
647 static int event_x() {return e_x;}
652 static int event_y() {return e_y;}
659 static int event_x_root() {return e_x_root;}
666 static int event_y_root() {return e_y_root;}
671 static int event_dx() {return e_dx;}
676 static int event_dy() {return e_dy;}
685 static void get_mouse(int &,int &);
694 static int event_clicks() {return e_clicks;}
702 static void event_clicks(int i) {e_clicks = i;}
710 static int event_is_click() {return e_is_click;}
717 static void event_is_click(int i) {e_is_click = i;}
729 static int event_button() { return e_keysym - FL_Button; }
770 static int event_state() {return e_state;}
771
777 static int event_state(int mask) {return e_state&mask;}
789 static int event_key() {return e_keysym;}
798 static int event_original_key(){return e_original_keysym;}
838 static int event_key(int key);
844 static int get_key(int key); // platform dependent
859 static const char* event_text() {return e_text;}
866 static int event_length() {return e_length;}
867
871 static void *event_clipboard() { return e_clipboard_data; }
875 static const char *event_clipboard_type() {return e_clipboard_type; }
876
877
878 static int compose(int &del);
879 static void compose_reset();
880 static int event_inside(int,int,int,int);
881 static int event_inside(const Fl_Widget*);
882 static int test_shortcut(Fl_Shortcut);
883
884 static void enable_im();
885 static void disable_im();
886
887 // event destinations:
888 static int handle(int, Fl_Window*);
889 static int handle_(int, Fl_Window*);
892 static Fl_Widget* belowmouse() {return belowmouse_;}
893 static void belowmouse(Fl_Widget*);
896 static Fl_Widget* pushed() {return pushed_;}
897 static void pushed(Fl_Widget*);
899 static Fl_Widget* focus() {return focus_;}
900 static void focus(Fl_Widget*);
901 static void add_handler(Fl_Event_Handler ha);
902 static void add_handler(Fl_Event_Handler ha, Fl_Event_Handler before);
903 static Fl_Event_Handler last_handler();
904 static void remove_handler(Fl_Event_Handler h);
905 static void add_system_handler(Fl_System_Handler h, void *data);
906 static void remove_system_handler(Fl_System_Handler h);
907 static void event_dispatch(Fl_Event_Dispatch d);
908 static Fl_Event_Dispatch event_dispatch();
909 static Fl_Callback_Reason callback_reason();
955 static void copy(const char *stuff, int len, int destination = 0,
956 const char *type = Fl::clipboard_plain_text);
957
985 static void selection_to_clipboard(int mode) {
986 selection_to_clipboard_ = mode ? 1 : 0;
987 }
988
994 static int selection_to_clipboard() { return selection_to_clipboard_; }
995
1038 static void paste(Fl_Widget &receiver, int source, const char *type = Fl::clipboard_plain_text);
1039
1061 static void add_clipboard_notify(Fl_Clipboard_Notify_Handler h, void *data = 0);
1066 static void remove_clipboard_notify(Fl_Clipboard_Notify_Handler h);
1075 static int clipboard_contains(const char *type);
1078 static char const * const clipboard_plain_text;
1081 static char const * const clipboard_image;
1082
1092 static int dnd(); // platform dependent
1093
1094 // These are for back-compatibility only:
1097 static Fl_Widget* selection_owner() {return selection_owner_;}
1098 static void selection_owner(Fl_Widget*);
1099 static void selection(Fl_Widget &owner, const char*, int len);
1100 static void paste(Fl_Widget &receiver);
1117 static int x(); // via screen driver
1118 static int y(); // via screen driver
1119 static int w(); // via screen driver
1120 static int h(); // via screen driver
1121
1122 // multi-head support:
1123 static int screen_count(); // via screen driver
1124 static void screen_xywh(int &X, int &Y, int &W, int &H); // via screen driver
1125 static void screen_xywh(int &X, int &Y, int &W, int &H, int mx, int my); // via screen driver
1126 static void screen_xywh(int &X, int &Y, int &W, int &H, int n); // via screen driver
1127 static void screen_xywh(int &X, int &Y, int &W, int &H, int mx, int my, int mw, int mh); // via screen driver
1128 static int screen_num(int x, int y); // via screen driver
1129 static int screen_num(int x, int y, int w, int h); // via screen driver
1130 static void screen_dpi(float &h, float &v, int n=0); // via screen driver
1131 static void screen_work_area(int &X, int &Y, int &W, int &H, int mx, int my); // via screen driver
1132 static void screen_work_area(int &X, int &Y, int &W, int &H, int n); // via screen driver
1133 static void screen_work_area(int &X, int &Y, int &W, int &H); // via screen driver
1134 static float screen_scale(int n); // via screen driver
1135 static void screen_scale(int n, float factor); // via screen driver
1136 static int screen_scaling_supported();
1137 static void keyboard_screen_scaling(int value);
1138
1147 // color map:
1148 static void set_color(Fl_Color, uchar, uchar, uchar);
1149 static void set_color(Fl_Color, uchar, uchar, uchar, uchar);
1154 static void set_color(Fl_Color i, unsigned c); // platform dependent
1155 static unsigned get_color(Fl_Color i);
1156 static void get_color(Fl_Color i, uchar &red, uchar &green, uchar &blue);
1157 static void get_color(Fl_Color i, uchar &red, uchar &green, uchar &blue, uchar &alpha);
1163 static void free_color(Fl_Color i, int overlay = 0); // platform dependent
1164
1165 // fonts:
1166 static const char* get_font(Fl_Font);
1179 static const char* get_font_name(Fl_Font, int* attributes = 0);
1191 static int get_font_sizes(Fl_Font, int*& sizep);
1192 static void set_font(Fl_Font, const char*);
1193 static void set_font(Fl_Font, Fl_Font);
1221 static Fl_Font set_fonts(const char* = 0); // platform dependent
1222
1229 // <Hack to re-order the 'Drawing functions' group>
1232 // labeltypes:
1233 static void set_labeltype(Fl_Labeltype,Fl_Label_Draw_F*,Fl_Label_Measure_F*);
1235 static void set_labeltype(Fl_Labeltype, Fl_Labeltype from); // is it defined ?
1236
1237 // boxtypes:
1238 static Fl_Box_Draw_F *get_boxtype(Fl_Boxtype);
1239 static void set_boxtype(Fl_Boxtype, Fl_Box_Draw_F*,
1240 uchar, uchar, uchar, uchar,
1241 Fl_Box_Draw_Focus_F* =NULL);
1242 static void set_boxtype(Fl_Boxtype, Fl_Boxtype from);
1243 static int box_dx(Fl_Boxtype);
1244 static int box_dy(Fl_Boxtype);
1245 static int box_dw(Fl_Boxtype);
1246 static int box_dh(Fl_Boxtype);
1247
1248 static int draw_box_active();
1249 static Fl_Color box_color(Fl_Color);
1250 static void set_box_color(Fl_Color);
1251
1252 // back compatibility:
1256 static void set_abort(Fl_Abort_Handler f) {fatal = f;}
1257 static void (*atclose)(Fl_Window*,void*);
1258 static void default_atclose(Fl_Window*,void*);
1262 static void set_atclose(Fl_Atclose_Handler f) {atclose = f;}
1268 static int event_shift() {return e_state&FL_SHIFT;}
1270 static int event_ctrl() {return e_state&FL_CTRL;}
1272 static int event_command() {return e_state&FL_COMMAND;}
1274 static int event_alt() {return e_state&FL_ALT;}
1283 static int event_buttons() {return e_state & FL_BUTTONS;}
1288 static int event_button1() {return e_state & FL_BUTTON1;}
1293 static int event_button2() {return e_state & FL_BUTTON2;}
1298 static int event_button3() {return e_state & FL_BUTTON3;}
1303 static int event_button4() {return e_state & FL_BUTTON4;}
1308 static int event_button5() {return e_state & FL_BUTTON5;}
1311private:
1321 static void set_idle_(Fl_Old_Idle_Handler cb) {idle_ = cb;}
1322public:
1324 static void grab(Fl_Window& win) {grab(&win);}
1325
1326 // Visible focus methods...
1332 static void visible_focus(int v) { option(OPTION_VISIBLE_FOCUS, (v!=0)); }
1338 static int visible_focus() { return option(OPTION_VISIBLE_FOCUS); }
1339
1340 // Drag-n-drop text operation methods...
1347 static void dnd_text_ops(int v) { option(OPTION_DND_TEXT, (v!=0)); }
1354 static int dnd_text_ops() { return option(OPTION_DND_TEXT); }
1355
1356 // --- FLTK Multithreading support functions ---
1360 // Thread locking:
1361 static int lock();
1362 static void unlock();
1363 // Thread wakup and defered calls:
1364 static void awake();
1365 FL_DEPRECATED("since 1.5.0 - use Fl::awake() or Fl::awake(handler, user_data) instead",
1366 static void awake(void* message));
1367 static int awake(Fl_Awake_Handler handler, void* user_data=nullptr);
1368 static int awake_once(Fl_Awake_Handler handler, void* user_data=nullptr);
1369 FL_DEPRECATED("since 1.5.0 - use Fl::awake() or Fl::awake(handler, user_data) instead",
1370 static void* thread_message()); // platform dependent
1402 // Widget deletion:
1403 static void delete_widget(Fl_Widget *w);
1404 static void do_widget_deletion();
1405 static void watch_widget_pointer(Fl_Widget *&w);
1406 static void release_widget_pointer(Fl_Widget *&w);
1407 static void clear_widget_pointer(Fl_Widget const *w);
1414 static void use_high_res_GL(int val) { use_high_res_GL_ = val; }
1420 static int use_high_res_GL() { return use_high_res_GL_; }
1421
1433 static void draw_GL_text_with_textures(int val) { draw_GL_text_with_textures_ = val; }
1434
1440 static int draw_GL_text_with_textures() { return draw_GL_text_with_textures_; }
1441
1442 static int system(const char *command);
1443
1444 // Convert Windows commandline arguments to UTF-8 (documented in src/Fl.cxx)
1445 static int args_to_utf8(int argc, char ** &argv);
1446
1447#ifdef FLTK_HAVE_CAIRO
1451public:
1452 // Cairo support API
1453
1454 static cairo_t *cairo_make_current(Fl_Window *w);
1455
1471 static void cairo_autolink_context(bool alink) {
1472 cairo_state_.autolink(alink);
1473 }
1474
1483 static bool cairo_autolink_context() {
1484 return cairo_state_.autolink();
1485 }
1486
1488 static cairo_t *cairo_cc() {
1489 return cairo_state_.cc();
1490 }
1491
1497 static void cairo_cc(cairo_t *c, bool own=false) {
1498 cairo_state_.cc(c, own);
1499 }
1500
1534 static void cairo_flush(cairo_t *c) {
1535 // flush Cairo drawings: necessary at least for Windows
1536 cairo_surface_t *s = cairo_get_target(c);
1537 cairo_surface_flush(s);
1538 }
1539
1540private:
1541 static cairo_t *cairo_make_current(void *gc);
1542 static cairo_t *cairo_make_current(void *gc, int W, int H);
1543 static Fl_Cairo_State cairo_state_;
1544
1545public:
1548#endif // FLTK_HAVE_CAIRO
1549
1550};
1551
1594class FL_EXPORT Fl_Widget_Tracker {
1595
1596 Fl_Widget* wp_;
1597
1598public:
1599
1600 Fl_Widget_Tracker(Fl_Widget *wi);
1601 ~Fl_Widget_Tracker();
1602
1608 Fl_Widget *widget() {return wp_;}
1609
1619 int deleted() {return wp_ == 0;}
1620
1630 int exists() {return wp_ != 0;}
1631
1632};
1633
1639#endif // !Fl_H
Enumerations.H
This file contains type definitions and general enumerations.
FL_BUTTON2
#define FL_BUTTON2
Mouse button 2 is pushed (M)
Definition Enumerations.H:510
FL_Button
#define FL_Button
A mouse button; use FL_Button + n for mouse button n.
Definition Enumerations.H:404
FL_CTRL
#define FL_CTRL
One of the ctrl keys is down.
Definition Enumerations.H:499
Fl_Font
int Fl_Font
A font number is an index into the internal font table.
Definition Enumerations.H:981
Fl_Align
unsigned Fl_Align
FLTK type for alignment control.
Definition Enumerations.H:904
FL_ALT
#define FL_ALT
One of the alt keys is down.
Definition Enumerations.H:500
FL_BUTTONS
#define FL_BUTTONS
Bitmask: any mouse button (1-5) is pushed.
Definition Enumerations.H:514
Fl_Color
unsigned int Fl_Color
An FLTK color value; see also Colors
Definition Enumerations.H:1038
FL_BUTTON5
#define FL_BUTTON5
Mouse button 5 is pushed (FORWARD)
Definition Enumerations.H:513
FL_BUTTON3
#define FL_BUTTON3
Mouse button 3 is pushed (R)
Definition Enumerations.H:511
FL_SHIFT
#define FL_SHIFT
One of the shift keys is down.
Definition Enumerations.H:497
FL_BUTTON4
#define FL_BUTTON4
Mouse button 4 is pushed (BACK)
Definition Enumerations.H:512
Fl_Labeltype
Fl_Labeltype
The labeltype() method sets the type of the label.
Definition Enumerations.H:753
Fl_Boxtype
Fl_Boxtype
FLTK standard box types.
Definition Enumerations.H:562
Fl_Callback_Reason
Fl_Callback_Reason
These constants describe why a callback is performed.
Definition Enumerations.H:373
FL_BUTTON1
#define FL_BUTTON1
Mouse button 1 is pushed (L)
Definition Enumerations.H:509
fl_local_shift
const char * fl_local_shift
string pointer used in shortcuts, you can change it to another language
Definition Fl.cxx:2440
fl_local_ctrl
const char * fl_local_ctrl
string pointer used in shortcuts, you can change it to another language
Definition Fl.cxx:2443
fl_local_meta
const char * fl_local_meta
string pointer used in shortcuts, you can change it to another language
Definition Fl.cxx:2441
fl_local_alt
const char * fl_local_alt
string pointer used in shortcuts, you can change it to another language
Definition Fl.cxx:2442
Fl_Cairo.H
Cairo is currently supported for the following platforms: Windows, macOS, Unix/Linux (X11 + Wayland).
Fl_Cairo_State
Contains all the necessary info on the current cairo context.
Definition Fl_Cairo.H:55
Fl_Image
Base class for image caching, scaling and drawing.
Definition Fl_Image.H:60
Fl_Widget_Tracker
This class should be used to control safe widget deletion.
Definition Fl.H:1594
Fl_Widget_Tracker::exists
int exists()
Returns 1, if the watched widget exists (has not been deleted).
Definition Fl.H:1630
Fl_Widget_Tracker::deleted
int deleted()
Returns 1, if the watched widget has been deleted.
Definition Fl.H:1619
Fl_Widget_Tracker::widget
Fl_Widget * widget()
Returns a pointer to the watched widget.
Definition Fl.H:1608
Fl_Widget
Fl_Widget is the base class for all widgets in FLTK.
Definition Fl_Widget.H:112
Fl_Window
This widget produces an actual window.
Definition Fl_Window.H:55
Fl
The Fl is the FLTK global (static) class containing state information and global methods for the curr...
Definition Fl.H:147
Fl::idle
static bool idle()
Returns whether at least one idle callback is currently set.
Definition Fl.H:346
Fl::is_scheme
static int is_scheme(const char *name)
Returns whether the current scheme is the given name.
Definition Fl.H:454
Fl::scheme
static const char * scheme()
See void scheme(const char *name)
Definition Fl.H:425
Fl::draw_GL_text_with_textures
static int draw_GL_text_with_textures()
returns whether whether OpenGL uses textures to draw all text.
Definition Fl.H:1440
Fl::program_should_quit
static int program_should_quit()
Returns non-zero when a request for program termination was received and accepted.
Definition Fl.H:477
Fl::use_high_res_GL
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:1414
Fl::box_border_radius_max
static int box_border_radius_max()
Get the maximum border radius of all "rounded" boxtypes in pixels.
Definition Fl.H:182
Fl::OPTION_FNFC_USES_GTK
@ 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:278
Fl::OPTION_SIMPLE_ZOOM_SHORTCUT
@ OPTION_SIMPLE_ZOOM_SHORTCUT
When switched on and when the keyboard in use has '+' in the shifted position of its key,...
Definition Fl.H:299
Fl::OPTION_FNFC_USES_ZENITY
@ OPTION_FNFC_USES_ZENITY
Meaningful for the Wayland/X11 platform only.
Definition Fl.H:281
Fl::OPTION_DND_TEXT
@ 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:270
Fl::OPTION_FNFC_USES_KDIALOG
@ OPTION_FNFC_USES_KDIALOG
Meaningful for the Wayland/X11 platform only.
Definition Fl.H:285
Fl::OPTION_PRINTER_USES_GTK
@ 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:289
Fl::OPTION_SHOW_SCALING
@ OPTION_SHOW_SCALING
When switched on (default), the library shows in a transient yellow window the zoom factor value.
Definition Fl.H:293
Fl::OPTION_VISIBLE_FOCUS
@ OPTION_VISIBLE_FOCUS
If visible focus is switched on (default), FLTK will draw a dotted rectangle inside the widget that w...
Definition Fl.H:266
Fl::OPTION_SHOW_TOOLTIPS
@ 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:274
Fl::damage
static void damage(int d)
If true then flush() will do something.
Definition Fl.H:232
Fl::box_shadow_width
static int box_shadow_width()
Get the box shadow width of all "shadow" boxtypes in pixels.
Definition Fl.H:172
Fl::dnd_text_ops
static void dnd_text_ops(int v)
Sets whether drag and drop text operations are supported.
Definition Fl.H:1347
Fl::help
static const char *const help
Usage string displayed if Fl::args() detects an invalid argument.
Definition Fl.H:401
Fl::box_border_radius_max
static void box_border_radius_max(int R)
Set the maximum border radius of all "rounded" boxtypes in pixels.
Definition Fl.H:195
Fl::abi_check
static int abi_check(const int val=99999)
Returns whether the runtime library ABI version is correct.
Definition Fl.H:389
Fl::gl_visual
static int gl_visual(int, int *alist=0)
This does the same thing as Fl::visual(int) but also requires OpenGL drawing to work.
Fl::program_should_quit
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:483
Fl::use_high_res_GL
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:1420
Fl::draw_GL_text_with_textures
static void draw_GL_text_with_textures(int val)
sets whether OpenGL uses textures to draw all text.
Definition Fl.H:1433
Fl::dnd_text_ops
static int dnd_text_ops()
Gets whether drag and drop text operations are supported.
Definition Fl.H:1354
Fl::grab
static void grab(Fl_Window &win)
See grab(Fl_Window*)
Definition Fl.H:1324
Fl::damage
static int damage()
If true then flush() will do something.
Definition Fl.H:524
Fl::box_shadow_width
static void box_shadow_width(int W)
Set the box shadow width of all "shadow" boxtypes in pixels.
Definition Fl.H:177
Fl::set_labeltype
static void set_labeltype(Fl_Labeltype, Fl_Labeltype from)
Sets the functions to call to draw and measure a specific labeltype.
Fl::visible_focus
static void visible_focus(int v)
Gets or sets the visible keyboard focus on buttons and other non-text widgets.
Definition Fl.H:1332
Fl::visible_focus
static int visible_focus()
Gets or sets the visible keyboard focus on buttons and other non-text widgets.
Definition Fl.H:1338
FL_DEPRECATED
#define FL_DEPRECATED(msg, func)
Enclosing a function or method in FL_DEPRECATED marks it as no longer recommended.
Definition fl_attr.h:67
Fl_Shortcut
unsigned int Fl_Shortcut
16-bit Unicode character + 8-bit indicator for keyboard flags.
Definition fl_types.h:55
uchar
unsigned char uchar
unsigned char
Definition fl_types.h:30
fl_utf8.h
header for Unicode and UTF-8 character handling
Fl_System_Handler
int(* Fl_System_Handler)(void *event, void *data)
Signature of add_system_handler functions passed as parameters.
Definition Fl.H:122
Fl_Timeout_Handler
void(* Fl_Timeout_Handler)(void *data)
Signature of timeout callback functions passed as parameters.
Definition Fl.H:97
Fl_Event_Handler
int(* Fl_Event_Handler)(int event)
Signature of add_handler functions passed as parameters.
Definition Fl.H:119
Fl_Old_Idle_Handler
void(* Fl_Old_Idle_Handler)()
Signature of add_idle callback function passed as parameter.
Definition Fl.H:113
Fl_Awake_Handler
void(* Fl_Awake_Handler)(void *data)
Signature of some wakeup callback functions passed as parameters.
Definition Fl.H:100
Fl_FD_Handler
void(* Fl_FD_Handler)(FL_SOCKET fd, void *data)
Signature of add_fd functions passed as parameters.
Definition Fl.H:116
Fl_Event_Dispatch
int(* Fl_Event_Dispatch)(int event, Fl_Window *w)
Signature of event_dispatch functions passed as parameters.
Definition Fl.H:135
Fl_Label_Draw_F
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
Fl_Args_Handler
int(* Fl_Args_Handler)(int argc, char **argv, int &i)
Signature of args functions passed as parameters.
Definition Fl.H:131
Fl_Box_Draw_Focus_F
void() Fl_Box_Draw_Focus_F(Fl_Boxtype bt, int x, int y, int w, int h, Fl_Color fg, Fl_Color bg)
Signature of box focus frame drawing functions.
Definition Fl.H:92
Fl_Label_Measure_F
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
Fl_Abort_Handler
void(* Fl_Abort_Handler)(const char *format,...)
Signature of set_abort functions passed as parameters.
Definition Fl.H:125
Fl_Atclose_Handler
void(* Fl_Atclose_Handler)(Fl_Window *window, void *data)
Signature of set_atclose functions passed as parameters.
Definition Fl.H:128
Fl_Idle_Handler
void(* Fl_Idle_Handler)(void *data)
Signature of add_idle callback function passed as parameter.
Definition Fl.H:106
Fl_Box_Draw_F
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
Fl_Clipboard_Notify_Handler
void(* Fl_Clipboard_Notify_Handler)(int source, void *data)
Signature of add_clipboard_notify functions passed as parameters.
Definition Fl.H:138
Fl::clipboard_image
static char const *const clipboard_image
Denotes image data.
Definition Fl.H:1081
Fl::selection_owner
static Fl_Widget * selection_owner()
back-compatibility only: Gets the widget owning the current selection
Definition Fl.H:1097
Fl::selection_to_clipboard
static int selection_to_clipboard()
Returns the current selection_to_clipboard mode.
Definition Fl.H:994
Fl::clipboard_plain_text
static char const *const clipboard_plain_text
Denotes plain textual data.
Definition Fl.H:1078
Fl::selection_to_clipboard
static void selection_to_clipboard(int mode)
Copies selections on X11 directly to the clipboard if enabled.
Definition Fl.H:985
Fl::event_clicks
static void event_clicks(int i)
Manually sets the number returned by Fl::event_clicks().
Definition Fl.H:702
Fl::event_is_click
static void event_is_click(int i)
Clears the value returned by Fl::event_is_click().
Definition Fl.H:717
Fl::event_button4
static int event_button4()
Returns non-zero if mouse button 4 is currently held down.
Definition Fl.H:1303
Fl::event_y
static int event_y()
Returns the mouse position of the event relative to the Fl_Window it was passed to.
Definition Fl.H:652
Fl::event_key
static int event_key()
Gets which key on the keyboard was last pushed.
Definition Fl.H:789
Fl::event_alt
static int event_alt()
Returns non-zero if the Alt key is pressed.
Definition Fl.H:1274
Fl::focus
static Fl_Widget * focus()
Gets the current Fl::focus() widget.
Definition Fl.H:899
Fl::event_length
static int event_length()
Returns the length of the text in Fl::event_text().
Definition Fl.H:866
Fl::event_state
static int event_state(int mask)
Returns non-zero if any of the passed event state bits are turned on.
Definition Fl.H:777
Fl::event_button5
static int event_button5()
Returns non-zero if mouse button 5 is currently held down.
Definition Fl.H:1308
Fl::event_dy
static int event_dy()
Returns the current vertical mouse scrolling associated with the FL_MOUSEWHEEL event.
Definition Fl.H:676
Fl::event_x_root
static int event_x_root()
Returns the mouse position on the screen of the event.
Definition Fl.H:659
Fl::pushed
static Fl_Widget * pushed()
Gets the widget that is being pushed.
Definition Fl.H:896
Fl::event_clipboard_type
static const char * event_clipboard_type()
Returns the type of the pasted data during an FL_PASTE event.
Definition Fl.H:875
Fl::event_button1
static int event_button1()
Returns non-zero if mouse button 1 is currently held down.
Definition Fl.H:1288
Fl::event_button3
static int event_button3()
Returns non-zero if mouse button 3 is currently held down.
Definition Fl.H:1298
Fl::event_command
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:1272
Fl::event_button
static int event_button()
Gets which particular mouse button caused the current event.
Definition Fl.H:729
Fl::event_x
static int event_x()
Returns the mouse position of the event relative to the Fl_Window it was passed to.
Definition Fl.H:647
Fl::event_y_root
static int event_y_root()
Returns the mouse position on the screen of the event.
Definition Fl.H:666
Fl::event_clipboard
static void * event_clipboard()
During an FL_PASTE event of non-textual data, returns a pointer to the pasted data.
Definition Fl.H:871
Fl::event_shift
static int event_shift()
Returns non-zero if the Shift key is pressed.
Definition Fl.H:1268
Fl::event
static int event()
Returns the last event that was processed.
Definition Fl.H:642
Fl::event_ctrl
static int event_ctrl()
Returns non-zero if the Control key is pressed.
Definition Fl.H:1270
Fl::belowmouse
static Fl_Widget * belowmouse()
Gets the widget that is below the mouse.
Definition Fl.H:892
Fl::event_button2
static int event_button2()
Returns non-zero if mouse button 2 is currently held down.
Definition Fl.H:1293
Fl::event_dx
static int event_dx()
Returns the current horizontal mouse scrolling associated with the FL_MOUSEWHEEL event.
Definition Fl.H:671
Fl::event_original_key
static int event_original_key()
Returns the keycode of the last key event, regardless of the NumLock state.
Definition Fl.H:798
Fl::event_is_click
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:710
Fl::event_text
static const char * event_text()
Returns the text associated with the current event, including FL_PASTE or FL_DND_RELEASE events.
Definition Fl.H:859
Fl::event_buttons
static int event_buttons()
Returns the mouse buttons state bits; if non-zero, then at least one button is pressed now.
Definition Fl.H:1283
Fl::event_state
static int event_state()
Returns the keyboard and mouse button states of the last event.
Definition Fl.H:770
Fl::event_clicks
static int event_clicks()
Returns non zero if we had a double click event.
Definition Fl.H:694
Fl::modal
static Fl_Window * modal()
Returns the top-most modal() window currently shown.
Definition Fl.H:598
Fl::set_abort
static void set_abort(Fl_Abort_Handler f)
For back compatibility, sets the void Fl::fatal handler callback.
Definition Fl.H:1256
Fl::grab
static Fl_Window * grab()
Returns the window that currently receives all events.
Definition Fl.H:604
Fl::set_atclose
static void set_atclose(Fl_Atclose_Handler f)
For back compatibility, sets the Fl::atclose handler callback.
Definition Fl.H:1262
Fl::cairo_cc
static cairo_t * cairo_cc()
Gets the current Cairo context linked with a fltk window.
Definition Fl.H:1488
Fl::cairo_cc
static void cairo_cc(cairo_t *c, bool own=false)
Sets the current Cairo context to c.
Definition Fl.H:1497
Fl::cairo_autolink_context
static bool cairo_autolink_context()
Gets the current autolink mode for Cairo support.
Definition Fl.H:1483
Fl::cairo_flush
static void cairo_flush(cairo_t *c)
Flush Cairo drawings on Cairo context c.
Definition Fl.H:1534
Fl::cairo_autolink_context
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:1471
FL_ABI_VERSION
#define FL_ABI_VERSION
The FLTK ABI (Application Binary Interface) version number as an int.
Definition fl_config.h:87
platform_types.h
Definitions of platform-dependent types.
FL_COMMAND
#define FL_COMMAND
An alias for FL_CTRL on Windows and X11, or FL_META on MacOS X.
Definition platform_types.h:75
Fl_Timestamp
opaque Fl_Timestamp
Platform-specific point in time, used for delta time calculation.
Definition platform_types.h:73
FL_SOCKET
opaque FL_SOCKET
socket or file descriptor
Definition platform_types.h:57
Fl_Label
This struct stores all information for a text or mixed graphics label.
Definition Fl_Widget.H:49