1 /*
2  * This is a plug-in for GIMP.
3  *
4  * Generates clickable image maps.
5  *
6  * Copyright (C) 1998-2005 Maurits Rijk  m.rijk@chello.nl
7  *
8  * This program is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
20  *
21  */
22 
23 #ifndef _IMAP_OBJECT_H
24 #define _IMAP_OBJECT_H
25 
26 typedef struct Object_t Object_t;
27 typedef struct ObjectClass_t ObjectClass_t;
28 typedef struct ObjectList_t ObjectList_t;
29 
30 #include "imap_edit_area_info.h"
31 #include "imap_menu_funcs.h"
32 
33 struct Object_t {
34    ObjectClass_t        *class;
35    ObjectList_t         *list;
36    gint                  refcount;
37    gboolean              selected;
38    gboolean              locked;
39    gchar                *url;
40    gchar                *target;
41    gchar                *comment;
42    gchar                *mouse_over;
43    gchar                *mouse_out;
44    gchar                *focus;
45    gchar                *blur;
46 };
47 
48 typedef void (*MoveSashFunc_t)(Object_t*, gint, gint);
49 typedef void (*OutputFunc_t)(gpointer, const char*, ...) G_GNUC_PRINTF(2,3);
50 
51 struct AreaInfoDialog_t;
52 
53 struct ObjectClass_t {
54    const gchar          *name;
55    AreaInfoDialog_t     *info_dialog;
56 
57    gboolean (*is_valid)(Object_t *obj);
58    void (*destruct)(Object_t *obj);
59    Object_t* (*clone)(Object_t *obj);
60    void (*assign)(Object_t *obj, Object_t *des);
61    void (*normalize)(Object_t *obj);
62    void (*draw)(Object_t *obj, cairo_t *cr);
63    void (*draw_sashes)(Object_t *obj, cairo_t *cr);
64    MoveSashFunc_t (*near_sash)(Object_t *obj, gint x, gint y);
65    gboolean (*point_is_on)(Object_t *obj, gint x, gint y);
66    void (*get_dimensions)(Object_t *obj, gint *x, gint *y, gint *width,
67                           gint *height);
68    void (*resize)(Object_t *obj, gint percentage_x, gint percentage_y);
69    void (*move)(Object_t *obj, gint dx, gint dy);
70    gpointer (*create_info_widget)(GtkWidget *frame);
71    void (*update_info_widget)(Object_t *obj, gpointer data);
72    void (*fill_info_tab)(Object_t *obj, gpointer data);
73    void (*set_initial_focus)(Object_t *obj, gpointer data);
74    void (*update)(Object_t *obj, gpointer data);
75    void (*write_csim)(Object_t *obj, gpointer param, OutputFunc_t output);
76    void (*write_cern)(Object_t *obj, gpointer param, OutputFunc_t output);
77    void (*write_ncsa)(Object_t *obj, gpointer param, OutputFunc_t output);
78    void (*do_popup)(Object_t *obj, GdkEventButton *event);
79 
80    const gchar* (*get_stock_icon_name)(void);
81 };
82 
83 Object_t *object_ref(Object_t *obj);
84 void object_unref(Object_t *obj);
85 Object_t* object_init(Object_t *obj, ObjectClass_t *class);
86 Object_t* object_clone(Object_t *obj);
87 Object_t* object_assign(Object_t *src, Object_t *des);
88 void object_draw(Object_t *obj, cairo_t *cr);
89 void object_edit(Object_t *obj, gboolean add);
90 void object_select(Object_t *obj);
91 void object_unselect(Object_t *obj);
92 void object_move(Object_t *obj, gint dx, gint dy);
93 void object_move_sash(Object_t *obj, gint dx, gint dy);
94 void object_remove(Object_t *obj);
95 void object_lock(Object_t *obj);
96 void object_unlock(Object_t *obj);
97 void object_set_url(Object_t *obj, const gchar *url);
98 void object_set_target(Object_t *obj, const gchar *target);
99 void object_set_comment(Object_t *obj, const gchar *comment);
100 void object_set_mouse_over(Object_t *obj, const gchar *mouse_over);
101 void object_set_mouse_out(Object_t *obj, const gchar *mouse_out);
102 void object_set_focus(Object_t *obj, const gchar *focus);
103 void object_set_blur(Object_t *obj, const gchar *blur);
104 gint object_get_position_in_list(Object_t *obj);
105 
106 void object_emit_changed_signal(Object_t *obj);
107 void object_emit_geometry_signal(Object_t *obj);
108 void object_emit_update_signal(Object_t *obj);
109 
110 #define object_is_valid(obj) \
111         ((obj)->class->is_valid(obj))
112 
113 #define object_get_dimensions(obj, x, y, width, height) \
114         ((obj)->class->get_dimensions((obj), (x), (y), (width), (height)))
115 
116 #define object_normalize(obj) \
117         ((obj)->class->normalize(obj))
118 
119 #define object_resize(obj, per_x, per_y) \
120         ((obj)->class->resize((obj), (per_x), (per_y)))
121 
122 #define object_update(obj, data) \
123         ((obj)->class->update((obj), (data)))
124 
125 #define object_update_info_widget(obj, data) \
126         ((obj)->class->update_info_widget((obj), (data)))
127 
128 #define object_fill_info_tab(obj, data) \
129         ((obj)->class->fill_info_tab((obj), (data)))
130 
131 #define object_get_stock_icon_name(obj) \
132         ((obj)->class->get_stock_icon_name())
133 
134 typedef struct {
135    Object_t *obj;
136    gboolean (*finish)(Object_t *obj, gint x, gint y);
137    gboolean (*cancel)(GdkEventButton *event, Object_t *obj);
138    Object_t* (*create_object)(gint x, gint y);
139    void (*set_xy)(Object_t *obj, guint state, gint x, gint y);
140 } ObjectFactory_t;
141 
142 gboolean object_on_button_press(GtkWidget *widget, GdkEventButton *event,
143                                 gpointer data);
144 
145 typedef struct {
146    GList *list;
147 } ObjectListCallback_t;
148 
149 struct ObjectList_t {
150    GList *list;
151    gboolean changed;
152    ObjectListCallback_t changed_cb;
153    ObjectListCallback_t update_cb;
154    ObjectListCallback_t add_cb;
155    ObjectListCallback_t remove_cb;
156    ObjectListCallback_t select_cb;
157    ObjectListCallback_t move_cb;
158    ObjectListCallback_t geometry_cb;
159 };
160 
161 ObjectList_t *make_object_list (void);
162 void object_list_destruct(ObjectList_t *list);
163 ObjectList_t *object_list_copy(ObjectList_t *des, ObjectList_t *src);
164 ObjectList_t *object_list_append_list(ObjectList_t *des, ObjectList_t *src);
165 
166 void object_list_append(ObjectList_t *list, Object_t *object);
167 void object_list_prepend(ObjectList_t *list, Object_t *object);
168 void object_list_insert(ObjectList_t *list, gint position, Object_t *object);
169 void object_list_remove(ObjectList_t *list, Object_t *object);
170 void object_list_remove_link(ObjectList_t *list, GList *link);
171 void object_list_update(ObjectList_t *list, Object_t *object);
172 void object_list_draw(ObjectList_t *list, cairo_t *cr);
173 void object_list_draw_selected(ObjectList_t *list, cairo_t *cr);
174 Object_t *object_list_find(ObjectList_t *list, gint x, gint y);
175 Object_t *object_list_near_sash(ObjectList_t *list, gint x, gint y,
176                                 MoveSashFunc_t *sash_func);
177 
178 gint object_list_cut(ObjectList_t *list);
179 void object_list_copy_to_paste_buffer(ObjectList_t *list);
180 void object_list_paste(ObjectList_t *list);
181 
182 void object_list_remove_all(ObjectList_t *list);
183 void object_list_delete_selected(ObjectList_t *list);
184 void object_list_edit_selected(ObjectList_t *list);
185 gint object_list_select_all(ObjectList_t *list);
186 void object_list_select_next(ObjectList_t *list);
187 void object_list_select_prev(ObjectList_t *list);
188 gint object_list_select_region(ObjectList_t *list, gint x, gint y, gint width,
189                                gint height);
190 gint object_list_deselect_all(ObjectList_t *list, Object_t *exception);
191 gint object_list_nr_selected(ObjectList_t *list);
192 void object_list_resize(ObjectList_t *list, gint percentage_x,
193                         gint percentage_y);
194 void object_list_move_selected(ObjectList_t *list, gint dx, gint dy);
195 void object_list_move_up(ObjectList_t *list, Object_t *obj);
196 void object_list_move_down(ObjectList_t *list, Object_t *obj);
197 void object_list_move_selected_up(ObjectList_t *list);
198 void object_list_move_selected_down(ObjectList_t *list);
199 void object_list_move_to_front(ObjectList_t *list);
200 void object_list_send_to_back(ObjectList_t *list);
201 void object_list_move_sash_selected(ObjectList_t *list, gint dx, gint dy);
202 
203 void object_list_write_csim(ObjectList_t *list, gpointer param,
204                             OutputFunc_t output);
205 void object_list_write_cern(ObjectList_t *list, gpointer param,
206                             OutputFunc_t output);
207 void object_list_write_ncsa(ObjectList_t *list, gpointer param,
208                             OutputFunc_t output);
209 
210 typedef void (*ObjectListCallbackFunc_t)(Object_t*, gpointer);
211 
212 gpointer object_list_add_changed_cb(ObjectList_t *list,
213                                     ObjectListCallbackFunc_t func,
214                                     gpointer data);
215 gpointer object_list_add_update_cb(ObjectList_t *list,
216                                    ObjectListCallbackFunc_t func,
217                                    gpointer data);
218 gpointer object_list_add_add_cb(ObjectList_t *list,
219                                 ObjectListCallbackFunc_t func, gpointer data);
220 gpointer object_list_add_remove_cb(ObjectList_t *list,
221                                    ObjectListCallbackFunc_t func,
222                                    gpointer data);
223 gpointer object_list_add_select_cb(ObjectList_t *list,
224                                    ObjectListCallbackFunc_t func,
225                                    gpointer data);
226 gpointer object_list_add_move_cb(ObjectList_t *list,
227                                  ObjectListCallbackFunc_t func, gpointer data);
228 gpointer object_list_add_geometry_cb(ObjectList_t *list,
229                                      ObjectListCallbackFunc_t func,
230                                      gpointer data);
231 
232 void object_list_remove_add_cb(ObjectList_t *list, gpointer id);
233 void object_list_remove_select_cb(ObjectList_t *list, gpointer id);
234 void object_list_remove_remove_cb(ObjectList_t *list, gpointer id);
235 void object_list_remove_move_cb(ObjectList_t *list, gpointer id);
236 void object_list_remove_geometry_cb(ObjectList_t *list, gpointer id);
237 
238 #define object_list_clear_changed(list) ((list)->changed = FALSE)
239 #define object_list_set_changed(list, ischanged) \
240         ((list)->changed = (ischanged))
241 #define object_list_get_changed(list) ((list)->changed)
242 
243 void clear_paste_buffer(void);
244 gpointer paste_buffer_add_add_cb(ObjectListCallbackFunc_t func, gpointer data);
245 gpointer paste_buffer_add_remove_cb(ObjectListCallbackFunc_t func,
246                                     gpointer data);
247 ObjectList_t *get_paste_buffer(void);
248 
249 void do_object_locked_dialog(void);
250 
251 #endif /* _IMAP_OBJECT_H */
252 
253 
254