mirror of
https://github.com/brl/mutter.git
synced 2024-09-20 06:25:51 -04:00
51a3e49c82
Embedding toolkits most likely will disable the event handling, so all
the input device code will not be executed. Unfortunately, the newly
added synthetic event generation of ENTER and LEAVE event pairs depends
on having input devices.
In order to unbreak things without reintroducing the madness of the
previous code we should allow embedding toolkits to just update the
state of an InputDevice by using the data contained inside the
ClutterEvent. This strategy has two obvious reasons:
• the embedding toolkit is creating a ClutterEvent by translating
a toolkit-native event anyway
• this is exactly what ClutterStage does when processing events
We are, essentially, deferring input device handling to the embedding
toolkits, just like we're deferring event handling to them.
413 lines
14 KiB
C
413 lines
14 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/>.
|
|
*/
|
|
|
|
#if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
|
|
#error "Only <clutter/clutter.h> can be included directly."
|
|
#endif
|
|
|
|
#ifndef __CLUTTER_TYPES_H__
|
|
#define __CLUTTER_TYPES_H__
|
|
|
|
#include <glib-object.h>
|
|
#include <clutter/clutter-units.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
#define CLUTTER_TYPE_ACTOR_BOX (clutter_actor_box_get_type ())
|
|
#define CLUTTER_TYPE_GEOMETRY (clutter_geometry_get_type ())
|
|
#define CLUTTER_TYPE_KNOT (clutter_knot_get_type ())
|
|
#define CLUTTER_TYPE_VERTEX (clutter_vertex_get_type ())
|
|
|
|
/* Forward delarations to avoid header catch 22's */
|
|
typedef struct _ClutterActor ClutterActor;
|
|
typedef struct _ClutterStage ClutterStage;
|
|
typedef struct _ClutterContainer ClutterContainer; /* dummy */
|
|
typedef struct _ClutterChildMeta ClutterChildMeta;
|
|
typedef struct _ClutterLayoutMeta ClutterLayoutMeta;
|
|
typedef struct _ClutterAnimator ClutterAnimator;
|
|
|
|
typedef union _ClutterEvent ClutterEvent;
|
|
|
|
/**
|
|
* ClutterGravity:
|
|
* @CLUTTER_GRAVITY_NONE: Do not apply any gravity
|
|
* @CLUTTER_GRAVITY_NORTH: Scale from topmost downwards
|
|
* @CLUTTER_GRAVITY_NORTH_EAST: Scale from the top right corner
|
|
* @CLUTTER_GRAVITY_EAST: Scale from the right side
|
|
* @CLUTTER_GRAVITY_SOUTH_EAST: Scale from the bottom right corner
|
|
* @CLUTTER_GRAVITY_SOUTH: Scale from the bottom upwards
|
|
* @CLUTTER_GRAVITY_SOUTH_WEST: Scale from the bottom left corner
|
|
* @CLUTTER_GRAVITY_WEST: Scale from the left side
|
|
* @CLUTTER_GRAVITY_NORTH_WEST: Scale from the top left corner
|
|
* @CLUTTER_GRAVITY_CENTER: Scale from the center.
|
|
*
|
|
* Gravity of the scaling operations. When a gravity different than
|
|
* %CLUTTER_GRAVITY_NONE is used, an actor is scaled keeping the position
|
|
* of the specified portion at the same coordinates.
|
|
*
|
|
* Since: 0.2
|
|
*/
|
|
typedef enum { /*< prefix=CLUTTER_GRAVITY >*/
|
|
CLUTTER_GRAVITY_NONE = 0,
|
|
CLUTTER_GRAVITY_NORTH,
|
|
CLUTTER_GRAVITY_NORTH_EAST,
|
|
CLUTTER_GRAVITY_EAST,
|
|
CLUTTER_GRAVITY_SOUTH_EAST,
|
|
CLUTTER_GRAVITY_SOUTH,
|
|
CLUTTER_GRAVITY_SOUTH_WEST,
|
|
CLUTTER_GRAVITY_WEST,
|
|
CLUTTER_GRAVITY_NORTH_WEST,
|
|
CLUTTER_GRAVITY_CENTER
|
|
} ClutterGravity;
|
|
|
|
typedef struct _ClutterActorBox ClutterActorBox;
|
|
typedef struct _ClutterGeometry ClutterGeometry;
|
|
typedef struct _ClutterKnot ClutterKnot;
|
|
typedef struct _ClutterVertex ClutterVertex;
|
|
|
|
/**
|
|
* ClutterVertex:
|
|
* @x: X coordinate of the vertex
|
|
* @y: Y coordinate of the vertex
|
|
* @z: Z coordinate of the vertex
|
|
*
|
|
* Vertex of an actor in 3D space, expressed in pixels
|
|
*
|
|
* Since: 0.4
|
|
*/
|
|
struct _ClutterVertex
|
|
{
|
|
gfloat x;
|
|
gfloat y;
|
|
gfloat z;
|
|
};
|
|
|
|
GType clutter_vertex_get_type (void) G_GNUC_CONST;
|
|
ClutterVertex *clutter_vertex_new (gfloat x,
|
|
gfloat y,
|
|
gfloat z);
|
|
ClutterVertex *clutter_vertex_copy (const ClutterVertex *vertex);
|
|
void clutter_vertex_free (ClutterVertex *vertex);
|
|
gboolean clutter_vertex_equal (const ClutterVertex *vertex_a,
|
|
const ClutterVertex *vertex_b);
|
|
|
|
/**
|
|
* ClutterActorBox:
|
|
* @x1: X coordinate of the top left corner
|
|
* @y1: Y coordinate of the top left corner
|
|
* @x2: X coordinate of the bottom right corner
|
|
* @y2: Y coordinate of the bottom right corner
|
|
*
|
|
* Bounding box of an actor. The coordinates of the top left and right bottom
|
|
* corners of an actor. The coordinates of the two points are expressed in
|
|
* pixels with sub-pixel precision
|
|
*/
|
|
struct _ClutterActorBox
|
|
{
|
|
gfloat x1;
|
|
gfloat y1;
|
|
|
|
gfloat x2;
|
|
gfloat y2;
|
|
};
|
|
|
|
GType clutter_actor_box_get_type (void) G_GNUC_CONST;
|
|
ClutterActorBox *clutter_actor_box_new (gfloat x_1,
|
|
gfloat y_1,
|
|
gfloat x_2,
|
|
gfloat y_2);
|
|
ClutterActorBox *clutter_actor_box_copy (const ClutterActorBox *box);
|
|
void clutter_actor_box_free (ClutterActorBox *box);
|
|
gboolean clutter_actor_box_equal (const ClutterActorBox *box_a,
|
|
const ClutterActorBox *box_b);
|
|
gfloat clutter_actor_box_get_x (const ClutterActorBox *box);
|
|
gfloat clutter_actor_box_get_y (const ClutterActorBox *box);
|
|
gfloat clutter_actor_box_get_width (const ClutterActorBox *box);
|
|
gfloat clutter_actor_box_get_height (const ClutterActorBox *box);
|
|
void clutter_actor_box_get_origin (const ClutterActorBox *box,
|
|
gfloat *x,
|
|
gfloat *y);
|
|
void clutter_actor_box_get_size (const ClutterActorBox *box,
|
|
gfloat *width,
|
|
gfloat *height);
|
|
gfloat clutter_actor_box_get_area (const ClutterActorBox *box);
|
|
gboolean clutter_actor_box_contains (const ClutterActorBox *box,
|
|
gfloat x,
|
|
gfloat y);
|
|
void clutter_actor_box_from_vertices (ClutterActorBox *box,
|
|
const ClutterVertex verts[]);
|
|
void clutter_actor_box_interpolate (const ClutterActorBox *initial,
|
|
const ClutterActorBox *final,
|
|
gdouble progress,
|
|
ClutterActorBox *result);
|
|
void clutter_actor_box_clamp_to_pixel (ClutterActorBox *box);
|
|
|
|
/**
|
|
* ClutterGeometry:
|
|
* @x: X coordinate of the top left corner of an actor
|
|
* @y: Y coordinate of the top left corner of an actor
|
|
* @width: width of an actor
|
|
* @height: height of an actor
|
|
*
|
|
* The rectangle containing an actor's bounding box, measured in pixels.
|
|
*/
|
|
struct _ClutterGeometry
|
|
{
|
|
/*< public >*/
|
|
gint x;
|
|
gint y;
|
|
guint width;
|
|
guint height;
|
|
};
|
|
|
|
GType clutter_geometry_get_type (void) G_GNUC_CONST;
|
|
|
|
/**
|
|
* ClutterKnot:
|
|
* @x: X coordinate of the knot
|
|
* @y: Y coordinate of the knot
|
|
*
|
|
* Point in a path behaviour.
|
|
*
|
|
* Since: 0.2
|
|
*/
|
|
struct _ClutterKnot
|
|
{
|
|
gint x;
|
|
gint y;
|
|
};
|
|
|
|
GType clutter_knot_get_type (void) G_GNUC_CONST;
|
|
ClutterKnot *clutter_knot_copy (const ClutterKnot *knot);
|
|
void clutter_knot_free (ClutterKnot *knot);
|
|
gboolean clutter_knot_equal (const ClutterKnot *knot_a,
|
|
const ClutterKnot *knot_b);
|
|
|
|
/**
|
|
* ClutterRotateAxis:
|
|
* @CLUTTER_X_AXIS: Rotate around the X axis
|
|
* @CLUTTER_Y_AXIS: Rotate around the Y axis
|
|
* @CLUTTER_Z_AXIS: Rotate around the Z axis
|
|
*
|
|
* Axis of a rotation.
|
|
*
|
|
* Since: 0.4
|
|
*/
|
|
typedef enum { /*< prefix=CLUTTER >*/
|
|
CLUTTER_X_AXIS,
|
|
CLUTTER_Y_AXIS,
|
|
CLUTTER_Z_AXIS
|
|
} ClutterRotateAxis;
|
|
|
|
/**
|
|
* ClutterRotateDirection:
|
|
* @CLUTTER_ROTATE_CW: Clockwise rotation
|
|
* @CLUTTER_ROTATE_CCW: Counter-clockwise rotation
|
|
*
|
|
* Direction of a rotation.
|
|
*
|
|
* Since: 0.4
|
|
*/
|
|
typedef enum { /*< prefix=CLUTTER_ROTATE >*/
|
|
CLUTTER_ROTATE_CW,
|
|
CLUTTER_ROTATE_CCW
|
|
} ClutterRotateDirection;
|
|
|
|
/**
|
|
* ClutterRequestMode:
|
|
* @CLUTTER_REQUEST_HEIGHT_FOR_WIDTH: Height for width requests
|
|
* @CLUTTER_REQUEST_WIDTH_FOR_HEIGHT: Width for height requests
|
|
*
|
|
* Specifies the type of requests for a #ClutterActor.
|
|
*
|
|
* Since: 0.8
|
|
*/
|
|
typedef enum {
|
|
CLUTTER_REQUEST_HEIGHT_FOR_WIDTH,
|
|
CLUTTER_REQUEST_WIDTH_FOR_HEIGHT
|
|
} ClutterRequestMode;
|
|
|
|
/**
|
|
* ClutterAnimationMode:
|
|
* @CLUTTER_CUSTOM_MODE: custom progress function
|
|
* @CLUTTER_LINEAR: linear tweening
|
|
* @CLUTTER_EASE_IN_QUAD: quadratic tweening
|
|
* @CLUTTER_EASE_OUT_QUAD: quadratic tweening, inverse of
|
|
* %CLUTTER_EASE_IN_QUAD
|
|
* @CLUTTER_EASE_IN_OUT_QUAD: quadratic tweening, combininig
|
|
* %CLUTTER_EASE_IN_QUAD and %CLUTTER_EASE_OUT_QUAD
|
|
* @CLUTTER_EASE_IN_CUBIC: cubic tweening
|
|
* @CLUTTER_EASE_OUT_CUBIC: cubic tweening, invers of
|
|
* %CLUTTER_EASE_IN_CUBIC
|
|
* @CLUTTER_EASE_IN_OUT_CUBIC: cubic tweening, combining
|
|
* %CLUTTER_EASE_IN_CUBIC and %CLUTTER_EASE_OUT_CUBIC
|
|
* @CLUTTER_EASE_IN_QUART: quartic tweening
|
|
* @CLUTTER_EASE_OUT_QUART: quartic tweening, inverse of
|
|
* %CLUTTER_EASE_IN_QUART
|
|
* @CLUTTER_EASE_IN_OUT_QUART: quartic tweening, combining
|
|
* %CLUTTER_EASE_IN_QUART and %CLUTTER_EASE_OUT_QUART
|
|
* @CLUTTER_EASE_IN_QUINT: quintic tweening
|
|
* @CLUTTER_EASE_OUT_QUINT: quintic tweening, inverse of
|
|
* %CLUTTER_EASE_IN_QUINT
|
|
* @CLUTTER_EASE_IN_OUT_QUINT: fifth power tweening, combining
|
|
* %CLUTTER_EASE_IN_QUINT and %CLUTTER_EASE_OUT_QUINT
|
|
* @CLUTTER_EASE_IN_SINE: sinusoidal tweening
|
|
* @CLUTTER_EASE_OUT_SINE: sinusoidal tweening, inverse of
|
|
* %CLUTTER_EASE_IN_SINE
|
|
* @CLUTTER_EASE_IN_OUT_SINE: sine wave tweening, combining
|
|
* %CLUTTER_EASE_IN_SINE and %CLUTTER_EASE_OUT_SINE
|
|
* @CLUTTER_EASE_IN_EXPO: exponential tweening
|
|
* @CLUTTER_EASE_OUT_EXPO: exponential tweening, inverse of
|
|
* %CLUTTER_EASE_IN_EXPO
|
|
* @CLUTTER_EASE_IN_OUT_EXPO: exponential tweening, combining
|
|
* %CLUTTER_EASE_IN_EXPO and %CLUTTER_EASE_OUT_EXPO
|
|
* @CLUTTER_EASE_IN_CIRC: circular tweening
|
|
* @CLUTTER_EASE_OUT_CIRC: circular tweening, inverse of
|
|
* %CLUTTER_EASE_IN_CIRC
|
|
* @CLUTTER_EASE_IN_OUT_CIRC: circular tweening, combining
|
|
* %CLUTTER_EASE_IN_CIRC and %CLUTTER_EASE_OUT_CIRC
|
|
* @CLUTTER_EASE_IN_ELASTIC: elastic tweening, with offshoot on start
|
|
* @CLUTTER_EASE_OUT_ELASTIC: elastic tweening, with offshoot on end
|
|
* @CLUTTER_EASE_IN_OUT_ELASTIC: elastic tweening with offshoot on both ends
|
|
* @CLUTTER_EASE_IN_BACK: overshooting cubic tweening, with
|
|
* backtracking on start
|
|
* @CLUTTER_EASE_OUT_BACK: overshooting cubic tweening, with
|
|
* backtracking on end
|
|
* @CLUTTER_EASE_IN_OUT_BACK: overshooting cubic tweening, with
|
|
* backtracking on both ends
|
|
* @CLUTTER_EASE_IN_BOUNCE: exponentially decaying parabolic (bounce)
|
|
* tweening, with bounce on start
|
|
* @CLUTTER_EASE_OUT_BOUNCE: exponentially decaying parabolic (bounce)
|
|
* tweening, with bounce on end
|
|
* @CLUTTER_EASE_IN_OUT_BOUNCE: exponentially decaying parabolic (bounce)
|
|
* tweening, with bounce on both ends
|
|
* @CLUTTER_ANIMATION_LAST: last animation mode, used as a guard for
|
|
* registered global alpha functions
|
|
*
|
|
* The animation modes used by #ClutterAlpha and #ClutterAnimation. This
|
|
* enumeration can be expanded in later versions of Clutter. See the
|
|
* #ClutterAlpha documentation for a graph of all the animation modes.
|
|
*
|
|
* Every global alpha function registered using clutter_alpha_register_func()
|
|
* or clutter_alpha_register_closure() will have a logical id greater than
|
|
* %CLUTTER_ANIMATION_LAST.
|
|
*
|
|
* Since: 1.0
|
|
*/
|
|
typedef enum {
|
|
CLUTTER_CUSTOM_MODE = 0,
|
|
|
|
/* linear */
|
|
CLUTTER_LINEAR,
|
|
|
|
/* quadratic */
|
|
CLUTTER_EASE_IN_QUAD,
|
|
CLUTTER_EASE_OUT_QUAD,
|
|
CLUTTER_EASE_IN_OUT_QUAD,
|
|
|
|
/* cubic */
|
|
CLUTTER_EASE_IN_CUBIC,
|
|
CLUTTER_EASE_OUT_CUBIC,
|
|
CLUTTER_EASE_IN_OUT_CUBIC,
|
|
|
|
/* quartic */
|
|
CLUTTER_EASE_IN_QUART,
|
|
CLUTTER_EASE_OUT_QUART,
|
|
CLUTTER_EASE_IN_OUT_QUART,
|
|
|
|
/* quintic */
|
|
CLUTTER_EASE_IN_QUINT,
|
|
CLUTTER_EASE_OUT_QUINT,
|
|
CLUTTER_EASE_IN_OUT_QUINT,
|
|
|
|
/* sinusoidal */
|
|
CLUTTER_EASE_IN_SINE,
|
|
CLUTTER_EASE_OUT_SINE,
|
|
CLUTTER_EASE_IN_OUT_SINE,
|
|
|
|
/* exponential */
|
|
CLUTTER_EASE_IN_EXPO,
|
|
CLUTTER_EASE_OUT_EXPO,
|
|
CLUTTER_EASE_IN_OUT_EXPO,
|
|
|
|
/* circular */
|
|
CLUTTER_EASE_IN_CIRC,
|
|
CLUTTER_EASE_OUT_CIRC,
|
|
CLUTTER_EASE_IN_OUT_CIRC,
|
|
|
|
/* elastic */
|
|
CLUTTER_EASE_IN_ELASTIC,
|
|
CLUTTER_EASE_OUT_ELASTIC,
|
|
CLUTTER_EASE_IN_OUT_ELASTIC,
|
|
|
|
/* overshooting cubic */
|
|
CLUTTER_EASE_IN_BACK,
|
|
CLUTTER_EASE_OUT_BACK,
|
|
CLUTTER_EASE_IN_OUT_BACK,
|
|
|
|
/* exponentially decaying parabolic */
|
|
CLUTTER_EASE_IN_BOUNCE,
|
|
CLUTTER_EASE_OUT_BOUNCE,
|
|
CLUTTER_EASE_IN_OUT_BOUNCE,
|
|
|
|
/* guard, before registered alpha functions */
|
|
CLUTTER_ANIMATION_LAST
|
|
} ClutterAnimationMode;
|
|
|
|
/**
|
|
* ClutterFontFlags:
|
|
* @CLUTTER_FONT_MIPMAPPING: Set to use mipmaps for the glyph cache textures.
|
|
* @CLUTTER_FONT_HINTING: Set to enable hinting on the glyphs.
|
|
*
|
|
* Runtime flags to change the font quality. To be used with
|
|
* clutter_set_font_flags().
|
|
*
|
|
* Since: 1.0
|
|
*/
|
|
typedef enum
|
|
{
|
|
CLUTTER_FONT_MIPMAPPING = (1 << 0),
|
|
CLUTTER_FONT_HINTING = (1 << 1),
|
|
} ClutterFontFlags;
|
|
|
|
/**
|
|
* ClutterTextDirection:
|
|
* @CLUTTER_TEXT_DIRECTION_DEFAULT: Use the default setting, as returned
|
|
* by clutter_get_default_text_direction()
|
|
* @CLUTTER_TEXT_DIRECTION_LTR: Use left-to-right text direction
|
|
* @CLUTTER_TEXT_DIRECTION_RTL: Use right-to-left text direction
|
|
*
|
|
* The text direction to be used by #ClutterActor<!-- -->s
|
|
*
|
|
* Since: 1.2
|
|
*/
|
|
typedef enum {
|
|
CLUTTER_TEXT_DIRECTION_DEFAULT,
|
|
CLUTTER_TEXT_DIRECTION_LTR,
|
|
CLUTTER_TEXT_DIRECTION_RTL
|
|
} ClutterTextDirection;
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __CLUTTER_TYPES_H__ */
|