isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-12-26 12:52:14 +00:00
Code Issues Packages Projects Releases Wiki Activity
bdf12d359a
mutter/clutter/clutter-drag-action.h

153 lines
6.5 KiB
C
Raw Normal View History

action: Add DragAction, an action implementing drag capabilities DragAction is an Action sub-class that provides dragging capabilities to any actor. DragAction has: • drag-begin, drag-motion and drag-end signals, relaying the event information like coordinates, button and modifiers to user code; • drag-threshold property, for delaying the drag start by a given amount of pixels; • drag-handle property, to allow using other actors as the drag handle. • drag-axis property, to allow constraining the dragging to a specific axis. An interactive test demonstrating the various features is also provided.
2010-05-12 11:00:33 +00:00
/*
* Clutter.
*
* An OpenGL based 'interactive canvas' library.
*
* Copyright (C) 2010 Intel Corporation.
*
* 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:
* Emmanuele Bassi <ebassi@linux.intel.com>
*/
Move header inclusion guard at the top GCC has some optimization for the inclusion guard, but they only work if the check is the outermost one. We're fairly inconsistent because of historical reasons, so we should ensure that we follow the same pattern in every public header.
2015-07-07 14:51:13 +00:00
#ifndef __CLUTTER_DRAG_ACTION_H__
#define __CLUTTER_DRAG_ACTION_H__
action: Add DragAction, an action implementing drag capabilities DragAction is an Action sub-class that provides dragging capabilities to any actor. DragAction has: • drag-begin, drag-motion and drag-end signals, relaying the event information like coordinates, button and modifiers to user code; • drag-threshold property, for delaying the drag start by a given amount of pixels; • drag-handle property, to allow using other actors as the drag handle. • drag-axis property, to allow constraining the dragging to a specific axis. An interactive test demonstrating the various features is also provided.
2010-05-12 11:00:33 +00:00
#if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
#error "Only <clutter/clutter.h> can be included directly."
#endif
#include <clutter/clutter-action.h>
#include <clutter/clutter-event.h>
G_BEGIN_DECLS
#define CLUTTER_TYPE_DRAG_ACTION (clutter_drag_action_get_type ())
#define CLUTTER_DRAG_ACTION(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_DRAG_ACTION, ClutterDragAction))
#define CLUTTER_IS_DRAG_ACTION(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_DRAG_ACTION))
#define CLUTTER_DRAG_ACTION_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), CLUTTER_TYPE_DRAG_ACTION, ClutterDragActionClass))
#define CLUTTER_IS_DRAG_ACTION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), CLUTTER_TYPE_DRAG_ACTION))
#define CLUTTER_DRAG_ACTION_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), CLUTTER_TYPE_DRAG_ACTION, ClutterDragActionClass))
typedef struct _ClutterDragAction ClutterDragAction;
typedef struct _ClutterDragActionPrivate ClutterDragActionPrivate;
typedef struct _ClutterDragActionClass ClutterDragActionClass;
/**
* ClutterDragAction:
*
docs: Remove last stray DocBook tags
2014-03-18 14:14:22 +00:00
* The #ClutterDragAction structure contains only
action: Add DragAction, an action implementing drag capabilities DragAction is an Action sub-class that provides dragging capabilities to any actor. DragAction has: • drag-begin, drag-motion and drag-end signals, relaying the event information like coordinates, button and modifiers to user code; • drag-threshold property, for delaying the drag start by a given amount of pixels; • drag-handle property, to allow using other actors as the drag handle. • drag-axis property, to allow constraining the dragging to a specific axis. An interactive test demonstrating the various features is also provided.
2010-05-12 11:00:33 +00:00
* private data and should be accessed using the provided API
*
* Since: 1.4
*/
struct _ClutterDragAction
{
/*< private >*/
ClutterAction parent_instance;
ClutterDragActionPrivate *priv;
};
/**
* ClutterDragActionClass:
* @drag_begin: class handler of the #ClutterDragAction::drag-begin signal
* @drag_motion: class handler of the #ClutterDragAction::drag-motion signal
* @drag_end: class handler of the #ClutterDragAction::drag-end signal
Documentation fixes
2012-07-11 14:27:56 +00:00
* @drag_progress: class handler of the #ClutterDragAction::drag-progress signal
action: Add DragAction, an action implementing drag capabilities DragAction is an Action sub-class that provides dragging capabilities to any actor. DragAction has: • drag-begin, drag-motion and drag-end signals, relaying the event information like coordinates, button and modifiers to user code; • drag-threshold property, for delaying the drag start by a given amount of pixels; • drag-handle property, to allow using other actors as the drag handle. • drag-axis property, to allow constraining the dragging to a specific axis. An interactive test demonstrating the various features is also provided.
2010-05-12 11:00:33 +00:00
*
docs: Remove last stray DocBook tags
2014-03-18 14:14:22 +00:00
* The #ClutterDragActionClass structure contains
action: Add DragAction, an action implementing drag capabilities DragAction is an Action sub-class that provides dragging capabilities to any actor. DragAction has: • drag-begin, drag-motion and drag-end signals, relaying the event information like coordinates, button and modifiers to user code; • drag-threshold property, for delaying the drag start by a given amount of pixels; • drag-handle property, to allow using other actors as the drag handle. • drag-axis property, to allow constraining the dragging to a specific axis. An interactive test demonstrating the various features is also provided.
2010-05-12 11:00:33 +00:00
* only private data
*
* Since: 1.4
*/
struct _ClutterDragActionClass
{
/*< private >*/
ClutterActionClass parent_class;
/*< public >*/
drag-action: Add ::drag-progress signal Overriding the default behaviour of ClutterDragAction::drag-motion is currently a pain; you either need to subclass the ClutterDragAction and override the class closure for the signal, or you need to connect to the signal and call g_signal_stop_emission_by_name() - neither option being particularly nice or clean. The established pattern for these cases would be to have a boolean return value on the ::drag-motion signal, but we cannot do that without breaking ABI. To solve the issue in a backward compatible way, we should introduce a new signal, ::drag-progress, with a boolean return value. If the signal emission chain returns TRUE, the ::drag-motion signal will be emitted, and the default behaviour will be honoured; if the signal emission chain returns FALSE, instead, the ::drag-motion signal will not be emitted. https://bugzilla.gnome.org/show_bug.cgi?id=679451
2012-06-24 11:07:40 +00:00
void (* drag_begin) (ClutterDragAction *action,
ClutterActor *actor,
gfloat event_x,
gfloat event_y,
ClutterModifierType modifiers);
void (* drag_motion) (ClutterDragAction *action,
ClutterActor *actor,
gfloat delta_x,
gfloat delta_y);
void (* drag_end) (ClutterDragAction *action,
ClutterActor *actor,
gfloat event_x,
gfloat event_y,
ClutterModifierType modifiers);
gboolean (* drag_progress) (ClutterDragAction *action,
ClutterActor *actor,
gfloat delta_x,
gfloat delta_y);
action: Add DragAction, an action implementing drag capabilities DragAction is an Action sub-class that provides dragging capabilities to any actor. DragAction has: • drag-begin, drag-motion and drag-end signals, relaying the event information like coordinates, button and modifiers to user code; • drag-threshold property, for delaying the drag start by a given amount of pixels; • drag-handle property, to allow using other actors as the drag handle. • drag-axis property, to allow constraining the dragging to a specific axis. An interactive test demonstrating the various features is also provided.
2010-05-12 11:00:33 +00:00
/*< private >*/
void (* _clutter_drag_action1) (void);
void (* _clutter_drag_action2) (void);
void (* _clutter_drag_action3) (void);
void (* _clutter_drag_action4) (void);
};
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 18:19:52 +00:00
CLUTTER_AVAILABLE_IN_1_4
action: Add DragAction, an action implementing drag capabilities DragAction is an Action sub-class that provides dragging capabilities to any actor. DragAction has: • drag-begin, drag-motion and drag-end signals, relaying the event information like coordinates, button and modifiers to user code; • drag-threshold property, for delaying the drag start by a given amount of pixels; • drag-handle property, to allow using other actors as the drag handle. • drag-axis property, to allow constraining the dragging to a specific axis. An interactive test demonstrating the various features is also provided.
2010-05-12 11:00:33 +00:00
GType clutter_drag_action_get_type (void) G_GNUC_CONST;
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 18:19:52 +00:00
CLUTTER_AVAILABLE_IN_1_4
action: Add DragAction, an action implementing drag capabilities DragAction is an Action sub-class that provides dragging capabilities to any actor. DragAction has: • drag-begin, drag-motion and drag-end signals, relaying the event information like coordinates, button and modifiers to user code; • drag-threshold property, for delaying the drag start by a given amount of pixels; • drag-handle property, to allow using other actors as the drag handle. • drag-axis property, to allow constraining the dragging to a specific axis. An interactive test demonstrating the various features is also provided.
2010-05-12 11:00:33 +00:00
ClutterAction * clutter_drag_action_new (void);
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 18:19:52 +00:00
CLUTTER_AVAILABLE_IN_1_4
action: Add DragAction, an action implementing drag capabilities DragAction is an Action sub-class that provides dragging capabilities to any actor. DragAction has: • drag-begin, drag-motion and drag-end signals, relaying the event information like coordinates, button and modifiers to user code; • drag-threshold property, for delaying the drag start by a given amount of pixels; • drag-handle property, to allow using other actors as the drag handle. • drag-axis property, to allow constraining the dragging to a specific axis. An interactive test demonstrating the various features is also provided.
2010-05-12 11:00:33 +00:00
void clutter_drag_action_set_drag_threshold (ClutterDragAction *action,
drag-action: Allow using settings for the drag threshold ClutterDragAction should be able to use the newly added ClutterSettings property exposing the system's drag threshold. Currently, the x-drag-threshold and the y-drag-threshold properties (and relative accessors) use an unsigned integer for their values; we should be able to safely expand the range to include -1 as the minimum value, and use this new value to tell the ClutterDragAction that it should query the ClutterSettings object for the drag threshold. The storage of the properties has been changed, albeit in a compatible way, as GObject installs a uint ↔ int transformation function for GValue automatically. The setter for the drag thresholds has been changes to use a signed integer, but the getter has been updated to always Do The Right Thing™: it never returns -1 but, instead, will return the valid drag threshold, either from the value set or from the Settings singleton. This change is ABI compatible. http://bugzilla.clutter-project.org/show_bug.cgi?id=2583
2011-02-28 17:47:50 +00:00
gint x_threshold,
gint y_threshold);
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 18:19:52 +00:00
CLUTTER_AVAILABLE_IN_1_4
drag-action: Added x-drag-threshold and y-drag-threshold properties *** This is an API change *** Replaced the original drag-threshold property with two separate horizontal (x-drag-threshold) and vertical (y-drag-threshold) thresholds. It is some times necessary to have different drag thresholds for the horizontal and vertical axes. For example, when a draggable actor is inside a horizontal scrolling area, only vertical movement must begin dragging. That can be achieved by setting the x-drag-threshold to G_MAXUINT while y-drag-threshold is something usual, say, 20 pixels. This is different than drag axis, because after the threshold has been cleared by the pointer, the draggable actor can be dragged along both axes (if allowed by the drag-axis property). http://bugzilla.clutter-project.org/show_bug.cgi?id=2291 Signed-off-by: Emmanuele Bassi <ebassi@linux.intel.com>
2010-09-03 17:00:40 +00:00
void clutter_drag_action_get_drag_threshold (ClutterDragAction *action,
guint *x_threshold,
guint *y_threshold);
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 18:19:52 +00:00
CLUTTER_AVAILABLE_IN_1_4
action: Add DragAction, an action implementing drag capabilities DragAction is an Action sub-class that provides dragging capabilities to any actor. DragAction has: • drag-begin, drag-motion and drag-end signals, relaying the event information like coordinates, button and modifiers to user code; • drag-threshold property, for delaying the drag start by a given amount of pixels; • drag-handle property, to allow using other actors as the drag handle. • drag-axis property, to allow constraining the dragging to a specific axis. An interactive test demonstrating the various features is also provided.
2010-05-12 11:00:33 +00:00
void clutter_drag_action_set_drag_handle (ClutterDragAction *action,
ClutterActor *handle);
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 18:19:52 +00:00
CLUTTER_AVAILABLE_IN_1_4
action: Add DragAction, an action implementing drag capabilities DragAction is an Action sub-class that provides dragging capabilities to any actor. DragAction has: • drag-begin, drag-motion and drag-end signals, relaying the event information like coordinates, button and modifiers to user code; • drag-threshold property, for delaying the drag start by a given amount of pixels; • drag-handle property, to allow using other actors as the drag handle. • drag-axis property, to allow constraining the dragging to a specific axis. An interactive test demonstrating the various features is also provided.
2010-05-12 11:00:33 +00:00
ClutterActor * clutter_drag_action_get_drag_handle (ClutterDragAction *action);
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 18:19:52 +00:00
CLUTTER_AVAILABLE_IN_1_4
action: Add DragAction, an action implementing drag capabilities DragAction is an Action sub-class that provides dragging capabilities to any actor. DragAction has: • drag-begin, drag-motion and drag-end signals, relaying the event information like coordinates, button and modifiers to user code; • drag-threshold property, for delaying the drag start by a given amount of pixels; • drag-handle property, to allow using other actors as the drag handle. • drag-axis property, to allow constraining the dragging to a specific axis. An interactive test demonstrating the various features is also provided.
2010-05-12 11:00:33 +00:00
void clutter_drag_action_set_drag_axis (ClutterDragAction *action,
ClutterDragAxis axis);
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 18:19:52 +00:00
CLUTTER_AVAILABLE_IN_1_4
action: Add DragAction, an action implementing drag capabilities DragAction is an Action sub-class that provides dragging capabilities to any actor. DragAction has: • drag-begin, drag-motion and drag-end signals, relaying the event information like coordinates, button and modifiers to user code; • drag-threshold property, for delaying the drag start by a given amount of pixels; • drag-handle property, to allow using other actors as the drag handle. • drag-axis property, to allow constraining the dragging to a specific axis. An interactive test demonstrating the various features is also provided.
2010-05-12 11:00:33 +00:00
ClutterDragAxis clutter_drag_action_get_drag_axis (ClutterDragAction *action);
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 18:19:52 +00:00
CLUTTER_AVAILABLE_IN_1_4
action: Add DragAction, an action implementing drag capabilities DragAction is an Action sub-class that provides dragging capabilities to any actor. DragAction has: • drag-begin, drag-motion and drag-end signals, relaying the event information like coordinates, button and modifiers to user code; • drag-threshold property, for delaying the drag start by a given amount of pixels; • drag-handle property, to allow using other actors as the drag handle. • drag-axis property, to allow constraining the dragging to a specific axis. An interactive test demonstrating the various features is also provided.
2010-05-12 11:00:33 +00:00
void clutter_drag_action_get_press_coords (ClutterDragAction *action,
gfloat *press_x,
gfloat *press_y);
Annotate all public symbols We are going to switch to compiler annotations to determine the visibility of the symbols.
2014-03-17 18:19:52 +00:00
CLUTTER_AVAILABLE_IN_1_4
action: Add DragAction, an action implementing drag capabilities DragAction is an Action sub-class that provides dragging capabilities to any actor. DragAction has: • drag-begin, drag-motion and drag-end signals, relaying the event information like coordinates, button and modifiers to user code; • drag-threshold property, for delaying the drag start by a given amount of pixels; • drag-handle property, to allow using other actors as the drag handle. • drag-axis property, to allow constraining the dragging to a specific axis. An interactive test demonstrating the various features is also provided.
2010-05-12 11:00:33 +00:00
void clutter_drag_action_get_motion_coords (ClutterDragAction *action,
gfloat *motion_x,
gfloat *motion_y);
ClutterDragAction: allow constraining the movement of the dragged actor Allow setting a ClutterRect on the drag action and force the dragged actor's position to be always within that rectangle (relative to the actor's parent). https://bugzilla.gnome.org/show_bug.cgi?id=681168
2012-08-03 22:13:04 +00:00
CLUTTER_AVAILABLE_IN_1_12
gboolean clutter_drag_action_get_drag_area (ClutterDragAction *action,
ClutterRect *drag_area);
CLUTTER_AVAILABLE_IN_1_12
void clutter_drag_action_set_drag_area (ClutterDragAction *action,
const ClutterRect *drag_area);
action: Add DragAction, an action implementing drag capabilities DragAction is an Action sub-class that provides dragging capabilities to any actor. DragAction has: • drag-begin, drag-motion and drag-end signals, relaying the event information like coordinates, button and modifiers to user code; • drag-threshold property, for delaying the drag start by a given amount of pixels; • drag-handle property, to allow using other actors as the drag handle. • drag-axis property, to allow constraining the dragging to a specific axis. An interactive test demonstrating the various features is also provided.
2010-05-12 11:00:33 +00:00
G_END_DECLS
#endif /* __CLUTTER_DRAG_ACTION_H__ */
Reference in New Issue Copy Permalink