clutter/clutter-content.h

   1 /*
   2  * Clutter.
   3  *
   4  * An OpenGL based 'interactive canvas' library.
   5  *
   6  * Copyright (C) 2012  Intel Corporation.
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  20  *
  21  * Author:
  22  *   Emmanuele Bassi <ebassi@linux.intel.com>
  23  */
  24
  25 #if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
  26 #error "Only <clutter/clutter.h> can be included directly."
  27 #endif
  28
  29 #ifndef __CLUTTER_CONTENT_H__
  30 #define __CLUTTER_CONTENT_H__
  31
  32 #include <clutter/clutter-types.h>
  33
  34 G_BEGIN_DECLS
  35
  36 #define CLUTTER_TYPE_CONTENT            (clutter_content_get_type ())
  37 #define CLUTTER_CONTENT(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_CONTENT, ClutterContent))
  38 #define CLUTTER_IS_CONTENT(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_CONTENT))
  39 #define CLUTTER_CONTENT_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), CLUTTER_TYPE_CONTENT, ClutterContentIface))
  40
  41 typedef struct _ClutterContentIface     ClutterContentIface;
  42
  43 /**
  44  * ClutterContent:
  45  *
  46  * The <structname>ClutterContent</structname> structure is an opaque type
  47  * whose members cannot be acccessed directly.
  48  *
  49  * Since: 1.10
  50  */
  51
  52 /**
  53  * ClutterContentIface:
  54  * @get_preferred_size: virtual function; should be overridden by subclasses
  55  *   of #ClutterContent that have a natural size
  56  * @paint_content: virtual function; called each time the content needs to
  57  *   paint itself
  58  * @attached: virtual function; called each time a #ClutterContent is attached
  59  *   to a #ClutterActor.
  60  * @detached: virtual function; called each time a #ClutterContent is detached
  61  *   from a #ClutterActor.
  62  * @invalidate: virtual function; called each time a #ClutterContent state
  63  *   is changed.
  64  *
  65  * The <structname>ClutterContentIface</structname> structure contains only
  66  * private data.
  67  *
  68  * Since: 1.10
  69  */
  70 struct _ClutterContentIface
  71 {
  72   /*< private >*/
  73   GTypeInterface g_iface;
  74
  75   /*< public >*/
  76   gboolean      (* get_preferred_size)  (ClutterContent   *content,
  77                                          gfloat           *width,
  78                                          gfloat           *height);
  79   void          (* paint_content)       (ClutterContent   *content,
  80                                          ClutterActor     *actor,
  81                                          ClutterPaintNode *node);
  82
  83   void          (* attached)            (ClutterContent   *content,
  84                                          ClutterActor     *actor);
  85   void          (* detached)            (ClutterContent   *content,
  86                                          ClutterActor     *actor);
  87
  88   void          (* invalidate)          (ClutterContent   *content);
  89 };
  90
  91 CLUTTER_AVAILABLE_IN_1_10
  92 GType clutter_content_get_type (void) G_GNUC_CONST;
  93
  94 CLUTTER_AVAILABLE_IN_1_10
  95 gboolean        clutter_content_get_preferred_size      (ClutterContent *content,
  96                                                          gfloat         *width,
  97                                                          gfloat         *height);
  98 CLUTTER_AVAILABLE_IN_1_10
  99 void            clutter_content_invalidate              (ClutterContent *content);
 100
 101 G_END_DECLS
 102
 103 #endif /* __CLUTTER_CONTENT_H__ */