gtkcellrenderer.c 9.33 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
/* gtkcellrenderer.c
 * Copyright (C) 2000  Red Hat, Inc. Jonathan Blandford
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library 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.
 */

#include "gtkcellrenderer.h"
21
#include "gtkintl.h"
22 23 24

static void gtk_cell_renderer_init       (GtkCellRenderer      *cell);
static void gtk_cell_renderer_class_init (GtkCellRendererClass *class);
25 26 27
static void gtk_cell_renderer_get_property  (GObject              *object,
					     guint                 param_id,
					     GValue               *value,
Tim Janik's avatar
Tim Janik committed
28
					     GParamSpec           *pspec);
29 30 31
static void gtk_cell_renderer_set_property  (GObject              *object,
					     guint                 param_id,
					     const GValue         *value,
Tim Janik's avatar
Tim Janik committed
32
					     GParamSpec           *pspec);
33 34 35 36


enum {
  PROP_ZERO,
37
  PROP_VISIBLE,
38 39 40
  PROP_XALIGN,
  PROP_YALIGN,
  PROP_XPAD,
41
  PROP_YPAD,
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
};


GtkType
gtk_cell_renderer_get_type (void)
{
  static GtkType cell_type = 0;

  if (!cell_type)
    {
      static const GTypeInfo cell_info =
      {
        sizeof (GtkCellRendererClass),
	NULL,		/* base_init */
	NULL,		/* base_finalize */
        (GClassInitFunc) gtk_cell_renderer_class_init,
	NULL,		/* class_finalize */
	NULL,		/* class_data */
        sizeof (GtkCellRenderer),
	0,
        (GInstanceInitFunc) gtk_cell_renderer_init,
      };

65
      cell_type = g_type_register_static (GTK_TYPE_OBJECT, "GtkCellRenderer", &cell_info, 0);
66 67 68 69 70 71 72 73
    }

  return cell_type;
}

static void
gtk_cell_renderer_init (GtkCellRenderer *cell)
{
Havoc Pennington's avatar
Havoc Pennington committed
74 75 76
  /* FIXME remove on port to GtkObject */
  gtk_object_ref (GTK_OBJECT (cell));
  gtk_object_sink (GTK_OBJECT (cell));
77 78

  cell->visible = TRUE;
79 80
  cell->xalign = 0.5;
  cell->yalign = 0.5;
81 82
  cell->xpad = 0;
  cell->ypad = 0;
83 84 85 86 87 88 89
}

static void
gtk_cell_renderer_class_init (GtkCellRendererClass *class)
{
  GObjectClass *object_class = G_OBJECT_CLASS (class);

90 91
  object_class->get_property = gtk_cell_renderer_get_property;
  object_class->set_property = gtk_cell_renderer_set_property;
92 93 94 95

  class->render = NULL;
  class->get_size = NULL;

96 97 98 99 100 101 102 103
  g_object_class_install_property (object_class,
				   PROP_VISIBLE,
				   g_param_spec_boolean ("visible",
							 _("visible"),
							 _("Display the cell"),
							 TRUE,
							 G_PARAM_READABLE |
							 G_PARAM_WRITABLE));
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
  
  g_object_class_install_property (object_class,
				   PROP_XALIGN,
				   g_param_spec_float ("xalign",
						       _("xalign"),
						       _("The x-align."),
						       0.0,
						       1.0,
						       0.0,
						       G_PARAM_READABLE |
						       G_PARAM_WRITABLE));
  
  g_object_class_install_property (object_class,
				   PROP_YALIGN,
				   g_param_spec_float ("yalign",
						       _("yalign"),
						       _("The y-align."),
						       0.0,
						       1.0,
						       0.5,
						       G_PARAM_READABLE |
						       G_PARAM_WRITABLE));
  
  g_object_class_install_property (object_class,
				   PROP_XPAD,
				   g_param_spec_uint ("xpad",
						      _("xpad"),
						      _("The xpad."),
						      0,
						      100,
						      2,
						      G_PARAM_READABLE |
						      G_PARAM_WRITABLE));
  
  g_object_class_install_property (object_class,
				   PROP_YPAD,
				   g_param_spec_uint ("ypad",
						      _("ypad"),
						      _("The ypad."),
						      0,
						      100,
						      2,
						      G_PARAM_READABLE |
						      G_PARAM_WRITABLE));
148 149 150
}

static void
151 152 153
gtk_cell_renderer_get_property (GObject     *object,
				guint        param_id,
				GValue      *value,
Tim Janik's avatar
Tim Janik committed
154
				GParamSpec  *pspec)
155 156 157 158 159
{
  GtkCellRenderer *cell = GTK_CELL_RENDERER (object);

  switch (param_id)
    {
160 161 162
    case PROP_VISIBLE:
      g_value_set_boolean (value, cell->visible);
      break;
163 164 165 166 167 168 169 170 171 172 173 174 175
    case PROP_XALIGN:
      g_value_set_float (value, cell->xalign);
      break;
    case PROP_YALIGN:
      g_value_set_float (value, cell->yalign);
      break;
    case PROP_XPAD:
      g_value_set_float (value, cell->xpad);
      break;
    case PROP_YPAD:
      g_value_set_float (value, cell->ypad);
      break;
    default:
176
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
177 178 179 180 181 182
      break;
    }

}

static void
183 184 185
gtk_cell_renderer_set_property (GObject      *object,
				guint         param_id,
				const GValue *value,
Tim Janik's avatar
Tim Janik committed
186
				GParamSpec   *pspec)
187 188 189 190 191
{
  GtkCellRenderer *cell = GTK_CELL_RENDERER (object);

  switch (param_id)
    {
192 193 194 195
    case PROP_VISIBLE:
      cell->visible = g_value_get_boolean (value);
      g_object_notify (object, "visible");
      break;
196 197
    case PROP_XALIGN:
      cell->xalign = g_value_get_float (value);
198
      g_object_notify (object, "xalign");
199 200 201
      break;
    case PROP_YALIGN:
      cell->yalign = g_value_get_float (value);
202
      g_object_notify (object, "yalign");
203 204 205
      break;
    case PROP_XPAD:
      cell->xpad = g_value_get_int (value);
206
      g_object_notify (object, "xpad");
207 208 209
      break;
    case PROP_YPAD:
      cell->ypad = g_value_get_int (value);
210
      g_object_notify (object, "ypad");
211 212
      break;
    default:
213
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
214 215 216 217
      break;
    }
}

218 219 220 221 222 223 224 225 226 227 228
/**
 * gtk_cell_renderer_get_size:
 * @cell: a #GtkCellRenderer
 * @widget: the widget the renderer is rendering to
 * @width: location to return width needed to render a cell, or %NULL
 * @height: location to return height needed to render a cell, or %NULL
 * 
 * Obtains the width and height needed to render the cell. Used by
 * view widgets to determine the appropriate size for the cell_area
 * passed to gtk_cell_renderer_render().
 **/
229 230 231 232 233 234 235 236 237 238 239 240
void
gtk_cell_renderer_get_size (GtkCellRenderer *cell,
			    GtkWidget *widget,
			    gint      *width,
			    gint      *height)
{
  g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
  g_return_if_fail (GTK_CELL_RENDERER_GET_CLASS (cell)->get_size != NULL);

  GTK_CELL_RENDERER_GET_CLASS (cell)->get_size (cell, widget, width, height);
}

Havoc Pennington's avatar
Havoc Pennington committed
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
/**
 * gtk_cell_renderer_render:
 * @cell: a #GtkCellRenderer
 * @window: a #GdkDrawable to draw to
 * @widget: the widget owning @window
 * @background_area: entire cell area (including tree expanders and maybe padding on the sides)
 * @cell_area: area normally rendered by a cell renderer
 * @expose_area: area that actually needs updating
 * @flags: flags that affect rendering
 *
 * Invokes the virtual render function of the #GtkCellRenderer. The
 * three passed-in rectangles are areas of @window. Most renderers
 * will draw to @cell_area; the xalign, yalign, xpad, and ypad fields
 * of the #GtkCellRenderer should be honored with respect to
 * @cell_area. @background_area includes the blank space around the
 * cell, and also the area containing the tree expander; so the
 * @background_area rectangles for all cells tile to cover the entire
 * @window. Cell renderers can use the @background_area to draw custom expanders, for
 * example. @expose_area is a clip rectangle.
 * 
 **/
262
void
Havoc Pennington's avatar
Havoc Pennington committed
263 264 265 266 267 268 269
gtk_cell_renderer_render (GtkCellRenderer     *cell,
			  GdkWindow           *window,
			  GtkWidget           *widget,
			  GdkRectangle        *background_area,
			  GdkRectangle        *cell_area,
			  GdkRectangle        *expose_area,
			  GtkCellRendererState flags)
270 271
{
  /* It's actually okay to pass in a NULL cell, as we run into that
272 273
   * a lot
   */
274 275 276 277 278 279 280 281 282 283 284 285 286 287
  if (cell == NULL)
    return;
  g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
  g_return_if_fail (GTK_CELL_RENDERER_GET_CLASS (cell)->render != NULL);

  GTK_CELL_RENDERER_GET_CLASS (cell)->render (cell,
					      window,
					      widget,
					      background_area,
					      cell_area,
					      expose_area,
					      flags);
}

288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
/**
 * gtk_cell_renderer_event:
 * @cell: a #GtkCellRenderer
 * @event: a #GdkEvent
 * @widget: widget that received the event
 * @path: widget-dependent string representation of the event location; e.g. for #GtkTreeView, a string representation of #GtkTreePath
 * @background_area: background area as passed to gtk_cell_renderer_render()
 * @cell_area: cell area as passed to gtk_cell_renderer_render()
 * @flags: render flags
 * 
 * Passes an event to the cell renderer for possible processing.  Some
 * cell renderers may use events; for example, #GtkCellRendererToggle
 * toggles when it gets a mouse click.
 * 
 * Return value: %TRUE if the event was consumed/handled
 **/
304
gint
Havoc Pennington's avatar
Havoc Pennington committed
305 306 307 308 309 310 311
gtk_cell_renderer_event (GtkCellRenderer     *cell,
			 GdkEvent            *event,
			 GtkWidget           *widget,
			 gchar               *path,
			 GdkRectangle        *background_area,
			 GdkRectangle        *cell_area,
			 GtkCellRendererState flags)
312 313
{
  /* It's actually okay to pass in a NULL cell, as we run into that
314 315
   * a lot
   */
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
  if (cell == NULL)
    return FALSE;
  g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell), FALSE);
  if (GTK_CELL_RENDERER_GET_CLASS (cell)->event == NULL)
    return FALSE;

  return GTK_CELL_RENDERER_GET_CLASS (cell)->event (cell,
						    event,
						    widget,
						    path,
						    background_area,
						    cell_area,
						    flags);
}