/* pop-window-stack.h - tracks the stacking order of toplevel windows
 *
 * Copyright (C) 2007 Ray Strode <rstrode@redhat.com>
 *
 * 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, 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.  
 */
#ifndef POP_WINDOW_STACK_H
#define POP_WINDOW_STACK_H

#include <glib.h>
#include <glib-object.h>

#include <gdk/gdk.h>

G_BEGIN_DECLS
#define POP_TYPE_WINDOW_STACK (pop_window_stack_get_type ())
#define POP_WINDOW_STACK(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), POP_TYPE_WINDOW_STACK, PopWindowStack))
#define POP_WINDOW_STACK_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), POP_TYPE_WINDOW_STACK, PopWindowStackClass))
#define POP_IS_WINDOW_STACK(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), POP_TYPE_WINDOW_STACK))
#define POP_IS_WINDOW_STACK_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), POP_TYPE_WINDOW_STACK))
#define POP_WINDOW_STACK_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj), POP_TYPE_WINDOW_STACK, PopWindowStackClass))
#define POP_WINDOW_STACK_ERROR (pop_window_stack_error_quark ())
typedef struct _PopWindowStack PopWindowStack;
typedef struct _PopWindowStackClass PopWindowStackClass;
typedef struct _PopWindowStackPrivate PopWindowStackPrivate;
typedef enum _PopWindowStackError PopWindowStackError;
typedef void (* PopWindowStackForeachFunc) (PopWindowStack *stack, GdkWindow *window, gpointer user_data);
typedef void (* PopWindowStackAboveWindowForeachFunc) (PopWindowStack *stack, GdkWindow *window, GdkWindow *above_window, gpointer user_data);

struct _PopWindowStack
{
  GObject parent;

  /*< private > */
  PopWindowStackPrivate *priv;
};

struct _PopWindowStackClass
{
  GObjectClass parent_class;
};

enum _PopWindowStackError
{
  POP_WINDOW_STACK_ERROR_GENERIC = 0,
};

#ifndef POP_HIDE_FUNCTION_DECLARATIONS
GType pop_window_stack_get_type (void);
GQuark pop_window_stack_error_quark (void);

PopWindowStack *pop_window_stack_get_for_screen (GdkScreen *screen);
gboolean pop_window_stack_is_ready (PopWindowStack *stack);
guint pop_window_stack_get_length (PopWindowStack *stack);
void pop_window_stack_foreach (PopWindowStack            *stack, 
                               PopWindowStackForeachFunc  func,
                               gpointer                   user_data);
void pop_window_stack_above_window_foreach (PopWindowStack                       *stack, 
                                            GdkWindow                            *window,
                                            PopWindowStackAboveWindowForeachFunc  func,
                                            gpointer                              user_data);

#endif

G_END_DECLS
#endif /* POP_WINDOW_STACK_H */