gtkdrawingarea.h 4.35 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Elliot Lee's avatar
Elliot Lee committed
2
3
4
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6
7
8
9
10
11
 * 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
12
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
Javier Jardón's avatar
Javier Jardón committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
Elliot Lee's avatar
Elliot Lee committed
16
 */
17
18

/*
19
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
20
21
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
22
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
23
24
 */

Elliot Lee's avatar
Elliot Lee committed
25
26
27
28
#ifndef __GTK_DRAWING_AREA_H__
#define __GTK_DRAWING_AREA_H__


29
30
31
32
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif

Elliot Lee's avatar
Elliot Lee committed
33
34
35
#include <gtk/gtkwidget.h>


36
G_BEGIN_DECLS
Elliot Lee's avatar
Elliot Lee committed
37

38
#define GTK_TYPE_DRAWING_AREA            (gtk_drawing_area_get_type ())
Manish Singh's avatar
Manish Singh committed
39
40
41
42
43
#define GTK_DRAWING_AREA(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_DRAWING_AREA, GtkDrawingArea))
#define GTK_DRAWING_AREA_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_DRAWING_AREA, GtkDrawingAreaClass))
#define GTK_IS_DRAWING_AREA(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_DRAWING_AREA))
#define GTK_IS_DRAWING_AREA_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_DRAWING_AREA))
#define GTK_DRAWING_AREA_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_DRAWING_AREA, GtkDrawingAreaClass))
Elliot Lee's avatar
Elliot Lee committed
44
45
46
47

typedef struct _GtkDrawingArea       GtkDrawingArea;
typedef struct _GtkDrawingAreaClass  GtkDrawingAreaClass;

48
49
/**
 * GtkDrawingAreaDrawFunc:
Matthias Clasen's avatar
Matthias Clasen committed
50
 * @drawing_area: the `GtkDrawingArea` to redraw
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 * @cr: the context to draw to
 * @width: the actual width of the contents. This value will be at least
 *   as wide as GtkDrawingArea:width.
 * @height: the actual height of the contents. This value will be at least
 *   as wide as GtkDrawingArea:height.
 * @user_data: (closure): user data
 *
 * Whenever @drawing_area needs to redraw, this function will be called.
 *
 * This function should exclusively redraw the contents of the drawing area
 * and must not call any widget functions that cause changes.
 */
typedef void (* GtkDrawingAreaDrawFunc)  (GtkDrawingArea *drawing_area,
                                          cairo_t        *cr,
                                          int             width,
                                          int             height,
                                          gpointer        user_data);

Elliot Lee's avatar
Elliot Lee committed
69
70
71
72
73
74
75
76
struct _GtkDrawingArea
{
  GtkWidget widget;
};

struct _GtkDrawingAreaClass
{
  GtkWidgetClass parent_class;
77

78
79
80
81
  void           (* resize)         (GtkDrawingArea *area,
                                     int             width,
                                     int             height);

Matthias Clasen's avatar
Matthias Clasen committed
82
83
84
  /*< private >*/

  gpointer padding[8];
Elliot Lee's avatar
Elliot Lee committed
85
86
87
};


88
GDK_AVAILABLE_IN_ALL
89
GType      gtk_drawing_area_get_type (void) G_GNUC_CONST;
90
GDK_AVAILABLE_IN_ALL
91
GtkWidget* gtk_drawing_area_new      (void);
92

Matthias Clasen's avatar
Matthias Clasen committed
93
GDK_AVAILABLE_IN_ALL
94
95
void            gtk_drawing_area_set_content_width      (GtkDrawingArea         *self,
                                                         int                     width);
Matthias Clasen's avatar
Matthias Clasen committed
96
GDK_AVAILABLE_IN_ALL
97
int             gtk_drawing_area_get_content_width      (GtkDrawingArea         *self);
Matthias Clasen's avatar
Matthias Clasen committed
98
GDK_AVAILABLE_IN_ALL
99
100
void            gtk_drawing_area_set_content_height     (GtkDrawingArea         *self,
                                                         int                     height);
Matthias Clasen's avatar
Matthias Clasen committed
101
GDK_AVAILABLE_IN_ALL
102
int             gtk_drawing_area_get_content_height     (GtkDrawingArea         *self);
Matthias Clasen's avatar
Matthias Clasen committed
103
GDK_AVAILABLE_IN_ALL
104
105
106
107
void            gtk_drawing_area_set_draw_func          (GtkDrawingArea         *self,
                                                         GtkDrawingAreaDrawFunc  draw_func,
                                                         gpointer                user_data,
                                                         GDestroyNotify          destroy);
108

109
G_END_DECLS
Elliot Lee's avatar
Elliot Lee committed
110
111

#endif /* __GTK_DRAWING_AREA_H__ */