openbox/window.h

   1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    window.h for the Openbox window manager
   4    Copyright (c) 2003-2007   Dana Jansens
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    See the COPYING file for a copy of the GNU General Public License.
  17 */
  18
  19 #ifndef __window_h
  20 #define __window_h
  21
  22 #include "stacking.h"
  23
  24 #include <X11/Xlib.h>
  25 #include <glib.h>
  26
  27 typedef struct _ObWindow         ObWindow;
  28 typedef struct _ObInternalWindow ObInternalWindow;
  29
  30 typedef enum {
  31     OB_WINDOW_CLASS_MENUFRAME,
  32     OB_WINDOW_CLASS_DOCK,
  33     OB_WINDOW_CLASS_CLIENT,
  34     OB_WINDOW_CLASS_INTERNALWINDOW
  35 } Window_InternalType;
  36
  37 /* In order to be an ObWindow, you need to make this struct the top of your
  38    struct */
  39 struct _ObWindow {
  40     Window_InternalType type;
  41 };
  42
  43 #define WINDOW_IS_MENUFRAME(win) \
  44     (((ObWindow*)win)->type == OB_WINDOW_CLASS_MENUFRAME)
  45 #define WINDOW_IS_DOCK(win) \
  46     (((ObWindow*)win)->type == OB_WINDOW_CLASS_DOCK)
  47 #define WINDOW_IS_CLIENT(win) \
  48     (((ObWindow*)win)->type == OB_WINDOW_CLASS_CLIENT)
  49 #define WINDOW_IS_INTERNALWINDOW(win) \
  50     (((ObWindow*)win)->type == OB_WINDOW_CLASS_INTERNALWINDOW)
  51
  52 struct _ObMenu;
  53 struct _ObDock;
  54 struct _ObDockApp;
  55 struct _ObClient;
  56
  57 #define WINDOW_AS_MENUFRAME(win) ((struct _ObMenuFrame*)win)
  58 #define WINDOW_AS_DOCK(win) ((struct _ObDock*)win)
  59 #define WINDOW_AS_CLIENT(win) ((struct _ObClient*)win)
  60 #define WINDOW_AS_INTERNALWINDOW(win) ((struct _ObInternalWindow*)win)
  61
  62 #define MENUFRAME_AS_WINDOW(menu) ((ObWindow*)menu)
  63 #define DOCK_AS_WINDOW(dock) ((ObWindow*)dock)
  64 #define CLIENT_AS_WINDOW(client) ((ObWindow*)client)
  65 #define INTERNALWINDOW_AS_WINDOW(intern) ((ObWindow*)intern)
  66
  67 void window_startup (gboolean reconfig);
  68 void window_shutdown(gboolean reconfig);
  69
  70 Window          window_top  (ObWindow *self);
  71 ObStackingLayer window_layer(ObWindow *self);
  72
  73 ObWindow* window_find  (Window xwin);
  74 void      window_add   (Window *xwin, ObWindow *win);
  75 void      window_remove(Window xwin);
  76
  77 /* Internal openbox-owned windows like the alt-tab popup */
  78 struct _ObInternalWindow {
  79     ObWindow obwin;
  80     Window window;
  81 };
  82
  83 #endif