ADG: corrected g-ir-scanner warnings where possible
[adg.git] / src / adg / adg-entity.h
blobb6b3120e26f2c36bf0110c04dd6efe30532972cd
1 /* ADG - Automatic Drawing Generation
2 * Copyright (C) 2007,2008,2009,2010,2011 Nicola Fontana <ntd at entidi.it>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library 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 GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17 * Boston, MA 02110-1301, USA.
21 #if !defined(__ADG_H__)
22 #error "Only <adg.h> can be included directly."
23 #endif
26 #ifndef __ADG_ENTITY_H__
27 #define __ADG_ENTITY_H__
30 G_BEGIN_DECLS
32 #define ADG_TYPE_ENTITY (adg_entity_get_type())
33 #define ADG_ENTITY(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), ADG_TYPE_ENTITY, AdgEntity))
34 #define ADG_ENTITY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), ADG_TYPE_ENTITY, AdgEntityClass))
35 #define ADG_IS_ENTITY(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), ADG_TYPE_ENTITY))
36 #define ADG_IS_ENTITY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), ADG_TYPE_ENTITY))
37 #define ADG_ENTITY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), ADG_TYPE_ENTITY, AdgEntityClass))
40 /* Forward declarations */
41 ADG_FORWARD_DECL(AdgCanvas);
42 ADG_FORWARD_DECL(AdgStyle);
43 ADG_FORWARD_DECL(AdgPoint);
45 #ifdef __GI_SCANNER__
46 ADG_FORWARD_DECL(AdgDress);
47 #else
48 typedef gint AdgDress;
49 #endif
52 typedef struct _AdgEntity AdgEntity;
53 typedef struct _AdgEntityClass AdgEntityClass;
56 struct _AdgEntity {
57 /*< private >*/
58 GInitiallyUnowned parent;
59 gpointer data;
62 struct _AdgEntityClass {
63 /*< private >*/
64 GInitiallyUnownedClass parent_class;
65 /*< public >*/
66 /* Signals */
67 void (*parent_set) (AdgEntity *entity,
68 AdgEntity *old_parent);
69 void (*global_changed) (AdgEntity *entity);
70 void (*local_changed) (AdgEntity *entity);
71 void (*invalidate) (AdgEntity *entity);
72 void (*arrange) (AdgEntity *entity);
73 void (*render) (AdgEntity *entity,
74 cairo_t *cr);
78 void adg_switch_extents (gboolean state);
80 GType adg_entity_get_type (void) G_GNUC_CONST;
81 AdgCanvas * adg_entity_get_canvas (AdgEntity *entity);
82 void adg_entity_set_parent (AdgEntity *entity,
83 AdgEntity *parent);
84 AdgEntity * adg_entity_get_parent (AdgEntity *entity);
85 void adg_entity_set_global_map (AdgEntity *entity,
86 const AdgMatrix *map);
87 void adg_entity_transform_global_map(AdgEntity *entity,
88 const AdgMatrix *transformation,
89 AdgTransformMode mode);
90 const AdgMatrix *adg_entity_get_global_map (AdgEntity *entity);
91 const AdgMatrix *adg_entity_get_global_matrix (AdgEntity *entity);
92 void adg_entity_set_local_map (AdgEntity *entity,
93 const AdgMatrix *map);
94 void adg_entity_transform_local_map (AdgEntity *entity,
95 const AdgMatrix *transformation,
96 AdgTransformMode mode);
97 const AdgMatrix *adg_entity_get_local_map (AdgEntity *entity);
98 const AdgMatrix *adg_entity_get_local_matrix (AdgEntity *entity);
99 void adg_entity_set_local_method (AdgEntity *entity,
100 AdgMixMethod local_method);
101 AdgMixMethod adg_entity_get_local_method (AdgEntity *entity);
102 void adg_entity_set_extents (AdgEntity *entity,
103 const CpmlExtents *extents);
104 const CpmlExtents *
105 adg_entity_get_extents (AdgEntity *entity);
106 void adg_entity_set_style (AdgEntity *entity,
107 AdgDress dress,
108 AdgStyle *style);
109 AdgStyle * adg_entity_get_style (AdgEntity *entity,
110 AdgDress dress);
111 AdgStyle * adg_entity_style (AdgEntity *entity,
112 AdgDress dress);
113 void adg_entity_apply_dress (AdgEntity *entity,
114 AdgDress dress,
115 cairo_t *cr);
116 void adg_entity_global_changed (AdgEntity *entity);
117 void adg_entity_local_changed (AdgEntity *entity);
118 void adg_entity_invalidate (AdgEntity *entity);
119 void adg_entity_arrange (AdgEntity *entity);
120 void adg_entity_render (AdgEntity *entity,
121 cairo_t *cr);
122 AdgPoint * adg_entity_point (AdgEntity *entity,
123 AdgPoint *point,
124 AdgPoint *new_point);
126 G_END_DECLS
129 #endif /* __ADG_ENTITY_H__ */