mutter/clutter/x11/clutter-x11.h
Emmanuele Bassi 184df2a5fa [input] Rework input device API
The input device API is split halfway thorugh the backends in a very
weird way. The data structures are private, as they should, but most
of the information should be available in the main API since it's
generic enough.

The device type enumeration, for instance, should be common across
every backend; the accessors for device type and id should live in the
core API. The internal API should always use ClutterInputDevice and
not the private X11 implementation when dealing with public structures
like ClutterEvent.

By adding accessors for the device type and id, and by moving the
device type enumeration into the core API we can cut down the amount
of symbols private and/or visible only to the X11 backends; this way
when other backends start implementing multi-pointer support we can
share the same API across the code.
2009-06-19 13:12:05 +01:00

132 lines
4.1 KiB
C

/*
* 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, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
/**
* 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-enum-types.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;
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;
typedef struct _ClutterX11XInputDevice ClutterX11XInputDevice;
/**
* ClutterX11FilterFunc:
* @xev: Native X11 event structure
* @cev: Clutter event structure
* @data: 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);
void clutter_x11_trap_x_errors (void);
gint clutter_x11_untrap_x_errors (void);
Display *clutter_x11_get_default_display (void);
int clutter_x11_get_default_screen (void);
Window clutter_x11_get_root_window (void);
void clutter_x11_set_display (Display * xdpy);
Window clutter_x11_get_stage_window (ClutterStage *stage);
XVisualInfo *clutter_x11_get_stage_visual (ClutterStage *stage);
gboolean clutter_x11_set_stage_foreign (ClutterStage *stage,
Window xwindow);
void clutter_x11_add_filter (ClutterX11FilterFunc func,
gpointer data);
void clutter_x11_remove_filter (ClutterX11FilterFunc func,
gpointer data);
ClutterX11FilterReturn clutter_x11_handle_event (XEvent *xevent);
void clutter_x11_disable_event_retrieval (void);
gboolean clutter_x11_has_event_retrieval (void);
ClutterStage *clutter_x11_get_stage_from_window (Window win);
G_CONST_RETURN GSList* clutter_x11_get_input_devices (void);
void clutter_x11_enable_xinput (void);
gboolean clutter_x11_has_xinput (void);
gboolean clutter_x11_has_composite_extension (void);
Time clutter_x11_get_current_event_time (void);
G_END_DECLS
#endif /* __CLUTTER_X11_H__ */