FLTK 1.3.11
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-2023 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 // http://www.fltk.org/COPYING.php
11 //
12 // Please report all bugs and problems on the following page:
13 //
14 // http://www.fltk.org/str.php
15 //
16 
21 #ifndef Fl_H
22 # define Fl_H
23 
24 // In FLTK 1.3.x WIN32 must be defined on Windows (if not using CYGWIN).
25 // Since FLTK 1.3.9 we define WIN32 if it's not defined on Windows
26 // to avoid common user errors, for instance GitHub Issue #686.
27 // Note: since FLTK 1.4.0 we use '_WIN32' anyway, no need to define WIN32.
28 
29 #if defined(_WIN32) && !defined(__CYGWIN__) && !defined(WIN32)
30 #define WIN32
31 #endif
32 
33 #include <FL/Fl_Export.H>
34 
35 #ifdef FLTK_HAVE_CAIRO
36 # include <FL/Fl_Cairo.H>
37 #endif
38 
39 # include "fl_utf8.h"
40 # include "Enumerations.H"
41 # ifndef Fl_Object
42 # define Fl_Object Fl_Widget
43 # endif
44 
45 # ifdef check
46 # undef check
47 # endif
48 
49 
50 class Fl_Widget;
51 class Fl_Window;
52 class Fl_Image;
53 struct Fl_Label;
54 
55 // Keep avoiding having the socket deps at that level but mke sure it will work in both 32 & 64 bit builds
56 #if defined(WIN32) && !defined(__CYGWIN__)
57 # if defined(_WIN64)
58 # define FL_SOCKET unsigned __int64
59 # else
60 # define FL_SOCKET int
61 # endif
62 #else
63 # define FL_SOCKET int
64 #endif
65 
66 
67 // Pointers you can use to change FLTK to a foreign language.
68 // Note: Similar pointers are defined in FL/fl_ask.H and src/fl_ask.cxx
69 extern FL_EXPORT const char* fl_local_ctrl;
70 extern FL_EXPORT const char* fl_local_meta;
71 extern FL_EXPORT const char* fl_local_alt;
72 extern FL_EXPORT const char* fl_local_shift;
73 
90 typedef void (Fl_Label_Draw_F)(const Fl_Label *label, int x, int y, int w, int h, Fl_Align align);
91 
93 typedef void (Fl_Label_Measure_F)(const Fl_Label *label, int &width, int &height);
94 
96 typedef void (Fl_Box_Draw_F)(int x, int y, int w, int h, Fl_Color color);
97 
99 typedef void (*Fl_Timeout_Handler)(void *data);
100 
102 typedef void (*Fl_Awake_Handler)(void *data);
103 
105 typedef void (*Fl_Idle_Handler)(void *data);
106 
108 typedef void (*Fl_Old_Idle_Handler)();
109 
111 typedef void (*Fl_FD_Handler)(FL_SOCKET fd, void *data);
112 
114 typedef int (*Fl_Event_Handler)(int event);
115 
117 typedef int (*Fl_System_Handler)(void *event, void *data);
118 
120 typedef void (*Fl_Abort_Handler)(const char *format,...);
121 
123 typedef void (*Fl_Atclose_Handler)(Fl_Window *window, void *data);
124 
126 typedef int (*Fl_Args_Handler)(int argc, char **argv, int &i);
127 
130 typedef int (*Fl_Event_Dispatch)(int event, Fl_Window *w);
131 
133 typedef void (*Fl_Clipboard_Notify_Handler)(int source, void *data);
134  /* group callback_functions */
136 
137 
142 class FL_EXPORT Fl {
143  Fl() {}; // no constructor!
144 
145 private:
146  static int use_high_res_GL_;
147 
148 public: // should be private!
149 #ifndef FL_DOXYGEN
150  static int e_number;
151  static int e_x;
152  static int e_y;
153  static int e_x_root;
154  static int e_y_root;
155  static int e_dx;
156  static int e_dy;
157  static int e_state;
158  static int e_clicks;
159  static int e_is_click;
160  static int e_keysym;
161  static char* e_text;
162  static int e_length;
163  static void *e_clipboard_data;
164  static const char *e_clipboard_type;
165  static Fl_Event_Dispatch e_dispatch;
166  static Fl_Widget* belowmouse_;
167  static Fl_Widget* pushed_;
168  static Fl_Widget* focus_;
169  static int damage_;
170  static Fl_Widget* selection_owner_;
171  static Fl_Window* modal_;
172  static Fl_Window* grab_;
173  static int compose_state; // used for dead keys (WIN32) or marked text (MacOS)
174  static void call_screen_init(); // recompute screen number and dimensions
175 #ifdef __APPLE__
176  static void reset_marked_text(); // resets marked text
177  static void insertion_point_location(int x, int y, int height); // sets window coordinates & height of insertion point
178 #endif
179 #endif // FL_DOXYGEN
180 
181 
185  static void damage(int d) {damage_ = d;}
186 
187 public:
194  typedef enum {
204  OPTION_ARROW_FOCUS = 0,
205  // When switched on, FLTK will use the file chooser dialog that comes
206  // with your operating system whenever possible. When switched off, FLTK
207  // will present its own file chooser.
208  // \todo implement me
209  // OPTION_NATIVE_FILECHOOSER,
210  // When Filechooser Preview is enabled, the FLTK or native file chooser
211  // will show a preview of a selected file (if possible) before the user
212  // decides to choose the file.
213  // \todo implement me
214  //OPTION_FILECHOOSER_PREVIEW,
232  // don't change this, leave it always as the last element
234  OPTION_LAST
235  } Fl_Option;
236 
237 private:
238  static unsigned char options_[OPTION_LAST];
239  static unsigned char options_read_;
240 
241 public:
242  /*
243  Return a global setting for all FLTK applications, possibly overridden
244  by a setting specifically for this application.
245  */
246  static bool option(Fl_Option opt);
247 
248  /*
249  Override an option while the application is running.
250  */
251  static void option(Fl_Option opt, bool val);
252 
260  static void (*idle)();
261 
262 #ifndef FL_DOXYGEN
263  static Fl_Awake_Handler *awake_ring_;
264  static void **awake_data_;
265  static int awake_ring_size_;
266  static int awake_ring_head_;
267  static int awake_ring_tail_;
268  static const char* scheme_;
269  static Fl_Image* scheme_bg_;
270 
271  static int e_original_keysym; // late addition
272  static int scrollbar_size_;
273 #endif
274 
275 
276  static int add_awake_handler_(Fl_Awake_Handler, void*);
277  static int get_awake_handler_(Fl_Awake_Handler&, void*&);
278 
279 public:
280 
281  // API version number
282  static double version();
283  static int api_version();
284 
285  // ABI version number
286  static int abi_version();
287 
310  static inline int abi_check(const int val = FL_ABI_VERSION) {
311  return val == abi_version();
312  }
313 
314  // argument parsers:
315  static int arg(int argc, char **argv, int& i);
316  static int args(int argc, char **argv, int& i, Fl_Args_Handler cb = 0);
317  static void args(int argc, char **argv);
322  static const char* const help;
323 
324  // things called by initialization:
325  static void display(const char*);
326  static int visual(int);
336  static int gl_visual(int, int *alist=0); // platform dependent
337  static void own_colormap();
338  static void get_system_colors();
339  static void foreground(uchar, uchar, uchar);
340  static void background(uchar, uchar, uchar);
341  static void background2(uchar, uchar, uchar);
342 
343  // schemes:
344  static int scheme(const char *name);
346  static const char* scheme() {return scheme_;}
347 
375  static int is_scheme(const char *name) {
376  return (scheme_ && name && !strcmp(name,scheme_));
377  }
383  static int reload_scheme(); // platform dependent
384  static int scrollbar_size();
385  static void scrollbar_size(int W);
386 
387  // execution:
388  static int wait();
389  static double wait(double time);
390  static int check();
391  static int ready();
392  static int run();
393  static Fl_Widget* readqueue();
424  static void add_timeout(double t, Fl_Timeout_Handler,void* = 0); // platform dependent
445  static void repeat_timeout(double t, Fl_Timeout_Handler, void* = 0); // platform dependent
446  static int has_timeout(Fl_Timeout_Handler, void* = 0);
447  static void remove_timeout(Fl_Timeout_Handler, void* = 0);
448  static void add_check(Fl_Timeout_Handler, void* = 0);
449  static int has_check(Fl_Timeout_Handler, void* = 0);
450  static void remove_check(Fl_Timeout_Handler, void* = 0);
470  static void add_fd(int fd, int when, Fl_FD_Handler cb, void* = 0); // platform dependent
472  static void add_fd(int fd, Fl_FD_Handler cb, void* = 0); // platform dependent
474  static void remove_fd(int, int when); // platform dependent
476  static void remove_fd(int); // platform dependent
477 
478  static void add_idle(Fl_Idle_Handler cb, void* data = 0);
479  static int has_idle(Fl_Idle_Handler cb, void* data = 0);
480  static void remove_idle(Fl_Idle_Handler cb, void* data = 0);
482  static int damage() {return damage_;}
483  static void redraw();
484  static void flush();
505  static void (*warning)(const char*, ...);
520  static void (*error)(const char*, ...);
537  static void (*fatal)(const char*, ...);
543  static Fl_Window* first_window();
544  static void first_window(Fl_Window*);
545  static Fl_Window* next_window(const Fl_Window*);
546 
556  static Fl_Window* modal() {return modal_;}
562  static Fl_Window* grab() {return grab_;}
587  static void grab(Fl_Window*); // platform dependent
594  // event information:
600  static int event() {return e_number;}
605  static int event_x() {return e_x;}
610  static int event_y() {return e_y;}
617  static int event_x_root() {return e_x_root;}
624  static int event_y_root() {return e_y_root;}
629  static int event_dx() {return e_dx;}
634  static int event_dy() {return e_dy;}
643  static void get_mouse(int &,int &); // platform dependent
652  static int event_clicks() {return e_clicks;}
660  static void event_clicks(int i) {e_clicks = i;}
668  static int event_is_click() {return e_is_click;}
675  static void event_is_click(int i) {e_is_click = i;}
687  static int event_button() {return e_keysym-FL_Button;}
728  static int event_state() {return e_state;}
729 
735  static int event_state(int mask) {return e_state&mask;}
747  static int event_key() {return e_keysym;}
756  static int event_original_key(){return e_original_keysym;}
795  static int event_key(int key);
801  static int get_key(int key); // platform dependent
816  static const char* event_text() {return e_text;}
823  static int event_length() {return e_length;}
824 
828  static void *event_clipboard() { return e_clipboard_data; }
832  static const char *event_clipboard_type() {return e_clipboard_type; }
833 
834 
835  static int compose(int &del);
836  static void compose_reset();
837  static int event_inside(int,int,int,int);
838  static int event_inside(const Fl_Widget*);
839  static int test_shortcut(Fl_Shortcut);
840 
845  static void enable_im();
850  static void disable_im();
851 
852  // event destinations:
853  static int handle(int, Fl_Window*);
854  static int handle_(int, Fl_Window*);
857  static Fl_Widget* belowmouse() {return belowmouse_;}
858  static void belowmouse(Fl_Widget*);
861  static Fl_Widget* pushed() {return pushed_;}
862  static void pushed(Fl_Widget*);
864  static Fl_Widget* focus() {return focus_;}
865  static void focus(Fl_Widget*);
866  static void add_handler(Fl_Event_Handler h);
867  static void remove_handler(Fl_Event_Handler h);
868  static void add_system_handler(Fl_System_Handler h, void *data);
869  static void remove_system_handler(Fl_System_Handler h);
870  static void event_dispatch(Fl_Event_Dispatch d);
871  static Fl_Event_Dispatch event_dispatch();
877  // cut/paste:
893 #if FLTK_ABI_VERSION >= 10303 || defined(FL_DOXYGEN)
894  static void copy(const char* stuff, int len, int destination = 0, const char *type = Fl::clipboard_plain_text); // platform dependent
895 #else
896  static void copy(const char* stuff, int len, int destination, const char *type);
897  static void copy(const char* stuff, int len, int destination = 0);
898 #endif
899 
900 #if !(defined(__APPLE__) || defined(WIN32) || defined(FL_DOXYGEN))
901  static void copy_image(const unsigned char* data, int W, int H, int destination = 0); // platform dependent
902 #endif
903 
941 #if FLTK_ABI_VERSION >= 10303 || defined(FL_DOXYGEN)
942  static void paste(Fl_Widget &receiver, int source, const char *type = Fl::clipboard_plain_text); // platform dependent
943 #else
944  static void paste(Fl_Widget &receiver, int source, const char *type);
945  static void paste(Fl_Widget &receiver, int source /*=0*/);
946 #endif
947 
968  static void add_clipboard_notify(Fl_Clipboard_Notify_Handler h, void *data = 0);
973  static void remove_clipboard_notify(Fl_Clipboard_Notify_Handler h);
977  static int clipboard_contains(const char *type);
980  static char const * const clipboard_plain_text;
983  static char const * const clipboard_image;
984 
994  static int dnd(); // platform dependent
995 
996  // These are for back-compatibility only:
999  static Fl_Widget* selection_owner() {return selection_owner_;}
1000  static void selection_owner(Fl_Widget*);
1001  static void selection(Fl_Widget &owner, const char*, int len);
1002  static void paste(Fl_Widget &receiver);
1007  // screen size:
1009  static int x(); // platform dependent
1011  static int y(); // platform dependent
1013  static int w(); // platform dependent
1015  static int h(); // platform dependent
1016 
1017  // multi-head support:
1018  static int screen_count();
1024  static void screen_xywh(int &X, int &Y, int &W, int &H) {
1025  int x, y;
1026  Fl::get_mouse(x, y);
1027  screen_xywh(X, Y, W, H, x, y);
1028  }
1029  static void screen_xywh(int &X, int &Y, int &W, int &H, int mx, int my);
1030  static void screen_xywh(int &X, int &Y, int &W, int &H, int n);
1031  static void screen_xywh(int &X, int &Y, int &W, int &H, int mx, int my, int mw, int mh);
1032  static int screen_num(int x, int y);
1033  static int screen_num(int x, int y, int w, int h);
1034  static void screen_dpi(float &h, float &v, int n=0);
1035  static void screen_work_area(int &X, int &Y, int &W, int &H, int mx, int my);
1036  static void screen_work_area(int &X, int &Y, int &W, int &H, int n);
1042  static void screen_work_area(int &X, int &Y, int &W, int &H) {
1043  int x, y;
1044  Fl::get_mouse(x, y);
1045  screen_work_area(X, Y, W, H, x, y);
1046  }
1047 
1055  // color map:
1056  static void set_color(Fl_Color, uchar, uchar, uchar);
1061  static void set_color(Fl_Color i, unsigned c); // platform dependent
1062  static unsigned get_color(Fl_Color i);
1063  static void get_color(Fl_Color i, uchar &red, uchar &green, uchar &blue);
1069  static void free_color(Fl_Color i, int overlay = 0); // platform dependent
1070 
1071  // fonts:
1072  static const char* get_font(Fl_Font);
1085  static const char* get_font_name(Fl_Font, int* attributes = 0);
1097  static int get_font_sizes(Fl_Font, int*& sizep);
1098  static void set_font(Fl_Font, const char*);
1099  static void set_font(Fl_Font, Fl_Font);
1118  static Fl_Font set_fonts(const char* = 0); // platform dependent
1119 
1126  // <Hack to re-order the 'Drawing functions' group>
1129  // labeltypes:
1130  static void set_labeltype(Fl_Labeltype,Fl_Label_Draw_F*,Fl_Label_Measure_F*);
1132  static void set_labeltype(Fl_Labeltype, Fl_Labeltype from); // is it defined ?
1133 
1134  // boxtypes:
1135  static Fl_Box_Draw_F *get_boxtype(Fl_Boxtype);
1136  static void set_boxtype(Fl_Boxtype, Fl_Box_Draw_F*,uchar,uchar,uchar,uchar);
1137  static void set_boxtype(Fl_Boxtype, Fl_Boxtype from);
1138  static int box_dx(Fl_Boxtype);
1139  static int box_dy(Fl_Boxtype);
1140  static int box_dw(Fl_Boxtype);
1141  static int box_dh(Fl_Boxtype);
1142 
1143  static int draw_box_active();
1144  static Fl_Color box_color(Fl_Color);
1145  static void set_box_color(Fl_Color);
1146 
1147  // back compatibility:
1151  static void set_abort(Fl_Abort_Handler f) {fatal = f;}
1152  static void (*atclose)(Fl_Window*,void*);
1153  static void default_atclose(Fl_Window*,void*);
1157  static void set_atclose(Fl_Atclose_Handler f) {atclose = f;}
1163  static int event_shift() {return e_state&FL_SHIFT;}
1165  static int event_ctrl() {return e_state&FL_CTRL;}
1167  static int event_command() {return e_state&FL_COMMAND;}
1169  static int event_alt() {return e_state&FL_ALT;}
1178  static int event_buttons() {return e_state & FL_BUTTONS;}
1183  static int event_button1() {return e_state & FL_BUTTON1;}
1188  static int event_button2() {return e_state & FL_BUTTON2;}
1193  static int event_button3() {return e_state & FL_BUTTON3;}
1198  static int event_button4() {return e_state & FL_BUTTON4;}
1203  static int event_button5() {return e_state & FL_BUTTON5;}
1211  static void set_idle(Fl_Old_Idle_Handler cb) {idle = cb;}
1213  static void grab(Fl_Window& win) {grab(&win);}
1217  static void release() {grab(0);}
1218 
1219  // Visible focus methods...
1225  static void visible_focus(int v) { option(OPTION_VISIBLE_FOCUS, (v!=0)); }
1231  static int visible_focus() { return option(OPTION_VISIBLE_FOCUS); }
1232 
1233  // Drag-n-drop text operation methods...
1240  static void dnd_text_ops(int v) { option(OPTION_DND_TEXT, (v!=0)); }
1247  static int dnd_text_ops() { return option(OPTION_DND_TEXT); }
1252  // Multithreading support:
1253  static int lock();
1254  static void unlock();
1255  static void awake(void* message = 0);
1257  static int awake(Fl_Awake_Handler cb, void* message = 0);
1264  static void* thread_message(); // platform dependent
1296  // Widget deletion:
1297  static void delete_widget(Fl_Widget *w);
1298  static void do_widget_deletion();
1299  static void watch_widget_pointer(Fl_Widget *&w);
1300  static void release_widget_pointer(Fl_Widget *&w);
1301  static void clear_widget_pointer(Fl_Widget const *w);
1308  static void use_high_res_GL(int val) { use_high_res_GL_ = val; }
1314  static int use_high_res_GL() { return use_high_res_GL_; }
1315 
1316 #ifdef FLTK_HAVE_CAIRO
1317 
1320 public:
1321  // Cairo support API
1322  static cairo_t * cairo_make_current(Fl_Window* w);
1337  static void cairo_autolink_context(bool alink) {cairo_state_.autolink(alink);}
1345  static bool cairo_autolink_context() {return cairo_state_.autolink();}
1347  static cairo_t * cairo_cc() { return cairo_state_.cc(); }
1352  static void cairo_cc(cairo_t * c, bool own=false){ cairo_state_.cc(c, own); }
1353 
1354 private:
1355  static cairo_t * cairo_make_current(void* gc);
1356  static cairo_t * cairo_make_current(void* gc, int W, int H);
1357  static Fl_Cairo_State cairo_state_;
1358 public:
1361 #endif // FLTK_HAVE_CAIRO
1362 
1363 };
1364 
1405 class FL_EXPORT Fl_Widget_Tracker {
1406 
1407  Fl_Widget* wp_;
1408 
1409 public:
1410 
1412  ~Fl_Widget_Tracker();
1413 
1419  Fl_Widget *widget() {return wp_;}
1420 
1430  int deleted() {return wp_ == 0;}
1431 
1441  int exists() {return wp_ != 0;}
1442 
1443 };
1444 
1450 #endif // !Fl_H
static Fl_Window * modal()
Returns the top-most modal() window currently shown.
Definition: Fl.H:556
Fl_Widget is the base class for all widgets in FLTK.
Definition: Fl_Widget.H:101
static char const *const clipboard_image
Denotes image data.
Definition: Fl.H:983
static int event_state(int mask)
Returns non-zero if any of the passed event state bits are turned on.
Definition: Fl.H:735
int(* Fl_Event_Dispatch)(int event, Fl_Window *w)
Signature of event_dispatch functions passed as parameters.
Definition: Fl.H:130
This widget produces an actual window.
Definition: Fl_Window.H:57
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:668
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:90
#define FL_BUTTON2
Mouse button 2 is pushed (M)
Definition: Enumerations.H:571
static const char * scheme()
See void scheme(const char *name)
Definition: Fl.H:346
int deleted()
Returns 1, if the watched widget has been deleted.
Definition: Fl.H:1430
static Fl_Widget * focus()
Gets the current Fl::focus() widget.
Definition: Fl.H:864
static const char * event_text()
Returns the text associated with the current event, including FL_PASTE or FL_DND_RELEASE events...
Definition: Fl.H:816
static void * event_clipboard()
During an FL_PASTE event of non-textual data, returns a pointer to the pasted data.
Definition: Fl.H:828
static Fl_Widget * selection_owner()
back-compatibility only: Gets the widget owning the current selection
Definition: Fl.H:999
int(* Fl_Args_Handler)(int argc, char **argv, int &i)
Signature of args functions passed as parameters.
Definition: Fl.H:126
static int event_button1()
Returns non-zero if mouse button 1 is currently held down.
Definition: Fl.H:1183
static int is_scheme(const char *name)
Returns whether the current scheme is the given name.
Definition: Fl.H:375
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:93
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:1337
The Fl is the FLTK global (static) class containing state information and global methods for the curr...
Definition: Fl.H:142
static void release()
Releases the current grabbed window, equals grab(0).
Definition: Fl.H:1217
int exists()
Returns 1, if the watched widget exists (has not been deleted).
Definition: Fl.H:1441
void(* Fl_Abort_Handler)(const char *format,...)
Signature of set_abort functions passed as parameters.
Definition: Fl.H:120
static const char * event_clipboard_type()
Returns the type of the pasted data during an FL_PASTE event.
Definition: Fl.H:832
static int event_y_root()
Returns the mouse position on the screen of the event.
Definition: Fl.H:624
If visible focus is switched on (default), FLTK will draw a dotted rectangle inside the widget that w...
Definition: Fl.H:219
FL_EXPORT const char * fl_local_meta
string pointer used in shortcuts, you can change it to another language
Definition: Fl.cxx:95
static Fl_Widget * belowmouse()
Gets the widget that is below the mouse.
Definition: Fl.H:857
static int event()
Returns the last event that was processed.
Definition: Fl.H:600
header for Unicode and UTF-8 character handling
#define FL_BUTTON3
Mouse button 3 is pushed (R)
Definition: Enumerations.H:572
#define FL_ABI_VERSION
The FLTK ABI (Application Binary Interface) version number as an int.
Definition: Enumerations.H:181
static int event_y()
Returns the mouse position of the event relative to the Fl_Window it was passed to.
Definition: Fl.H:610
Base class for image caching and drawing.
Definition: Fl_Image.H:55
static int event_dx()
Returns the current horizontal mouse scrolling associated with the FL_MOUSEWHEEL event.
Definition: Fl.H:629
int(* Fl_Event_Handler)(int event)
Signature of add_handler functions passed as parameters.
Definition: Fl.H:114
static void screen_work_area(int &X, int &Y, int &W, int &H)
Gets the bounding box of the work area of the screen that contains the mouse pointer.
Definition: Fl.H:1042
If tooltips are enabled (default), hovering the mouse over a widget with a tooltip text will open a l...
Definition: Fl.H:227
#define FL_BUTTON5
Mouse button 5 is pushed (FORWARD)
Definition: Enumerations.H:574
Fl_Boxtype
Definition: Enumerations.H:610
static int event_button()
Gets which particular mouse button caused the current event.
Definition: Fl.H:687
static bool cairo_autolink_context()
Gets the current autolink mode for cairo support.
Definition: Fl.H:1345
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:1314
#define FL_SHIFT
One of the shift keys is down.
Definition: Enumerations.H:557
This file contains type definitions and general enumerations.
#define FL_COMMAND
An alias for FL_CTRL on WIN32 and X11, or FL_META on MacOS X.
Definition: Enumerations.H:587
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:1308
#define FL_Button
A mouse button; use Fl_Button + n for mouse button n.
Definition: Enumerations.H:465
static int event_button5()
Returns non-zero if mouse button 5 is currently held down.
Definition: Fl.H:1203
FL_EXPORT const char * fl_local_shift
string pointer used in shortcuts, you can change it to another language
Definition: Fl.cxx:96
FL_EXPORT const char * fl_local_ctrl
string pointer used in shortcuts, you can change it to another language
Definition: Fl.cxx:94
static int event_button4()
Returns non-zero if mouse button 4 is currently held down.
Definition: Fl.H:1198
If text drag-and-drop is enabled (default), the user can select and drag text from any text widget...
Definition: Fl.H:223
Fl_Widget * widget()
Returns a pointer to the watched widget.
Definition: Fl.H:1419
static void event_clicks(int i)
Manually sets the number returned by Fl::event_clicks().
Definition: Fl.H:660
static int event_clicks()
Returns non zero if we had a double click event.
Definition: Fl.H:652
static const char *const help
Usage string displayed if Fl::args() detects an invalid argument.
Definition: Fl.H:322
When switched on (default), Fl_Native_File_Chooser runs GTK file dialogs if the GTK library is availa...
Definition: Fl.H:231
static int event_state()
Returns the keyboard and mouse button states of the last event.
Definition: Fl.H:728
This struct stores all information for a text or mixed graphics label.
Definition: Fl_Widget.H:65
#define FL_CTRL
One of the ctrl keys is down.
Definition: Enumerations.H:559
static int event_original_key()
Returns the keycode of the last key event, regardless of the NumLock state.
Definition: Fl.H:756
static void screen_xywh(int &X, int &Y, int &W, int &H)
Gets the bounding box of a screen that contains the mouse pointer.
Definition: Fl.H:1024
FL_EXPORT const char * fl_local_alt
string pointer used in shortcuts, you can change it to another language
Definition: Fl.cxx:93
static int event_button3()
Returns non-zero if mouse button 3 is currently held down.
Definition: Fl.H:1193
static int visible_focus()
Gets or sets the visible keyboard focus on buttons and other non-text widgets.
Definition: Fl.H:1231
static int event_dy()
Returns the current vertical mouse scrolling associated with the FL_MOUSEWHEEL event.
Definition: Fl.H:634
This class should be used to control safe widget deletion.
Definition: Fl.H:1405
void(* Fl_Atclose_Handler)(Fl_Window *window, void *data)
Signature of set_atclose functions passed as parameters.
Definition: Fl.H:123
static void get_mouse(int &, int &)
Return where the mouse is on the screen by doing a round-trip query to the server.
static void grab(Fl_Window &win)
See grab(Fl_Window*)
Definition: Fl.H:1213
#define FL_ALT
One of the alt keys is down.
Definition: Enumerations.H:560
static int event_length()
Returns the length of the text in Fl::event_text().
Definition: Fl.H:823
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:1167
static void event_is_click(int i)
Clears the value returned by Fl::event_is_click().
Definition: Fl.H:675
unsigned int Fl_Color
An FLTK color value; see also Colors.
Definition: Enumerations.H:941
Fl_Labeltype
The labeltype() method sets the type of the label.
Definition: Enumerations.H:770
int Fl_Font
A font number is an index into the internal font table.
Definition: Enumerations.H:884
static int abi_check(const int val=FL_ABI_VERSION)
Returns whether the runtime library ABI version is correct.
Definition: Fl.H:310
static char const *const clipboard_plain_text
Denotes plain textual data.
Definition: Fl.H:980
static int event_x_root()
Returns the mouse position on the screen of the event.
Definition: Fl.H:617
#define FL_BUTTON1
Mouse button 1 is pushed (L)
Definition: Enumerations.H:570
unsigned Fl_Align
FLTK type for alignment control.
Definition: Enumerations.H:835
static void dnd_text_ops(int v)
Gets or sets whether drag and drop text operations are supported.
Definition: Fl.H:1240
static void cairo_cc(cairo_t *c, bool own=false)
Sets the current cairo context to c.
Definition: Fl.H:1352
static Fl_Window * grab()
Returns the window that currently receives all events.
Definition: Fl.H:562
void(* Fl_Old_Idle_Handler)()
Signature of set_idle callback functions passed as parameters.
Definition: Fl.H:108
static void damage(int d)
If true then flush() will do something.
Definition: Fl.H:185
void(* Fl_Idle_Handler)(void *data)
Signature of add_idle callback functions passed as parameters.
Definition: Fl.H:105
int(* Fl_System_Handler)(void *event, void *data)
Signature of add_system_handler functions passed as parameters.
Definition: Fl.H:117
static void visible_focus(int v)
Gets or sets the visible keyboard focus on buttons and other non-text widgets.
Definition: Fl.H:1225
static int event_button2()
Returns non-zero if mouse button 2 is currently held down.
Definition: Fl.H:1188
#define FL_BUTTONS
Bitmask: any mouse button (1-5) is pushed.
Definition: Enumerations.H:575
static Fl_Widget * pushed()
Gets the widget that is being pushed.
Definition: Fl.H:861
void(* Fl_Awake_Handler)(void *data)
Signature of some wakeup callback functions passed as parameters.
Definition: Fl.H:102
static void set_atclose(Fl_Atclose_Handler f)
For back compatibility, sets the Fl::atclose handler callback.
Definition: Fl.H:1157
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:96
static cairo_t * cairo_cc()
Gets the current cairo context linked with a fltk window.
Definition: Fl.H:1347
Contains all the necessary info on the current cairo context.
Definition: Fl_Cairo.H:46
static int event_x()
Returns the mouse position of the event relative to the Fl_Window it was passed to.
Definition: Fl.H:605
Fl_Color color
text color
Definition: Fl_Widget.H:77
static int dnd_text_ops()
Gets or sets whether drag and drop text operations are supported.
Definition: Fl.H:1247
static int event_shift()
Returns non-zero if the Shift key is pressed.
Definition: Fl.H:1163
void(* Fl_FD_Handler)(FL_SOCKET fd, void *data)
Signature of add_fd functions passed as parameters.
Definition: Fl.H:111
static int event_ctrl()
Returns non-zero if the Control key is pressed.
Definition: Fl.H:1165
static int damage()
If true then flush() will do something.
Definition: Fl.H:482
void(* Fl_Timeout_Handler)(void *data)
Signature of some timeout callback functions passed as parameters.
Definition: Fl.H:99
static void set_idle(Fl_Old_Idle_Handler cb)
Sets an idle callback.
Definition: Fl.H:1211
unsigned char uchar
unsigned char
Definition: fl_types.h:30
static int event_buttons()
Returns the mouse buttons state bits; if non-zero, then at least one button is pressed now...
Definition: Fl.H:1178
void(* Fl_Clipboard_Notify_Handler)(int source, void *data)
Signature of add_clipboard_notify functions passed as parameters.
Definition: Fl.H:133
unsigned int Fl_Shortcut
24-bit Unicode character + 8-bit indicator for keyboard flags
Definition: fl_types.h:46
#define FL_BUTTON4
Mouse button 4 is pushed (BACK)
Definition: Enumerations.H:573
static int event_key()
Gets which key on the keyboard was last pushed.
Definition: Fl.H:747
static void set_abort(Fl_Abort_Handler f)
For back compatibility, sets the void Fl::fatal handler callback.
Definition: Fl.H:1151
static int event_alt()
Returns non-zero if the Alt key is pressed.
Definition: Fl.H:1169