aboutsummaryrefslogtreecommitdiffstats
path: root/libgnomecanvas/gnome-canvas-rect.h
blob: fd9946583f68c0e1b9eb7dae0e9b83c8d64e52e1 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/*
 * Copyright (C) 1997, 1998, 1999, 2000 Free Software Foundation
 * All rights reserved.
 *
 * This file is part of the Gnome Library.
 *
 * The Gnome 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.
 *
 * The Gnome 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 the Gnome Library; see the file COPYING.LIB.  If not,
 * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */
/*
  @NOTATION@
 */
/* Rectangle and ellipse item types for GnomeCanvas widget
 *
 * GnomeCanvas is basically a port of the Tk toolkit's most excellent canvas widget.  Tk is
 * copyrighted by the Regents of the University of California, Sun Microsystems, and other parties.
 *
 *
 * Author: Federico Mena <federico@nuclecu.unam.mx>
 */

#ifndef GNOME_CANVAS_RECT_ELLIPSE_H
#define GNOME_CANVAS_RECT_ELLIPSE_H

#include <libgnomecanvas/gnome-canvas.h>

#include <libgnomecanvas/gnome-canvas-shape.h>

G_BEGIN_DECLS

/* Rectangle item.  These are defined by their top-left and bottom-right corners.
 * Rectangles have the following arguments:
 *
 * name         type        read/write  description
 * ------------------------------------------------------------------------------------------
 * x1           gdouble     RW      Leftmost coordinate of rectangle or ellipse
 * y1           gdouble     RW      Topmost coordinate of rectangle or ellipse
 * x2           gdouble     RW      Rightmost coordinate of rectangle or ellipse
 * y2           gdouble     RW      Bottommost coordinate of rectangle or ellipse
 * fill_color       string      W       X color specification for fill color,
 *                          or NULL pointer for no color (transparent)
 * fill_color_gdk   GdkColor*   RW      Allocated GdkColor for fill
 * outline_color    string      W       X color specification for outline color,
 *                          or NULL pointer for no color (transparent)
 * outline_color_gdk    GdkColor*   RW      Allocated GdkColor for outline
 * width_pixels     uint        RW      Width of the outline in pixels.  The outline will
 *                          not be scaled when the canvas zoom factor is changed.
 * width_units      gdouble     RW      Width of the outline in canvas units.  The outline
 *                          will be scaled when the canvas zoom factor is changed.
 */

#define GNOME_TYPE_CANVAS_RECT            (gnome_canvas_rect_get_type ())
#define GNOME_CANVAS_RECT(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GNOME_TYPE_CANVAS_RECT, GnomeCanvasRect))
#define GNOME_CANVAS_RECT_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GNOME_TYPE_CANVAS_RECT, GnomeCanvasRectClass))
#define GNOME_IS_CANVAS_RECT(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GNOME_TYPE_CANVAS_RECT))
#define GNOME_IS_CANVAS_RECT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GNOME_TYPE_CANVAS_RECT))
#define GNOME_CANVAS_RECT_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GNOME_TYPE_CANVAS_RECT, GnomeCanvasRectClass))

typedef struct _GnomeCanvasRect GnomeCanvasRect;
typedef struct _GnomeCanvasRectClass GnomeCanvasRectClass;

struct _GnomeCanvasRect {
    GnomeCanvasShape parent;

       gdouble x1, y1, x2, y2;         /* Corners of item */

       guint path_dirty : 1;
};

struct _GnomeCanvasRectClass {
    GnomeCanvasShapeClass parent_class;
};

/* Standard Gtk function */
GType gnome_canvas_rect_get_type (void) G_GNUC_CONST;

G_END_DECLS

#endif