e3dd18dc0c
* clutter/clutter-binding-pool.h: Fix the ActivateFunc documentation by adding a "return value" annotation.
96 lines
4.6 KiB
C
96 lines
4.6 KiB
C
/*
|
|
* Clutter.
|
|
*
|
|
* An OpenGL based 'interactive canvas' library.
|
|
*
|
|
* Copyright (C) 2008 Intel Corporation.
|
|
*
|
|
* Authored By: Emmanuele Bassi <ebassi@linux.intel.com>
|
|
*
|
|
* 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_BINDING_POOL_H__
|
|
#define __CLUTTER_BINDING_POOL_H__
|
|
|
|
#include <glib-object.h>
|
|
#include <clutter/clutter-event.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
typedef struct _ClutterBindingPool ClutterBindingPool;
|
|
|
|
/**
|
|
* ClutterBindingActionFunc:
|
|
* @gobject: a #GObject
|
|
* @action_name: the name of the action
|
|
* @key_val: the key symbol
|
|
* @modifiers: bitmask of the modifier flags
|
|
*
|
|
* The prototype for the callback function registered with
|
|
* clutter_binding_pool_install_action() and invoked by
|
|
* clutter_binding_pool_activate().
|
|
*
|
|
* Return value: the function should return %TRUE if the key
|
|
* binding has been handled, and return %FALSE otherwise
|
|
*
|
|
* Since: 1.0
|
|
*/
|
|
typedef gboolean (* ClutterBindingActionFunc) (GObject *gobject,
|
|
const gchar *action_name,
|
|
guint key_val,
|
|
ClutterModifierType modifiers);
|
|
|
|
ClutterBindingPool * clutter_binding_pool_new (const gchar *name);
|
|
ClutterBindingPool * clutter_binding_pool_get_for_class (gpointer klass);
|
|
ClutterBindingPool * clutter_binding_pool_find (const gchar *name);
|
|
|
|
void clutter_binding_pool_install_action (ClutterBindingPool *pool,
|
|
const gchar *action_name,
|
|
guint key_val,
|
|
ClutterModifierType modifiers,
|
|
GCallback callback,
|
|
gpointer data,
|
|
GDestroyNotify notify);
|
|
void clutter_binding_pool_install_closure (ClutterBindingPool *pool,
|
|
const gchar *action_name,
|
|
guint key_val,
|
|
ClutterModifierType modifiers,
|
|
GClosure *closure);
|
|
|
|
gchar ** clutter_binding_pool_list_actions (ClutterBindingPool *pool);
|
|
G_CONST_RETURN gchar *clutter_binding_pool_find_action (ClutterBindingPool *pool,
|
|
guint key_val,
|
|
ClutterModifierType modifiers);
|
|
void clutter_binding_pool_remove_action (ClutterBindingPool *pool,
|
|
guint key_val,
|
|
ClutterModifierType modifiers);
|
|
|
|
gboolean clutter_binding_pool_activate (ClutterBindingPool *pool,
|
|
guint key_val,
|
|
ClutterModifierType modifiers,
|
|
GObject *gobject);
|
|
|
|
void clutter_binding_pool_block_action (ClutterBindingPool *pool,
|
|
const gchar *action_name);
|
|
void clutter_binding_pool_unblock_action (ClutterBindingPool *pool,
|
|
const gchar *action_name);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __CLUTTER_BINDING_POOL_H__ */
|