mirror of
https://github.com/brl/mutter.git
synced 2024-11-30 03:50:47 -05:00
ca3e1b4d11
We want to avoid clutter-x11.h leaking Clutter symbols (i.e. you need to include clutter.h yourself before including clutter-x11.h), but we need to do so conditionally, so that ancillary stuff like gtk-doc and g-ir-scanner get the right types while building Clutter itself.
148 lines
4.4 KiB
C
148 lines
4.4 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, 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 clutter-types.h conditionally; users including clutter-x11.h will
|
|
* have to include clutter.h as well.
|
|
*/
|
|
#ifdef CLUTTER_COMPILATION
|
|
#include <clutter/clutter-types.h>
|
|
#endif
|
|
|
|
#include <X11/Xlib.h>
|
|
#include <X11/Xatom.h>
|
|
#include <X11/Xutil.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.
|
|
*
|
|
*
|
|
*/
|
|
typedef enum {
|
|
CLUTTER_X11_FILTER_CONTINUE,
|
|
CLUTTER_X11_FILTER_TRANSLATE,
|
|
CLUTTER_X11_FILTER_REMOVE
|
|
} ClutterX11FilterReturn;
|
|
|
|
/*
|
|
* 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: user data passed to the filter function
|
|
*
|
|
* Filter function for X11 native events.
|
|
*
|
|
* Return value: the result of the filtering
|
|
*
|
|
*
|
|
*/
|
|
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);
|
|
XVisualInfo *clutter_x11_get_visual_info (void);
|
|
void clutter_x11_set_display (Display * xdpy);
|
|
|
|
Window clutter_x11_get_stage_window (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);
|
|
|
|
void clutter_x11_enable_xinput (void);
|
|
gboolean clutter_x11_has_xinput (void);
|
|
|
|
gboolean clutter_x11_has_composite_extension (void);
|
|
|
|
void clutter_x11_set_use_argb_visual (gboolean use_argb);
|
|
gboolean clutter_x11_get_use_argb_visual (void);
|
|
|
|
Time clutter_x11_get_current_event_time (void);
|
|
|
|
gint clutter_x11_event_get_key_group (const ClutterEvent *event);
|
|
|
|
guint clutter_x11_event_sequence_get_touch_detail (const ClutterEventSequence *sequence);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __CLUTTER_X11_H__ */
|