openbox/openbox/stacking.h
2007-06-03 17:55:49 +00:00

78 lines
3 KiB
C

/* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
stacking.h for the Openbox window manager
Copyright (c) 2006 Mikael Magnusson
Copyright (c) 2003-2007 Dana Jansens
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
See the COPYING file for a copy of the GNU General Public License.
*/
#ifndef __stacking_h
#define __stacking_h
#include "window.h"
#include <glib.h>
#include <X11/Xlib.h>
/*! The possible stacking layers a client window can be a part of */
typedef enum {
OB_STACKING_LAYER_INVALID,
OB_STACKING_LAYER_DESKTOP, /*!< 0 - desktop windows */
OB_STACKING_LAYER_BELOW, /*!< 1 - normal windows w/ below */
OB_STACKING_LAYER_NORMAL, /*!< 2 - normal windows */
OB_STACKING_LAYER_ABOVE, /*!< 3 - normal windows w/ above */
OB_STACKING_LAYER_FULLSCREEN, /*!< 4 - fullscreeen windows */
OB_STACKING_LAYER_INTERNAL, /*!< 5 - openbox windows/menus */
OB_NUM_STACKING_LAYERS
} ObStackingLayer;
/* list of ObWindow*s in stacking order from highest to lowest */
extern GList *stacking_list;
/*! Sets the window stacking list on the root window from the
stacking_list */
void stacking_set_list();
void stacking_add(ObWindow *win);
void stacking_add_nonintrusive(ObWindow *win);
#define stacking_remove(win) stacking_list = g_list_remove(stacking_list, win);
/*! Raises a window above all others in its stacking layer */
void stacking_raise(ObWindow *window);
/*! Lowers a window below all others in its stacking layer */
void stacking_lower(ObWindow *window);
/*! Moves a window below another if its in the same layer.
This function does not enforce stacking rules IRT transients n such, and so
it should really ONLY be used to restore stacking orders from saved sessions
*/
void stacking_below(ObWindow *window, ObWindow *below);
/*! Restack a window based upon a sibling (or all windows) in various ways.
@param client The client to be restacked
@param sibling Another client to compare to, or NULL to compare to all
windows
@param detail One of Above, Below, TopIf, BottomIf, Opposite
@param activate If TRUE, and if the window is going to be raised, it will
be activated instead
@return TRUE if the client was restacked
See http://tronche.com/gui/x/xlib/window/configure.html for details on
how each detail works with and without a sibling.
*/
gboolean stacking_restack_request(struct _ObClient *client,
struct _ObClient *sibling,
gint detail, gboolean activate);
#endif