FLTK: x.H Source File

FLTK

x.H
1 //
2 // "$Id$"
3 //
4 // X11 header file for the Fast Light Tool Kit (FLTK).
5 //
6 // Copyright 1998-2012 by Bill Spitzak and others.
7 //
8 // This library is free software. Distribution and use rights are outlined in
9 // the file "COPYING" which should have been included with this file. If this
10 // file is missing or damaged, see the license at:
11 //
12 // http://www.fltk.org/COPYING.php
13 //
14 // Please report all bugs and problems on the following page:
15 //
16 // http://www.fltk.org/str.php
17 //
18
19 // These are internal fltk symbols that are necessary or useful for
20 // calling Xlib. You should include this file if (and ONLY if) you
21 // need to call Xlib directly. These symbols may not exist on non-X
22 // systems.
23
24 #if !defined(Fl_X_H) && !defined(FL_DOXYGEN)
25 # define Fl_X_H
26
27 # include "Enumerations.H"
28
29 # ifdef WIN32
30 # include "win32.H"
31 # elif defined(__APPLE__)
32 # include "mac.H"
33 # else
34 # if defined(_ABIN32) || defined(_ABI64) // fix for broken SGI Irix X .h files
35 # pragma set woff 3322
36 # endif
37 # include <X11/Xlib.h>
38 # include <X11/Xutil.h>
39 # if defined(_ABIN32) || defined(_ABI64)
40 # pragma reset woff 3322
41 # endif
42 # include <X11/Xatom.h>
43 # include "Fl_Window.H"
44 // Mirror X definition of Region to Fl_Region, for portability...
45 typedef Region Fl_Region;
46
47 FL_EXPORT void fl_open_display();
48 FL_EXPORT void fl_open_display(Display*);
49 FL_EXPORT void fl_close_display();
50
51 // constant info about the X server connection:
52 extern FL_EXPORT Display *fl_display;
53 extern FL_EXPORT int fl_screen;
54 extern FL_EXPORT XVisualInfo *fl_visual;
55 extern FL_EXPORT Colormap fl_colormap;
56
57
58 // drawing functions:
59 extern FL_EXPORT GC fl_gc;
60 extern FL_EXPORT Window fl_window;
61 FL_EXPORT ulong fl_xpixel(Fl_Color i);
62 FL_EXPORT ulong fl_xpixel(uchar r, uchar g, uchar b);
63 FL_EXPORT void fl_clip_region(Fl_Region);
64 FL_EXPORT Fl_Region fl_clip_region();
65
66 // feed events into fltk:
67 FL_EXPORT int fl_handle(const XEvent&);
68
69 // you can use these in Fl::add_handler() to look at events:
70 extern FL_EXPORT const XEvent* fl_xevent;
71 extern FL_EXPORT ulong fl_event_time;
72
73 // off-screen pixmaps: create, destroy, draw into, copy to window:
74 typedef ulong Fl_Offscreen;
75 # define fl_create_offscreen(w,h) XCreatePixmap(fl_display, RootWindow(fl_display, fl_screen), w, h, fl_visual->depth)
76 # define fl_create_offscreen_with_alpha(w,h) XCreatePixmap(fl_display, RootWindow(fl_display, fl_screen), w, h, 32)
77 // begin/end are macros that save the old state in local variables:
78 # define fl_begin_offscreen(pixmap) \
79 Window _sw=fl_window; fl_window=pixmap; \
80 Fl_Surface_Device *_ss = Fl_Surface_Device::surface(); Fl_Display_Device::display_device()->set_current(); \
81 fl_push_no_clip()
82 # define fl_end_offscreen() \
83 fl_pop_clip(); fl_window = _sw; _ss->set_current()
84
85 extern FL_EXPORT void fl_copy_offscreen(int x, int y, int w, int h, Fl_Offscreen pixmap, int srcx, int srcy);
86 # define fl_delete_offscreen(pixmap) XFreePixmap(fl_display, pixmap)
87
88 // Bitmap masks
89 typedef ulong Fl_Bitmask;
90
91 extern FL_EXPORT Fl_Bitmask fl_create_bitmask(int w, int h, const uchar *data);
92 extern FL_EXPORT Fl_Bitmask fl_create_alphamask(int w, int h, int d, int ld, const uchar *data);
93 extern FL_EXPORT void fl_delete_bitmask(Fl_Bitmask bm);
94
95 #if defined(FL_LIBRARY) || defined(FL_INTERNALS)
96 extern FL_EXPORT Window fl_message_window;
97 extern FL_EXPORT void *fl_xftfont;
98 FL_EXPORT Fl_Region XRectangleRegion(int x, int y, int w, int h); // in fl_rect.cxx
99
100 // access to core fonts:
101 // This class provides a "smart pointer" that returns a pointer to an XFontStruct.
102 // The global variable fl_xfont can be called wherever a bitmap "core" font is
103 // needed, e.g. when rendering to a GL context under X11.
104 // With Xlib / X11 fonts, fl_xfont will return the current selected font.
105 // With XFT / X11 fonts, fl_xfont will attempt to return the bitmap "core" font most
106 // similar to (usually the same as) the current XFT font.
107 class Fl_XFont_On_Demand
108 {
109 public:
110 Fl_XFont_On_Demand(XFontStruct* p = NULL) : ptr(p) { }
111 Fl_XFont_On_Demand& operator=(const Fl_XFont_On_Demand& x)
112 { ptr = x.ptr; return *this; }
113 Fl_XFont_On_Demand& operator=(XFontStruct* p)
114 { ptr = p; return *this; }
115 XFontStruct* value();
116 operator XFontStruct*() { return value(); }
117 XFontStruct& operator*() { return *value(); }
118 XFontStruct* operator->() { return value(); }
119 bool operator==(const Fl_XFont_On_Demand& x) { return ptr == x.ptr; }
120 bool operator!=(const Fl_XFont_On_Demand& x) { return ptr != x.ptr; }
121 private:
122 XFontStruct *ptr;
123 };
124 extern FL_EXPORT Fl_XFont_On_Demand fl_xfont;
125 extern FL_EXPORT XFontStruct* fl_X_core_font();
126
127 // this object contains all X-specific stuff about a window:
128 // Warning: this object is highly subject to change!
129 // FL_LIBRARY or FL_INTERNALS must be defined to access this class.
130 class FL_EXPORT Fl_X {
131 public:
132 Window xid;
133 Window other_xid;
134 Fl_Window *w;
135 Fl_Region region;
136 Fl_X *next;
137 char wait_for_expose;
138 char backbuffer_bad; // used for XDBE
139 static Fl_X* first;
140 static Fl_X* i(const Fl_Window* wi) {return wi->i;}
141 void setwindow(Fl_Window* wi) {w=wi; wi->i=this;}
142 void sendxjunk();
143 static void set_default_icons(const Fl_RGB_Image*[], int);
144 void set_icons();
145 int set_cursor(Fl_Cursor);
146 int set_cursor(const Fl_RGB_Image*, int, int);
147 static void make_xid(Fl_Window*,XVisualInfo* =fl_visual, Colormap=fl_colormap);
148 static Fl_X* set_xid(Fl_Window*, Window);
149 // kludges to get around protection:
150 void flush() {w->flush();}
151 static void x(Fl_Window* wi, int X) {wi->x(X);}
152 static void y(Fl_Window* wi, int Y) {wi->y(Y);}
153 static int ewmh_supported();
154 static int xrender_supported();
155 static void activate_window(Window w);
156 };
157
158 extern FL_EXPORT char fl_override_redirect; // hack into Fl_X::make_xid()
159 extern FL_EXPORT int fl_background_pixel; // hack into Fl_X::make_xid()
160
161 inline Window fl_xid(const Fl_Window* w) { Fl_X *xTemp = Fl_X::i(w); return xTemp ? xTemp->xid : 0; }
162
163 #else
164
165 extern FL_EXPORT Window fl_xid_(const Fl_Window* w);
166 #define fl_xid(w) fl_xid_(w)
167
168 #endif // FL_LIBRARY || FL_INTERNALS
169
170 FL_EXPORT Fl_Window* fl_find(Window xid);
171
172
173 // Dummy function to register a function for opening files via the window manager...
174 inline void fl_open_callback(void (*)(const char *)) {}
175
176 extern FL_EXPORT int fl_parse_color(const char* p, uchar& r, uchar& g, uchar& b);
177
178 # endif
179 #endif
180
181 //
182 // End of "$Id$".
183 //
Fl_Color
unsigned int Fl_Color
An FLTK color value; see also Colors
Definition: Enumerations.H:934
fl_open_callback
void fl_open_callback(void(*cb)(const char *))
Register a function called for each file dropped onto an application icon.
Fl_Window.H
Fl_Window widget .
Fl_Widget::x
void x(int v)
Internal use only.
Definition: Fl_Widget.H:139
fl_copy_offscreen
void fl_copy_offscreen(int x, int y, int w, int h, Fl_Offscreen pixmap, int srcx, int srcy)
Copy a rectangular area of the given offscreen buffer into the current drawing destination.
Definition: Fl_Double_Window.cxx:94
Fl_Window
This widget produces an actual window.
Definition: Fl_Window.H:57
ulong
unsigned long ulong
unsigned long
Definition: fl_types.h:32
fl_xpixel
ulong fl_xpixel(uchar r, uchar g, uchar b)
Returns the X pixel number used to draw the given rgb color.
Definition: fl_color.cxx:150
Fl_Widget::y
void y(int v)
Internal use only.
Definition: Fl_Widget.H:141
fl_clip_region
void fl_clip_region(Fl_Region r)
Replaces the top of the clipping stack with a clipping region of any shape.
Definition: fl_draw.H:136
Fl_Cursor
Fl_Cursor
The following constants define the mouse cursors that are available in FLTK.
Definition: Enumerations.H:1048
mac.H
Mac OS X-specific symbols.
uchar
unsigned char uchar
unsigned char
Definition: fl_types.h:30
Fl_RGB_Image
The Fl_RGB_Image class supports caching and drawing of full-color images with 1 to 4 channels of colo...
Definition: Fl_Image.H:202
Enumerations.H
This file contains type definitions and general enumerations.
- © 1998-2016 by Bill Spitzak and others.