6d4667cb61
* clutter/clutter-container.[ch]: Add checks to the Container interface invocation methods, to avoid crashing or corrupting the stack when an actor does not implement every virtual function of the Container interface vtable. GObject allows this to happen so we must handle the case gracefully. This also means that we can classify some virtual function as mandatory (as is the case for ::add, ::remove and ::foreach) and some other optional.
183 lines
9.5 KiB
C
183 lines
9.5 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, write to the
|
|
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
* Boston, MA 02111-1307, USA.
|
|
*
|
|
* ClutterContainer: Generic actor container interface.
|
|
* Author: Emmanuele Bassi <ebassi@openedhand.com>
|
|
*/
|
|
|
|
#ifndef __CLUTTER_CONTAINER_H__
|
|
#define __CLUTTER_CONTAINER_H__
|
|
|
|
#include <clutter/clutter-actor.h>
|
|
#include <clutter/clutter-child-meta.h>
|
|
#include <clutter/clutter-types.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
#define CLUTTER_TYPE_CONTAINER (clutter_container_get_type ())
|
|
#define CLUTTER_CONTAINER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_CONTAINER, ClutterContainer))
|
|
#define CLUTTER_IS_CONTAINER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_CONTAINER))
|
|
#define CLUTTER_CONTAINER_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), CLUTTER_TYPE_CONTAINER, ClutterContainerIface))
|
|
|
|
typedef struct _ClutterContainerIface ClutterContainerIface;
|
|
|
|
/**
|
|
* ClutterContainerIface:
|
|
* @add: virtual function for adding an actor to the container. The
|
|
* implementation of this virtual function is required.
|
|
* @remove: virtual function for removing an actor from the container. The
|
|
* implementation of this virtual function is required.
|
|
* @foreach: virtual function for iterating over the container's children.
|
|
* The implementation of this virtual function is required.
|
|
* @raise: virtual function for raising a child
|
|
* @lower: virtual function for lowering a child
|
|
* @sort_depth_order: virtual function for sorting the children of a
|
|
* container depending on their depth
|
|
* @child_meta_type: The GType used for storing auxiliary information about
|
|
* each of the containers children.
|
|
* @create_child_meta: virtual function that gets called for each added
|
|
* child, the function should instantiate an object of type
|
|
* #ClutterContainerIface::child_meta_type, set the container and actor
|
|
* fields in the instance and add the record to a data structure for
|
|
* subsequent access for #ClutterContainerIface::get_child_meta
|
|
* @destroy_child_meta: virtual function that gets called when a child is
|
|
* removed; it shuld release all resources held by the record
|
|
* @get_child_meta: return the record for a container child
|
|
* @actor_added: class handler for #ClutterContainer::actor_added
|
|
* @actor_removed: class handler for #ClutterContainer::actor_removed
|
|
* @child_notify: class handler for #ClutterContainer::child-notify
|
|
*
|
|
* Base interface for container actors. The @add, @remove and @foreach
|
|
* virtual functions must be provided by any implementation; the other
|
|
* virtual functions are optional.
|
|
*
|
|
* Since: 0.4
|
|
*/
|
|
struct _ClutterContainerIface
|
|
{
|
|
/*< private >*/
|
|
GTypeInterface g_iface;
|
|
|
|
/*< public >*/
|
|
void (* add) (ClutterContainer *container,
|
|
ClutterActor *actor);
|
|
void (* remove) (ClutterContainer *container,
|
|
ClutterActor *actor);
|
|
void (* foreach) (ClutterContainer *container,
|
|
ClutterCallback callback,
|
|
gpointer user_data);
|
|
|
|
/* child stacking */
|
|
void (* raise) (ClutterContainer *container,
|
|
ClutterActor *actor,
|
|
ClutterActor *sibling);
|
|
void (* lower) (ClutterContainer *container,
|
|
ClutterActor *actor,
|
|
ClutterActor *sibling);
|
|
void (* sort_depth_order) (ClutterContainer *container);
|
|
|
|
/* ClutterChildMeta management */
|
|
GType child_meta_type;
|
|
void (* create_child_meta) (ClutterContainer *container,
|
|
ClutterActor *actor);
|
|
void (* destroy_child_meta) (ClutterContainer *container,
|
|
ClutterActor *actor);
|
|
ClutterChildMeta *(* get_child_meta) (ClutterContainer *container,
|
|
ClutterActor *actor);
|
|
|
|
/* signals */
|
|
void (* actor_added) (ClutterContainer *container,
|
|
ClutterActor *actor);
|
|
void (* actor_removed) (ClutterContainer *container,
|
|
ClutterActor *actor);
|
|
|
|
void (* child_notify) (ClutterContainer *container,
|
|
ClutterActor *actor,
|
|
GParamSpec *pspec);
|
|
};
|
|
|
|
GType clutter_container_get_type (void) G_GNUC_CONST;
|
|
|
|
void clutter_container_add (ClutterContainer *container,
|
|
ClutterActor *first_actor,
|
|
...) G_GNUC_NULL_TERMINATED;
|
|
void clutter_container_add_actor (ClutterContainer *container,
|
|
ClutterActor *actor);
|
|
void clutter_container_add_valist (ClutterContainer *container,
|
|
ClutterActor *first_actor,
|
|
va_list var_args);
|
|
void clutter_container_remove (ClutterContainer *container,
|
|
ClutterActor *first_actor,
|
|
...) G_GNUC_NULL_TERMINATED;
|
|
void clutter_container_remove_actor (ClutterContainer *container,
|
|
ClutterActor *actor);
|
|
void clutter_container_remove_valist (ClutterContainer *container,
|
|
ClutterActor *first_actor,
|
|
va_list var_args);
|
|
GList * clutter_container_get_children (ClutterContainer *container);
|
|
void clutter_container_foreach (ClutterContainer *container,
|
|
ClutterCallback callback,
|
|
gpointer user_data);
|
|
ClutterActor *clutter_container_find_child_by_name (ClutterContainer *container,
|
|
const gchar *child_name);
|
|
void clutter_container_raise_child (ClutterContainer *container,
|
|
ClutterActor *actor,
|
|
ClutterActor *sibling);
|
|
void clutter_container_lower_child (ClutterContainer *container,
|
|
ClutterActor *actor,
|
|
ClutterActor *sibling);
|
|
void clutter_container_sort_depth_order (ClutterContainer *container);
|
|
|
|
|
|
|
|
GParamSpec * clutter_container_class_find_child_property (GObjectClass *klass,
|
|
const gchar *property_name);
|
|
GParamSpec ** clutter_container_class_list_child_properties (GObjectClass *klass,
|
|
guint *n_properties);
|
|
|
|
ClutterChildMeta *clutter_container_get_child_meta (ClutterContainer *container,
|
|
ClutterActor *actor);
|
|
|
|
void clutter_container_child_set_property (ClutterContainer *container,
|
|
ClutterActor *child,
|
|
const gchar * property,
|
|
const GValue *value);
|
|
void clutter_container_child_get_property (ClutterContainer *container,
|
|
ClutterActor *child,
|
|
const gchar *property,
|
|
GValue *value);
|
|
void clutter_container_child_set (ClutterContainer *container,
|
|
ClutterActor *actor,
|
|
const gchar *first_prop,
|
|
...) G_GNUC_NULL_TERMINATED;
|
|
void clutter_container_child_get (ClutterContainer *container,
|
|
ClutterActor *actor,
|
|
const gchar *first_prop,
|
|
...) G_GNUC_NULL_TERMINATED;
|
|
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __CLUTTER_CONTAINER_H__ */
|