mutter/clutter/clutter-swipe-action.h
Emmanuele Bassi 11d961b605 swipe-action: Clean up
Clean up the documentation, and use a type safe GFlags marshaller for
the ::swept signal's @direction argument - instead of a generic integer
marshaller.

http://bugzilla.clutter-project.org/show_bug.cgi?id=2585
2011-06-10 15:15:15 +01:00

121 lines
4.0 KiB
C

/*
* Clutter.
*
* An OpenGL based 'interactive canvas' library.
*
* Copyright (C) 2010 Intel Corporation.
* Copyright (C) 2011 Robert Bosch Car Multimedia GmbH.
*
* 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/>.
*
* Author:
* Tomeu Vizoso <tomeu.vizoso@collabora.co.uk>
*
* Based on ClutterDragAction, written by:
* Emmanuele Bassi <ebassi@linux.intel.com>
*/
#if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
#error "Only <clutter/clutter.h> can be included directly."
#endif
#ifndef __CLUTTER_SWIPE_ACTION_H__
#define __CLUTTER_SWIPE_ACTION_H__
#include <clutter/clutter-gesture-action.h>
G_BEGIN_DECLS
#define CLUTTER_TYPE_SWIPE_ACTION (clutter_swipe_action_get_type ())
#define CLUTTER_SWIPE_ACTION(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_SWIPE_ACTION, ClutterSwipeAction))
#define CLUTTER_IS_SWIPE_ACTION(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_SWIPE_ACTION))
#define CLUTTER_SWIPE_ACTION_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), CLUTTER_TYPE_SWIPE_ACTION, ClutterSwipeActionClass))
#define CLUTTER_IS_SWIPE_ACTION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), CLUTTER_TYPE_SWIPE_ACTION))
#define CLUTTER_SWIPE_ACTION_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), CLUTTER_TYPE_SWIPE_ACTION, ClutterSwipeActionClass))
typedef struct _ClutterSwipeAction ClutterSwipeAction;
typedef struct _ClutterSwipeActionPrivate ClutterSwipeActionPrivate;
typedef struct _ClutterSwipeActionClass ClutterSwipeActionClass;
/**
* ClutterSwipeDirection:
* @CLUTTER_SWIPE_DIRECTION_UP: Upwards swipe gesture
* @CLUTTER_SWIPE_DIRECTION_DOWN: Downwards swipe gesture
* @CLUTTER_SWIPE_DIRECTION_LEFT: Leftwards swipe gesture
* @CLUTTER_SWIPE_DIRECTION_RIGHT: Rightwards swipe gesture
*
* The main direction of the swipe gesture
*
* Since: 1.8
*/
typedef enum { /*< prefix=CLUTTER_SWIPE_DIRECTION >*/
CLUTTER_SWIPE_DIRECTION_UP = 1 << 0,
CLUTTER_SWIPE_DIRECTION_DOWN = 1 << 1,
CLUTTER_SWIPE_DIRECTION_LEFT = 1 << 2,
CLUTTER_SWIPE_DIRECTION_RIGHT = 1 << 3
} ClutterSwipeDirection;
/**
* ClutterSwipeAction:
*
* The <structname>ClutterSwipeAction</structname> structure contains
* only private data and should be accessed using the provided API
*
* Since: 1.8
*/
struct _ClutterSwipeAction
{
/*< private >*/
ClutterGestureAction parent_instance;
ClutterSwipeActionPrivate *priv;
};
/**
* ClutterSwipeActionClass:
* @swept: class handler for the #ClutterSwipeAction::swept signal
*
* The <structname>ClutterSwipeActionClass</structname> structure contains
* only private data.
*
* Since: 1.8
*/
struct _ClutterSwipeActionClass
{
/*< private >*/
ClutterGestureActionClass parent_class;
/*< public >*/
void (* swept) (ClutterSwipeAction *action,
ClutterActor *actor,
ClutterSwipeDirection direction);
/*< private >*/
void (* _clutter_swipe_action1) (void);
void (* _clutter_swipe_action2) (void);
void (* _clutter_swipe_action3) (void);
void (* _clutter_swipe_action4) (void);
void (* _clutter_swipe_action5) (void);
void (* _clutter_swipe_action6) (void);
void (* _clutter_swipe_action7) (void);
};
GType clutter_swipe_action_get_type (void) G_GNUC_CONST;
ClutterAction * clutter_swipe_action_new (void);
G_END_DECLS
#endif /* __CLUTTER_SWIPE_ACTION_H__ */