2016-02-10 22:49:35 +03:00
|
|
|
//
|
|
|
|
// "$Id$"
|
|
|
|
//
|
|
|
|
// All screen related calls in a driver style class.
|
|
|
|
//
|
2018-02-09 16:48:22 +03:00
|
|
|
// Copyright 1998-2018 by Bill Spitzak and others.
|
2016-02-10 22:49:35 +03:00
|
|
|
//
|
|
|
|
// This library is free software. Distribution and use rights are outlined in
|
|
|
|
// the file "COPYING" which should have been included with this file. If this
|
|
|
|
// file is missing or damaged, see the license at:
|
|
|
|
//
|
|
|
|
// http://www.fltk.org/COPYING.php
|
|
|
|
//
|
|
|
|
// Please report all bugs and problems on the following page:
|
|
|
|
//
|
|
|
|
// http://www.fltk.org/str.php
|
|
|
|
//
|
|
|
|
|
2018-06-23 19:47:40 +03:00
|
|
|
/**
|
2018-06-23 23:50:22 +03:00
|
|
|
\cond DriverDev
|
|
|
|
\addtogroup DriverDeveloper
|
|
|
|
\{
|
2018-06-23 19:47:40 +03:00
|
|
|
*/
|
|
|
|
|
2016-02-10 22:49:35 +03:00
|
|
|
#ifndef FL_SCREEN_DRIVER_H
|
|
|
|
#define FL_SCREEN_DRIVER_H
|
|
|
|
|
2016-04-01 13:28:03 +03:00
|
|
|
#include <FL/fl_types.h>
|
|
|
|
#include <FL/Fl.H> // for Fl_Timeout_Handler
|
2016-04-01 17:49:29 +03:00
|
|
|
#include <FL/Fl_Text_Editor.H>
|
2016-04-01 13:28:03 +03:00
|
|
|
|
2016-02-10 22:49:35 +03:00
|
|
|
|
2016-02-11 01:43:45 +03:00
|
|
|
// TODO: add text composition?
|
|
|
|
// TODO: add Fl::display
|
|
|
|
// TODO: add copy/paste, drag/drop?
|
|
|
|
// TODO: get key/get mouse?
|
|
|
|
// TODO: system colors/colormaps
|
|
|
|
// TODO: system menu?
|
|
|
|
// TODO: native filechooser
|
|
|
|
// TODO: native message boxes
|
|
|
|
// TODO: read screen to image
|
|
|
|
// TODO: application shortcuts
|
|
|
|
|
2016-02-13 19:12:57 +03:00
|
|
|
class Fl_Window;
|
2016-04-03 09:51:09 +03:00
|
|
|
class Fl_RGB_Image;
|
|
|
|
class Fl_Group;
|
2016-04-06 22:39:15 +03:00
|
|
|
class Fl_Input;
|
2016-02-13 19:12:57 +03:00
|
|
|
|
2018-06-23 19:47:40 +03:00
|
|
|
/**
|
2018-06-23 23:50:22 +03:00
|
|
|
A base class describing the interface between FLTK and screen-related operations.
|
|
|
|
|
|
|
|
This class is only for internal use by the FLTK library.
|
|
|
|
|
|
|
|
Each supported platform implements several of the virtual methods of this class.
|
2018-06-23 19:47:40 +03:00
|
|
|
*/
|
2016-02-26 14:13:43 +03:00
|
|
|
class FL_EXPORT Fl_Screen_Driver {
|
2016-02-10 22:49:35 +03:00
|
|
|
|
|
|
|
protected:
|
|
|
|
Fl_Screen_Driver();
|
2016-02-26 16:41:48 +03:00
|
|
|
virtual ~Fl_Screen_Driver();
|
2016-02-10 22:49:35 +03:00
|
|
|
|
|
|
|
static const int MAX_SCREENS = 16;
|
|
|
|
|
2016-02-10 23:26:51 +03:00
|
|
|
int num_screens;
|
2017-05-17 14:54:18 +03:00
|
|
|
static float fl_intersection(int x1, int y1, int w1, int h1,
|
|
|
|
int x2, int y2, int w2, int h2);
|
2016-02-10 22:49:35 +03:00
|
|
|
|
2016-02-13 16:17:29 +03:00
|
|
|
public:
|
|
|
|
static char bg_set;
|
|
|
|
static char bg2_set;
|
|
|
|
static char fg_set;
|
|
|
|
|
2016-02-10 22:49:35 +03:00
|
|
|
public:
|
2017-05-17 14:54:18 +03:00
|
|
|
virtual float scale(int n) {return 1;}
|
|
|
|
virtual void scale(int n, float f) { }
|
2016-02-10 22:49:35 +03:00
|
|
|
static Fl_Screen_Driver *newScreenDriver();
|
2016-02-13 15:57:00 +03:00
|
|
|
// --- display management
|
|
|
|
virtual void display(const char *disp);
|
2016-02-13 19:12:57 +03:00
|
|
|
virtual int visual(int flags);
|
2016-02-11 01:43:45 +03:00
|
|
|
// --- screen configuration
|
2018-03-02 23:03:04 +03:00
|
|
|
virtual void init() {}
|
|
|
|
virtual int x() { return 0; }
|
|
|
|
virtual int y() { return 0; }
|
|
|
|
virtual int w() { return 800; } // default, override in driver!
|
|
|
|
virtual int h() { return 600; } // default, override in driver!
|
2016-02-10 22:49:35 +03:00
|
|
|
virtual int screen_count();
|
2017-06-17 09:53:44 +03:00
|
|
|
void screen_xywh(int &X, int &Y, int &W, int &H, int mx, int my);
|
2018-03-02 23:03:04 +03:00
|
|
|
virtual void screen_xywh(int &X, int &Y, int &W, int &H, int n) { X=0; Y=0; W=800; H=600; }
|
2017-06-17 09:53:44 +03:00
|
|
|
void screen_xywh(int &X, int &Y, int &W, int &H, int mx, int my, int mw, int mh);
|
2016-02-10 22:49:35 +03:00
|
|
|
virtual int screen_num(int x, int y);
|
|
|
|
virtual int screen_num(int x, int y, int w, int h);
|
2018-03-02 23:03:04 +03:00
|
|
|
virtual void screen_dpi(float &h, float &v, int n=0) { h=72; v=72; } // override in driver!
|
2017-06-17 09:53:44 +03:00
|
|
|
void screen_work_area(int &X, int &Y, int &W, int &H, int mx, int my);
|
2018-03-02 23:03:04 +03:00
|
|
|
virtual void screen_work_area(int &X, int &Y, int &W, int &H, int n) { screen_xywh(X, Y, W, H, n); }
|
2016-02-11 01:43:45 +03:00
|
|
|
// --- audible output
|
2018-03-02 23:03:04 +03:00
|
|
|
virtual void beep(int type) { }
|
2016-02-11 03:10:49 +03:00
|
|
|
// --- global events
|
2018-03-02 23:03:04 +03:00
|
|
|
virtual void flush() { } // must override
|
|
|
|
virtual double wait(double time_to_wait) { return 0.0; } // must override
|
|
|
|
virtual int ready() { return 0; } // must override
|
|
|
|
virtual void grab(Fl_Window* win) { }
|
2016-02-13 15:57:00 +03:00
|
|
|
// --- global colors
|
2018-01-09 10:26:49 +03:00
|
|
|
/* the default implementation of parse_color() may be enough */
|
|
|
|
virtual int parse_color(const char* p, uchar& r, uchar& g, uchar& b);
|
2018-03-02 23:03:04 +03:00
|
|
|
virtual void get_system_colors() { }
|
2016-02-13 19:12:57 +03:00
|
|
|
virtual const char *get_system_scheme();
|
2016-03-01 03:54:21 +03:00
|
|
|
// --- global timers
|
2018-03-02 23:03:04 +03:00
|
|
|
virtual void add_timeout(double time, Fl_Timeout_Handler cb, void *argp) { }
|
|
|
|
virtual void repeat_timeout(double time, Fl_Timeout_Handler cb, void *argp) { }
|
|
|
|
virtual int has_timeout(Fl_Timeout_Handler cb, void *argp) { return 0; }
|
|
|
|
virtual void remove_timeout(Fl_Timeout_Handler cb, void *argp) { }
|
2016-03-31 18:57:35 +03:00
|
|
|
|
|
|
|
static int secret_input_character;
|
2016-03-31 20:25:18 +03:00
|
|
|
/* Implement to indicate whether complex text input may involve marked text.
|
|
|
|
When it does, has_marked_text returns non zero and reset_marked_text() and
|
|
|
|
insertion_point_location() must also be implemented.
|
|
|
|
*/
|
|
|
|
virtual int has_marked_text() { return 0; }
|
|
|
|
virtual void reset_marked_text() {}
|
|
|
|
virtual void insertion_point_location(int x, int y, int height) {}
|
2016-03-31 22:55:03 +03:00
|
|
|
// implement so text-editing widgets support dead keys
|
|
|
|
virtual int compose(int &del) {del = 0; return 0;}
|
|
|
|
// default implementation may be enough
|
|
|
|
virtual void compose_reset();
|
|
|
|
// implement to support drag-n-drop. use_selection = 1 means the GUI is welcome to display
|
|
|
|
// the selected text during the D&D operation
|
|
|
|
virtual int dnd(int use_selection = 0) {return 0;}
|
2016-04-01 17:49:29 +03:00
|
|
|
// null means no platform-specific key bindings for Fl_Text_Editor
|
|
|
|
Fl_Text_Editor::Key_Binding *text_editor_extra_key_bindings;
|
2016-04-01 18:37:19 +03:00
|
|
|
// default implementation may be enough
|
|
|
|
virtual int text_display_can_leak() { return 0; }
|
2016-09-22 10:44:34 +03:00
|
|
|
|
2018-03-24 20:08:25 +03:00
|
|
|
// if no keyboard is connected on a touch or pen device, the system on-screen keyboard is requested
|
|
|
|
virtual void request_keyboard() { }
|
|
|
|
// we no longer need the on-screen keyboard; it's up to the system to hide it
|
|
|
|
virtual void release_keyboard() { }
|
|
|
|
|
2016-04-03 09:51:09 +03:00
|
|
|
// read raw image from a window or an offscreen buffer
|
2018-02-09 16:48:22 +03:00
|
|
|
/* Member function read_win_rectangle() supports the public function
|
|
|
|
fl_read_image() which captures pixel data either from
|
2017-01-04 10:44:31 +03:00
|
|
|
the current window or from an offscreen buffer.
|
|
|
|
|
2018-02-09 16:48:22 +03:00
|
|
|
With fl_read_image() and for capture from a window, the returned pixel array
|
2017-01-04 10:44:31 +03:00
|
|
|
also contains data from any embedded sub-window.
|
2018-02-09 16:48:22 +03:00
|
|
|
|
|
|
|
In the case of read_win_rectangle() and for capture from a window, only data
|
|
|
|
from the current window is collected.
|
2017-01-04 10:44:31 +03:00
|
|
|
|
|
|
|
A platform may also use its read_win_rectangle() implementation to capture
|
|
|
|
window decorations (e.g., title bar). In that case, it is called by
|
|
|
|
Fl_XXX_Window_Driver::capture_titlebar_and_borders().
|
|
|
|
*/
|
2018-02-09 16:48:22 +03:00
|
|
|
virtual Fl_RGB_Image *read_win_rectangle(int X, int Y, int w, int h) {return NULL;}
|
2016-04-03 09:51:09 +03:00
|
|
|
static void write_image_inside(Fl_RGB_Image *to, Fl_RGB_Image *from, int to_x, int to_y);
|
2018-02-09 16:48:22 +03:00
|
|
|
static Fl_RGB_Image *traverse_to_gl_subwindows(Fl_Group *g, int x, int y, int w, int h,
|
2016-04-03 09:51:09 +03:00
|
|
|
Fl_RGB_Image *full_img);
|
2016-04-06 22:39:15 +03:00
|
|
|
// optional platform-specific key handling for Fl_Input widget
|
|
|
|
// the default implementation may be enough
|
|
|
|
virtual int input_widget_handle_key(int key, unsigned mods, unsigned shift, Fl_Input *input);
|
2016-04-15 17:18:37 +03:00
|
|
|
// implement to support Fl::get_mouse()
|
2017-06-17 09:53:44 +03:00
|
|
|
virtual int get_mouse(int &x, int &y) {return 0;}
|
2016-04-15 18:12:22 +03:00
|
|
|
// optional methods to enable/disable input methods for complex scripts
|
|
|
|
virtual void enable_im() {}
|
|
|
|
virtual void disable_im() {}
|
2017-06-01 17:05:47 +03:00
|
|
|
// calls open_display_platform() and then does platform-independent work
|
|
|
|
void open_display();
|
2016-04-15 18:36:10 +03:00
|
|
|
// implement to open access to the display
|
2017-06-01 17:05:47 +03:00
|
|
|
virtual void open_display_platform() {}
|
2016-04-15 18:36:10 +03:00
|
|
|
// optional method to close display access
|
|
|
|
virtual void close_display() {}
|
2016-12-14 21:54:12 +03:00
|
|
|
// compute dimensions of an Fl_Offscreen
|
|
|
|
virtual void offscreen_size(Fl_Offscreen off, int &width, int &height) {}
|
2017-05-17 14:54:18 +03:00
|
|
|
|
|
|
|
void rescale_all_windows_from_screen(int screen, float f);
|
|
|
|
static void transient_scale_display(float f, int nscreen);
|
|
|
|
static int scale_handler(int event);
|
|
|
|
virtual float desktop_scale_factor() {return 1;}
|
2018-06-08 14:31:30 +03:00
|
|
|
float use_startup_scale_factor();
|
2017-05-17 14:54:18 +03:00
|
|
|
enum APP_SCALING_CAPABILITY {
|
|
|
|
NO_APP_SCALING = 0, ///< The platform does not support rescaling.
|
|
|
|
SYSTEMWIDE_APP_SCALING, ///< The platform supports rescaling with the same factor for all screens.
|
|
|
|
PER_SCREEN_APP_SCALING ///< The platform supports rescaling with one factor for each screen.
|
|
|
|
};
|
|
|
|
/** Returns the platform's support for rescaling the application with ctrl-/+/-/0/ keys.
|
|
|
|
*/
|
|
|
|
virtual APP_SCALING_CAPABILITY rescalable() { return NO_APP_SCALING; }
|
2017-09-13 19:15:34 +03:00
|
|
|
/* Number of pixels per drawing unit for the display.
|
|
|
|
The default implementation may be enough. */
|
|
|
|
virtual float retina_factor() { return 1; }
|
2016-02-10 22:49:35 +03:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
#endif // !FL_SCREEN_DRIVER_H
|
|
|
|
|
2018-06-23 19:47:40 +03:00
|
|
|
/**
|
2018-06-23 23:50:22 +03:00
|
|
|
\}
|
|
|
|
\endcond
|
2018-06-23 19:47:40 +03:00
|
|
|
*/
|
|
|
|
|
2016-02-10 22:49:35 +03:00
|
|
|
//
|
|
|
|
// End of "$Id$".
|
|
|
|
//
|