Pileus Git - grits/blob - src/objects/grits-callback.c

   1 /*
   2  * Copyright (C) 2009-2011 Andy Spencer <andy753421@gmail.com>
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 /**
  19  * SECTION:grits-callback
  20  * @short_description: Custom callback objects
  21  *
  22  * #GritsCallback objects are used for custom drawing functions. A common example
  23  * of this would be to render something which does not easily fit into a normal
  24  * object. For instance, a Heads-Up-Display overlay.
  25  *
  26  * Callbacks are an alternate to extending GritsObject with a new class and
  27  * should be used when only once instance of the object will be needed.
  28  */
  29
  30 #include <config.h>
  31 #include "grits-callback.h"
  32
  33 /**
  34  * grits_callback_new:
  35  * @callback:  the function to call to draw the object
  36  * @user_data: user data to pass to the drawing function
  37  *
  38  * Create a #GritsCallback object with an associated function and user data.
  39  *
  40  * Returns: the new #GritsCallback
  41  */
  42 GritsCallback *grits_callback_new(GritsCallbackFunc draw_cb, gpointer user_data)
  43 {
  44         GritsCallback *cb = g_object_new(GRITS_TYPE_CALLBACK, NULL);
  45         cb->draw      = draw_cb;
  46         cb->user_data = user_data;
  47         return cb;
  48 }
  49
  50 /* Proxy class methods to per-object methods */
  51 static void proxy_draw(GritsObject *_cb, GritsOpenGL *opengl)
  52 {
  53         GritsCallback *cb = GRITS_CALLBACK(_cb);
  54         if (cb->draw)
  55                 cb->draw(cb, opengl, cb->user_data);
  56 }
  57
  58 /* GritsCallback */
  59 G_DEFINE_TYPE(GritsCallback, grits_callback, GRITS_TYPE_OBJECT);
  60 static void grits_callback_finalize(GObject *cb)
  61 {
  62         g_debug("GritsCallback: finalize");
  63 }
  64 static void grits_callback_init(GritsCallback *cb)
  65 {
  66         g_debug("GritsCallback: init");
  67 }
  68
  69 static void grits_callback_class_init(GritsCallbackClass *klass)
  70 {
  71         GritsObjectClass *grits_class  = GRITS_OBJECT_CLASS(klass);
  72         GObjectClass     *object_class = G_OBJECT_CLASS(klass);
  73         grits_class->draw      = proxy_draw;
  74         object_class->finalize = grits_callback_finalize;
  75 }