/*
 * Clutter.
 *
 * An OpenGL based 'interactive canvas' library.
 *
 * Authored By Matthew Allum  <mallum@openedhand.com>
 *
 * Copyright (C) 2006 OpenedHand
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
 *
 *
 */

/**
 * SECTION:clutter-x11
 * @short_description: X11 specific API
 *
 * The X11 backend for Clutter provides some specific API, allowing
 * integration with the Xlibs API for embedding and manipulating the
 * stage window, or for trapping X errors.
 *
 * The ClutterX11 API is available since Clutter 0.6
 */

#ifndef __CLUTTER_X11_H__
#define __CLUTTER_X11_H__

#include <glib.h>
#include <X11/Xlib.h>
#include <X11/Xatom.h>
#include <X11/Xutil.h>
#include <clutter/clutter.h>
#include <clutter/x11/clutter-x11-texture-pixmap.h>

G_BEGIN_DECLS

/**
 * ClutterX11FilterReturn:
 * @CLUTTER_X11_FILTER_CONTINUE: The event was not handled, continues the
 *   processing
 * @CLUTTER_X11_FILTER_TRANSLATE: Native event translated into a Clutter
 *   event, stops the processing
 * @CLUTTER_X11_FILTER_REMOVE: Remove the event, stops the processing
 *
 * Return values for the #ClutterX11FilterFunc function.
 *
 * Since: 0.6
 */
typedef enum {
  CLUTTER_X11_FILTER_CONTINUE,
  CLUTTER_X11_FILTER_TRANSLATE,
  CLUTTER_X11_FILTER_REMOVE
} ClutterX11FilterReturn;

CLUTTER_AVAILABLE_IN_ALL
GType clutter_x11_filter_return_get_type (void) G_GNUC_CONST;

/*
 * This is an internal only enumeration; it should really be private
 */
typedef enum {
  CLUTTER_X11_XINPUT_KEY_PRESS_EVENT = 0,
  CLUTTER_X11_XINPUT_KEY_RELEASE_EVENT,
  CLUTTER_X11_XINPUT_BUTTON_PRESS_EVENT,
  CLUTTER_X11_XINPUT_BUTTON_RELEASE_EVENT,
  CLUTTER_X11_XINPUT_MOTION_NOTIFY_EVENT,
  CLUTTER_X11_XINPUT_LAST_EVENT
} ClutterX11XInputEventTypes;

/*
 * This is not used any more
 */
typedef struct _ClutterX11XInputDevice ClutterX11XInputDevice;

/**
 * ClutterX11FilterFunc:
 * @xev: Native X11 event structure
 * @cev: Clutter event structure
 * @data: (closure): user data passed to the filter function
 *
 * Filter function for X11 native events.
 *
 * Return value: the result of the filtering
 *
 * Since: 0.6
 */
typedef ClutterX11FilterReturn (*ClutterX11FilterFunc) (XEvent        *xev,
                                                        ClutterEvent  *cev,
                                                        gpointer       data);

CLUTTER_AVAILABLE_IN_ALL
void     clutter_x11_trap_x_errors       (void);
CLUTTER_AVAILABLE_IN_ALL
gint     clutter_x11_untrap_x_errors     (void);

CLUTTER_AVAILABLE_IN_ALL
Display *clutter_x11_get_default_display (void);
CLUTTER_AVAILABLE_IN_ALL
int      clutter_x11_get_default_screen  (void);
CLUTTER_AVAILABLE_IN_ALL
Window   clutter_x11_get_root_window     (void);
CLUTTER_AVAILABLE_IN_ALL
XVisualInfo *clutter_x11_get_visual_info (void);
CLUTTER_AVAILABLE_IN_ALL
void     clutter_x11_set_display         (Display * xdpy);

CLUTTER_DEPRECATED_FOR(clutter_x11_get_visual_info)
XVisualInfo *clutter_x11_get_stage_visual  (ClutterStage *stage);

CLUTTER_AVAILABLE_IN_ALL
Window       clutter_x11_get_stage_window  (ClutterStage *stage);
CLUTTER_AVAILABLE_IN_ALL
gboolean     clutter_x11_set_stage_foreign (ClutterStage *stage,
                                            Window        xwindow);

CLUTTER_AVAILABLE_IN_ALL
void         clutter_x11_add_filter    (ClutterX11FilterFunc func,
                                        gpointer             data);
CLUTTER_AVAILABLE_IN_ALL
void         clutter_x11_remove_filter (ClutterX11FilterFunc func,
                                        gpointer             data);

CLUTTER_AVAILABLE_IN_ALL
ClutterX11FilterReturn clutter_x11_handle_event (XEvent *xevent);

CLUTTER_AVAILABLE_IN_ALL
void     clutter_x11_disable_event_retrieval (void);
CLUTTER_AVAILABLE_IN_ALL
gboolean clutter_x11_has_event_retrieval (void);

CLUTTER_AVAILABLE_IN_ALL
ClutterStage *clutter_x11_get_stage_from_window (Window win);

CLUTTER_DEPRECATED_FOR(clutter_device_manager_peek_devices)
const GSList* clutter_x11_get_input_devices (void);

CLUTTER_DEPRECATED_IN_1_14
void     clutter_x11_enable_xinput (void);
CLUTTER_AVAILABLE_IN_ALL
gboolean clutter_x11_has_xinput (void);

CLUTTER_AVAILABLE_IN_ALL
gboolean clutter_x11_has_composite_extension (void);

CLUTTER_AVAILABLE_IN_ALL
void     clutter_x11_set_use_argb_visual (gboolean use_argb);
CLUTTER_AVAILABLE_IN_ALL
gboolean clutter_x11_get_use_argb_visual (void);

CLUTTER_AVAILABLE_IN_1_22
void     clutter_x11_set_use_stereo_stage (gboolean use_stereo);
CLUTTER_AVAILABLE_IN_1_22
gboolean clutter_x11_get_use_stereo_stage (void);

CLUTTER_AVAILABLE_IN_ALL
Time clutter_x11_get_current_event_time (void);

CLUTTER_AVAILABLE_IN_ALL
gint clutter_x11_event_get_key_group (const ClutterEvent *event);

CLUTTER_AVAILABLE_IN_ALL
guint clutter_x11_event_sequence_get_touch_detail (const ClutterEventSequence *sequence);

G_END_DECLS

#endif /* __CLUTTER_X11_H__ */