set user-defined color as image background - patch by Laurent MONIN
[geeqie.git] / src / image.h
1 /*
2  * Geeqie
3  * (C) 2004 John Ellis
4  *
5  * Author: John Ellis
6  *
7  * This software is released under the GNU General Public License (GNU GPL).
8  * Please read the included file COPYING for more information.
9  * This software comes with no warranty of any kind, use at your own risk!
10  */
11
12
13 #ifndef IMAGE_H
14 #define IMAGE_H
15
16
17 ImageWindow *image_new(gint frame);
18
19 /* additional setup */
20 void image_attach_window(ImageWindow *imd, GtkWidget *window,
21                          const gchar *title, const gchar *title_right, gint show_zoom);
22 void image_set_update_func(ImageWindow *imd,
23                            void (*func)(ImageWindow *imd, gpointer data),
24                            gpointer data);
25 void image_set_button_func(ImageWindow *imd,
26         void (*func)(ImageWindow *, gint button, guint32 time, gdouble x, gdouble y, guint state, gpointer),
27         gpointer data);
28 void image_set_drag_func(ImageWindow *imd,
29         void (*func)(ImageWindow *, gint button, guint32 time, gdouble x, gdouble y, guint state, gdouble dx, gdouble dy, gpointer),
30         gpointer data);
31 void image_set_scroll_func(ImageWindow *imd,
32         void (*func)(ImageWindow *, GdkScrollDirection direction, guint32 time, gdouble x, gdouble y, guint state, gpointer),
33         gpointer data);
34 void image_set_scroll_notify_func(ImageWindow *imd,
35                                   void (*func)(ImageWindow *imd, gint x, gint y, gint width, gint height, gpointer data),
36                                   gpointer data);
37 void image_set_complete_func(ImageWindow *imd,
38                              void (*func)(ImageWindow *imd, gint preload, gpointer data),
39                              gpointer data);
40 void image_set_state_func(ImageWindow *imd,
41                           void (*func)(ImageWindow *imd, ImageState state, gpointer data),
42                           gpointer data);
43
44 void image_select(ImageWindow *imd, gboolean select);
45 void image_set_selectable(ImageWindow *imd, gboolean selectable);
46
47 /* path, name */
48 const gchar *image_get_path(ImageWindow *imd);
49 const gchar *image_get_name(ImageWindow *imd);
50 FileData *image_get_fd(ImageWindow *imd);
51
52 /* merely changes path string, does not change the image! */
53 void image_set_fd(ImageWindow *imd, FileData *fd);
54
55 /* load a new image */
56 void image_change_fd(ImageWindow *imd, FileData *fd, gdouble zoom);
57 void image_change_pixbuf(ImageWindow *imd, GdkPixbuf *pixbuf, gdouble zoom);
58 void image_change_from_collection(ImageWindow *imd, CollectionData *cd, CollectInfo *info, gdouble zoom);
59 CollectionData *image_get_collection(ImageWindow *imd, CollectInfo **info);
60 void image_change_from_image(ImageWindow *imd, ImageWindow *source);
61
62 GdkPixbuf *image_get_pixbuf(ImageWindow *imd);
63
64 /* manipulation */
65 void image_area_changed(ImageWindow *imd, gint x, gint y, gint width, gint height);
66 void image_reload(ImageWindow *imd);
67 void image_scroll(ImageWindow *imd, gint x, gint y);
68 void image_scroll_to_point(ImageWindow *imd, gint x, gint y,
69                            gdouble x_align, gdouble y_align);
70 void image_get_scroll_center(ImageWindow *imd, gdouble *x, gdouble *y);
71 void image_set_scroll_center(ImageWindow *imd, gdouble x, gdouble y);
72 void image_alter(ImageWindow *imd, AlterType type);
73
74 /* zoom */
75 void image_zoom_adjust(ImageWindow *imd, gdouble increment);
76 void image_zoom_adjust_at_point(ImageWindow *imd, gdouble increment, gint x, gint y);
77 void image_zoom_set_limits(ImageWindow *imd, gdouble min, gdouble max);
78 void image_zoom_set(ImageWindow *imd, gdouble zoom);
79 void image_zoom_set_fill_geometry(ImageWindow *imd, gint vertical);
80 gdouble image_zoom_get(ImageWindow *imd);
81 gdouble image_zoom_get_real(ImageWindow *imd);
82 gchar *image_zoom_get_as_text(ImageWindow *imd);
83 gdouble image_zoom_get_default(ImageWindow *imd, gint mode);
84
85 /* read ahead, pass NULL to cancel */
86 void image_prebuffer_set(ImageWindow *imd, FileData *fd);
87
88 /* auto refresh, interval is 1/1000 sec, 0 uses default, -1 disables */
89 void image_auto_refresh(ImageWindow *imd, gint interval);
90
91 /* allow top window to be resized ? */
92 void image_top_window_set_sync(ImageWindow *imd, gint allow_sync);
93
94 /* background of image */
95 void image_background_set_color(ImageWindow *imd, GdkColor *color);
96
97 /* color profiles */
98 void image_color_profile_set(ImageWindow *imd,
99                              gint input_type, gint screen_type,
100                              gint use_embedded);
101 gint image_color_profile_get(ImageWindow *imd,
102                              gint *input_type, gint *screen_type,
103                              gint *use_image);
104 void image_color_profile_set_use(ImageWindow *imd, gint enable);
105 gint image_color_profile_get_use(ImageWindow *imd);
106
107 /* set delayed page flipping */
108 void image_set_delay_flip(ImageWindow *imd, gint delay);
109
110 /* wallpaper util */
111 void image_to_root_window(ImageWindow *imd, gint scaled);
112
113 /* overlays */
114 gint image_overlay_add(ImageWindow *imd, GdkPixbuf *pixbuf, gint x, gint y,
115                        gint relative, gint always);
116 void image_overlay_set(ImageWindow *imd, gint id, GdkPixbuf *pixbuf, gint x, gint y);
117 gint image_overlay_get(ImageWindow *imd, gint id, GdkPixbuf **pixbuf, gint *x, gint *y);
118 void image_overlay_remove(ImageWindow *imd, gint id);
119
120
121
122 void image_set_image_as_tiles(ImageWindow *imd, gint width, gint height,
123                               gint tile_width, gint tile_height, gint cache_size,
124                               ImageTileRequestFunc func_tile_request,
125                               ImageTileDisposeFunc func_tile_dispose,
126                               gpointer data,
127                               gdouble zoom);
128
129 /* reset default options */
130 void image_options_sync(void);
131
132
133 #endif
134
135
136