//
// "$Id: x.H,v 1.10.2.7 2000/06/05 21:20:34 mike Exp $"
//
// X11 header file for the Fast Light Tool Kit (FLTK).
//
// Copyright 1998-2000 by Bill Spitzak and others.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Library General Public
// License as published by the Free Software Foundation; either
// version 2 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Library General Public License for more details.
//
// You should have received a copy of the GNU Library General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA.
//
// Please report all bugs and problems to "fltk-bugs@fltk.org".
//

// These are internal fltk symbols that are necessary or useful for
// calling Xlib.  You should include this file if (and ONLY if) you
// need to call Xlib directly.  These symbols may not exist on non-X
// systems.

#ifndef Fl_X_H
#define Fl_X_H

#include "Enumerations.H"

#ifdef WIN32

#include "win32.H"

#else

#if defined(_ABIN32) || defined(_ABI64) // fix for broken SGI Irix X .h files
#pragma set woff 3322
#endif
#include <X11/Xlib.h>
#include <X11/Xutil.h>
#if defined(_ABIN32) || defined(_ABI64)
#pragma reset woff 3322
#endif
#include <X11/Xatom.h>
#include "Fl_Window.H"

FL_EXPORT void fl_open_display();
FL_EXPORT void fl_open_display(Display*);
FL_EXPORT void fl_close_display();

// constant info about the X server connection:
extern FL_EXPORT Display *fl_display;
extern FL_EXPORT int fl_screen;
extern FL_EXPORT XVisualInfo *fl_visual;
extern FL_EXPORT Colormap fl_colormap;

// drawing functions:
extern FL_EXPORT GC fl_gc;
extern FL_EXPORT Window fl_window;
extern FL_EXPORT XFontStruct* fl_xfont;
FL_EXPORT ulong fl_xpixel(Fl_Color i);
FL_EXPORT ulong fl_xpixel(uchar r, uchar g, uchar b);
FL_EXPORT void fl_clip_region(Region);
FL_EXPORT Region XRectangleRegion(int x, int y, int w, int h); // in fl_rect.cxx

// feed events into fltk:
FL_EXPORT int fl_handle(const XEvent&);

// you can use these in Fl::add_handler() to look at events:
extern FL_EXPORT const XEvent* fl_xevent;
extern FL_EXPORT ulong fl_event_time;

// off-screen pixmaps: create, destroy, draw into, copy to window:
#define Fl_Offscreen ulong
#define fl_create_offscreen(w,h) \
  XCreatePixmap(fl_display, fl_window, w, h, fl_visual->depth)
// begin/end are macros that save the old state in local variables:
#define fl_begin_offscreen(pixmap) \
  Window _sw=fl_window; fl_window=pixmap; fl_push_no_clip()
#define fl_end_offscreen() \
  fl_pop_clip(); fl_window = _sw

#define fl_copy_offscreen(x,y,w,h,pixmap,srcx,srcy) \
  XCopyArea(fl_display, pixmap, fl_window, fl_gc, srcx, srcy, w, h, x, y)
#define fl_delete_offscreen(pixmap) XFreePixmap(fl_display, pixmap)

// this object contains all X-specific stuff about a window:
// Warning: this object is highly subject to change!  It's definition
// is only here so that fl_xid can be declared inline:
class Fl_X {
public:
  Window xid;
  Window other_xid;
  Fl_Window *w;
  Region region;
  Fl_X *next;
  char wait_for_expose;
  char backbuffer_bad; // used for XDBE
  static FL_EXPORT Fl_X* first;
  static FL_EXPORT Fl_X* i(const Fl_Window* w) {return w->i;}
  FL_EXPORT void setwindow(Fl_Window* wi) {w=wi; wi->i=this;}
  FL_EXPORT void sendxjunk();
  static FL_EXPORT void make_xid(Fl_Window*,XVisualInfo* =fl_visual, Colormap=fl_colormap);
  static FL_EXPORT Fl_X* set_xid(Fl_Window*, Window);
  // kludges to get around protection:
  FL_EXPORT void flush() {w->flush();}
  static FL_EXPORT void x(Fl_Window* w, int X) {w->x(X);}
  static FL_EXPORT void y(Fl_Window* w, int Y) {w->y(Y);}
};

// convert xid <-> Fl_Window:
inline Window fl_xid(const Fl_Window*w) {return Fl_X::i(w)->xid;}
FL_EXPORT Fl_Window* fl_find(Window xid);

extern FL_EXPORT char fl_override_redirect; // hack into Fl_X::make_xid()
extern FL_EXPORT int fl_background_pixel;  // hack into Fl_X::make_xid()

// More hacking in Fl_X::make_xid(), this time to be able to add
// some more window properties before XMapWindow.

struct Fl_Window_Properties {
	unsigned int flags;
	unsigned int layer;
	unsigned int decoration;
	unsigned int hints;
};

extern FL_EXPORT Fl_Window_Properties fl_window_properties;

// Flags
enum {
  FL_WIN_LAYER = 1,
  FL_WIN_DECORATION = 2,
  FL_WIN_HINTS = 4
};

// Top-level window layers.
// Under X, these translate to the layers supported by
// GNOME-compliant window managers.
// Under Win32 (not implemented), only normal and ontop would be meaningful,
// with ontop translating to the Win32 WS_EX_TOPMOST.
enum Fl_Layer {
  FL_WIN_LAYER_DESKTOP = 0,
  FL_WIN_LAYER_BELOW = 2,
  FL_WIN_LAYER_NORMAL = 4,
  FL_WIN_LAYER_ONTOP = 6,
  FL_WIN_LAYER_DOCK = 8,
  FL_WIN_LAYER_ABOVE_DOCK = 10,
  FL_WIN_LAYER_MENU = 12
};

// Top-level window decorations.
// Under X, these translate to the decoration hints supported by
// GNOME-compliant window managers.
enum Fl_Decoration {
  FL_WIN_DECORATION_NONE = 0,
  FL_WIN_DECORATION_NORMAL = 1,
  FL_WIN_DECORATION_TINY = 2,
  FL_WIN_DECORATION_TOOL = 3
};

enum Fl_Hints {
  FL_WIN_HINTS_SKIP_FOCUS =      (1<<0),  /*"alt-tab" skips this win*/
  FL_WIN_HINTS_SKIP_WINLIST =    (1<<1),  /*do not show in window list*/
  FL_WIN_HINTS_SKIP_TASKBAR =    (1<<2),  /*do not show on taskbar*/
  FL_WIN_HINTS_GROUP_TRANSIENT = (1<<3),  /*Reserved - definition is unclear*/
  FL_WIN_HINTS_FOCUS_ON_CLICK =  (1<<4),  /*app only accepts focus if clicked*/
  FL_WIN_HINTS_FIXED_POSITION =  (1<<5),  /* this window has a fixed position
                                           * (should be excluded from desktop
                                           * uncluttering etc.) */
  FL_WIN_HINTS_DO_NOT_COVER =    (1<<6)   /* attempt to never cover up this window if possible
                                           * (placement policy priority hint) */
};

#endif
#endif

//
// End of "$Id: x.H,v 1.10.2.7 2000/06/05 21:20:34 mike Exp $".
//
