mirror of
https://github.com/brl/mutter.git
synced 2024-12-26 21:02:14 +00:00
a2f8ce175f
* Add documentation for all undocumented symbols * Add an overview section
136 lines
4.5 KiB
C
136 lines
4.5 KiB
C
/* CALLY - The Clutter Accessibility Implementation Library
|
|
*
|
|
* Copyright (C) 2008 Igalia, S.L.
|
|
*
|
|
* Author: Alejandro Piñeiro Iglesias <apinheiro@igalia.com>
|
|
*
|
|
* Some parts are based on GailWidget from GAIL
|
|
* GAIL - The GNOME Accessibility Implementation Library
|
|
* Copyright 2001, 2002, 2003 Sun Microsystems Inc.
|
|
*
|
|
* 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(__CALLY_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
|
|
#error "Only <cally/cally.h> can be included directly."
|
|
#endif
|
|
|
|
#ifndef __CALLY_ACTOR_H__
|
|
#define __CALLY_ACTOR_H__
|
|
|
|
#include <atk/atk.h>
|
|
#include <clutter/clutter-actor.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
#define CALLY_TYPE_ACTOR (cally_actor_get_type ())
|
|
#define CALLY_ACTOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CALLY_TYPE_ACTOR, CallyActor))
|
|
#define CALLY_ACTOR_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), CALLY_TYPE_ACTOR, CallyActorClass))
|
|
#define CALLY_IS_ACTOR(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CALLY_TYPE_ACTOR))
|
|
#define CALLY_IS_ACTOR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), CALLY_TYPE_ACTOR))
|
|
#define CALLY_ACTOR_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), CALLY_TYPE_ACTOR, CallyActorClass))
|
|
|
|
typedef struct _CallyActor CallyActor;
|
|
typedef struct _CallyActorClass CallyActorClass;
|
|
typedef struct _CallyActorPrivate CallyActorPrivate;
|
|
|
|
/**
|
|
* CallyActionFunc:
|
|
* @cally_actor: a #CallyActor
|
|
*
|
|
* Action function, to be used on #AtkAction implementations as a individual
|
|
* action
|
|
*
|
|
* Since: 1.4
|
|
*/
|
|
typedef void (* CallyActionFunc) (CallyActor *cally_actor);
|
|
|
|
/**
|
|
* CallyActor:
|
|
*
|
|
* The <structname>CallyActor</structname> structure contains only private
|
|
* data and should be accessed using the provided API
|
|
*
|
|
* Since: 1.4
|
|
*/
|
|
struct _CallyActor
|
|
{
|
|
/*< private >*/
|
|
AtkGObjectAccessible parent;
|
|
|
|
CallyActorPrivate *priv;
|
|
};
|
|
|
|
/**
|
|
* CallyActorClass:
|
|
* @notify_clutter: Signal handler for notify signal on Clutter actor
|
|
* @focus_clutter: Signal handler for key-focus-in and key-focus-out signal on Clutter actor
|
|
* @add_actor: Signal handler for actor-added signal on ClutterContainer interface
|
|
* @remove_actor: Signal handler for actor-added signal on ClutterContainer interface
|
|
*
|
|
* The <structname>CallyActorClass</structname> structure contains only
|
|
* private data
|
|
*
|
|
* Since: 1.4
|
|
*/
|
|
struct _CallyActorClass
|
|
{
|
|
/*< private >*/
|
|
AtkGObjectAccessibleClass parent_class;
|
|
|
|
/*< public >*/
|
|
/* Signal handler for notify signal on Clutter Actor */
|
|
void (*notify_clutter) (GObject *object,
|
|
GParamSpec *pspec);
|
|
|
|
/*
|
|
* Signal handler for key_focus_in and key_focus_out on Clutter Actor
|
|
*/
|
|
gboolean (*focus_clutter) (ClutterActor *actor,
|
|
gpointer data);
|
|
|
|
gint (*add_actor) (ClutterActor *container,
|
|
ClutterActor *actor,
|
|
gpointer data);
|
|
|
|
gint (*remove_actor) (ClutterActor *container,
|
|
ClutterActor *actor,
|
|
gpointer data);
|
|
|
|
/*< private >*/
|
|
/* padding for future expansion */
|
|
gpointer _padding_dummy[32];
|
|
};
|
|
|
|
|
|
GType cally_actor_get_type (void) G_GNUC_CONST;
|
|
|
|
AtkObject* cally_actor_new (ClutterActor *actor);
|
|
guint cally_actor_add_action (CallyActor *cally_actor,
|
|
const gchar *action_name,
|
|
const gchar *action_description,
|
|
const gchar *action_keybinding,
|
|
CallyActionFunc action_func);
|
|
|
|
gboolean cally_actor_remove_action (CallyActor *cally_actor,
|
|
gint action_id);
|
|
|
|
gboolean cally_actor_remove_action_by_name (CallyActor *cally_actor,
|
|
const gchar *action_name);
|
|
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __CALLY_ACTOR_H__ */
|