/* GIMP - The GNU Image Manipulation Program
 * Copyright (C) 1995 Spencer Kimball and Peter Mattis
 *
 * gimpcanvasitem.h
 * Copyright (C) 2010 Michael Natterer <mitch@gimp.org>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __GIMP_CANVAS_ITEM_H__
#define __GIMP_CANVAS_ITEM_H__


#include "core/gimpobject.h"


#define GIMP_TYPE_CANVAS_ITEM            (gimp_canvas_item_get_type ())
#define GIMP_CANVAS_ITEM(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GIMP_TYPE_CANVAS_ITEM, GimpCanvasItem))
#define GIMP_CANVAS_ITEM_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GIMP_TYPE_CANVAS_ITEM, GimpCanvasItemClass))
#define GIMP_IS_CANVAS_ITEM(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GIMP_TYPE_CANVAS_ITEM))
#define GIMP_IS_CANVAS_ITEM_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_CANVAS_ITEM))
#define GIMP_CANVAS_ITEM_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GIMP_TYPE_CANVAS_ITEM, GimpCanvasItemClass))


typedef struct _GimpCanvasItemClass GimpCanvasItemClass;

struct _GimpCanvasItem
{
  GimpObject       parent_instance;
};

struct _GimpCanvasItemClass
{
  GimpObjectClass  parent_class;

  void        (* draw)        (GimpCanvasItem   *item,
                               GimpDisplayShell *shell,
                               cairo_t          *cr);
  GdkRegion * (* get_extents) (GimpCanvasItem   *item,
                               GimpDisplayShell *shell);

  void        (* stroke)      (GimpCanvasItem   *item,
                               GimpDisplayShell *shell,
                               cairo_t          *cr);
  void        (* fill)        (GimpCanvasItem   *item,
                               GimpDisplayShell *shell,
                               cairo_t          *cr);
};


GType       gimp_canvas_item_get_type         (void) G_GNUC_CONST;

void        gimp_canvas_item_draw             (GimpCanvasItem   *item,
                                               cairo_t          *cr);
GdkRegion * gimp_canvas_item_get_extents      (GimpCanvasItem   *item);

void        gimp_canvas_item_set_line_cap     (GimpCanvasItem   *item,
                                               cairo_line_cap_t  line_cap);

void        gimp_canvas_item_set_highlight    (GimpCanvasItem   *item,
                                               gboolean          highlight);
gboolean    gimp_canvas_item_get_highlight    (GimpCanvasItem   *item);

void        gimp_canvas_item_suspend_stroking (GimpCanvasItem   *item);
void        gimp_canvas_item_resume_stroking  (GimpCanvasItem   *item);

void        gimp_canvas_item_suspend_filling  (GimpCanvasItem   *item);
void        gimp_canvas_item_resume_filling   (GimpCanvasItem   *item);


/*  protected  */

void        _gimp_canvas_item_stroke          (GimpCanvasItem   *item,
                                               cairo_t          *cr);
void        _gimp_canvas_item_fill            (GimpCanvasItem   *item,
                                               cairo_t          *cr);


#endif /* __GIMP_CANVAS_ITEM_H__ */